如何使用 API 和亚马逊云科技最终用户消息注册发件人 ID

导言

欢迎阅读我们的综合指南，介绍如何使用亚马逊云科技最终用户消息 V2 API 在需要注册的国家/地区获取发件人 ID。对于希望通过短信与客户建立可信通信渠道的企业而言，发件人 ID 注册是至关重要的一步。在约旦、菲律宾、卡塔尔等国家，必须注册发件人 ID，以确保遵守当地法规并提高消息传送能力。您可以在此处查看支持发件人 ID 并需要注册的国家/地区列表。

注意：这篇文章专门针对发件人 ID，要详细了解如何为您的用例选择正确的发件人，请阅读这篇关于如何使用亚马逊云科技最终用户消息在全球范围内发送 SMS 的文章。

本指南将引导您完成使用亚马逊云科技最终用户消息 V2 API 创建和提交发件人 ID 注册的高级流程。虽然我们将在本文中使用约旦作为案例研究，但此处概述的原则和步骤适用于对发件人 ID 有类似注册要求的其他国家。

对注册 API 的高级理解

要成功注册发件人 ID，您需要与多个亚马逊云科技最终用户消息 API 进行交互。以下是所涉及的关键 API 及其在注册过程中的作用的简要概述：

1. 描述注册类型定义

• 用途：检索指定的注册类型定义。
• 用例：查看创建、填写和提交每种注册类型的要求。
• 要点：每个国家/地区都有特定的"注册类型"，需要在下一步中使用该类型来创建注册。
• 文档：描述注册类型定义

2. 创建注册

• 目的：创建新的注册"容器"。这是一个空注册表，我们将在后续步骤中填写数据。
• 关键字段：注册类型
  • 控制注册类型（例如，免费电话、10DLC、JO_SENDER_ID_REGISTRIGENT 等）。
• 文档：创建注册

3. 描述注册字段定义

• 用途：检索指定的 RegistrationType 字段定义。
• 用例：查看创建、填写和提交每种注册类型的要求。根据注册所需的数据类型以及需要回答的实际问题，有不同的字段类型（选择、文本、附件）。
• 文档：描述注册字段定义

4. 创建注册附件

• 目的：上传某些国家/地区要求的其他文档。并非所有国家/地区都需要上传文件，因此这可能是一个可选步骤，具体取决于您注册的国家/地区。在本示例中，我们将注册约旦，这确实需要我们上传文件才能完成注册。
• 关键字段：注册附件 ID
  • 在要求您提供附件时，在下一步操作中用于在注册中包含附件。并非所有注册类型都需要附件。
• 文件规格：
  • 最大文件大小：500 KB
  • 有效的文件扩展名：PDF、JPEG 或 PNG
• 文档：创建注册附件

5. 输入注册字段值

• 用途：为特定注册字段设置值。
  • 需要对所有必填字段重复此操作。
• 文档：设置注册字段值

6. 提交注册版本

• 目的：提交指定的注册版本以供审核和批准。您可以使用 createRegistrationVersion 创建新版本的注册，因此，如果您创建了另一个注册版本，请确保使用正确的 ID。
• 重要注意事项：
  • 如果您创建了多个版本，请确保使用正确的版本
  • 在提交之前，请确保所有数据正确无误。
  • 初始状态将为"已创建"，应在 24 小时内更改为"正在审核"。
  • 在注册获得批准或拒绝之前，您无法编辑或删除该注册。
• 文档：提交注册版本

在约旦注册发件人 ID 的详细步骤

在以下各节中，我们将更深入地介绍每个步骤，提供有关 API 调用和响应的更多详细信息以及确保注册过程顺利进行的优秀实践。无论您是在约旦还是其他有类似要求的国家注册，本指南都将为您提供成功注册发件人 ID 所需的知识。

第 1 步：描述注册类型定义

第一步是运行 describeRegistrationTypeDefinitions 来检索所有指定的注册类型定义。此 API 提供了详细的响应，其中包括与注册过程相关的各种属性。让我们分解一下约旦的这些属性：

• 国家：JO
  • 描述：指定描述注册类型定义的国家/地区代码。JO 代表约旦。
  • 含义：了解国家/地区代码至关重要，因为每个国家/地区的注册要求和流程可能有很大差异。
• 资源类型：SENDER_ID
  • 描述：指明要为其定义注册的资源类型。
  • 含义：知道资源类型为 SENDER_ID 可以帮助您了解注册过程的重点是获得发件人 ID 的专门批准，因为有些国家/地区有多种注册类型。
• 注册类型：JO_SENDER_ID_REGISTRIGATION
  • 描述：指定给定国家和资源类型所需的确切注册类型。
  • 含义：这种注册类型至关重要，因为它规定了在约旦成功注册发件人 ID 所需的具体步骤、文件和标准。
  • 您将使用此值来创建初始注册
• 关联行为：ASSOCIATE_ON_APPROVAL
  • 描述：描述注册获得批准后，注册的发件人 ID 将如何与您的亚马逊云科技账户关联。
  • 含义：ASSOCIATE_ON_APPROVIL 意味着注册获得批准后，发件人 ID 将自动与您的账户关联，从而简化了批准后的流程。成功提交注册并获得批准后，您将无事可做。某些注册类型需要在注册获得批准后采取步骤，但这不是其中之一。
• 取消关联行为：DISASSOCIATE_ALL_CLOSES_REGISTRIATION
  • 描述：解释当您取消发件人 ID 与账户的关联时会发生什么。
  • 含义：这种行为值得注意，因为这意味着在关闭注册之前，必须先取消原始身份与注册的关联。

第 2 步：创建注册

接下来，使用带有约旦注册类型的 createRegistration，即"JO_SENDER_ID_REGISTRIGENT"，为约旦发件人 ID 生成一个空白的注册"容器"。请务必记录"registrationID"以备将来使用，因为它将在整个过程的其余部分中使用。

以下是在控制台中创建的注册的屏幕截图

第 3 步：描述注册字段定义

使用以"JO_SENDER_ID_REGISTRATION"作为注册类型的 describeRegistrationFieldefinitions 来提取提交注册所需填写的所有字段。

重要字段属性

• 字段路径
  • 值：一个字符串，它指定注册表中字段的路径（例如，CompanyInfo.CompanyName）。
  • 描述：fieldPath 属性提供注册表中特定字段的分层路径。它确定了我们稍后将用于在注册中输入数据的字段之一
  • 含义：确保将所需信息放在正确的字段中，这对于准确处理至关重要。
• 字段要求
  • 值：指明该字段是必填字段、可选字段还是条件字段（必填、可选、有条件的）。
  • 描述：fieldRequirement 属性指定了该字段在注册过程中的必要性。必须填写必填字段才能提交注册，如果不适用，可选字段可以留空。条件字段依赖于其他字段，根据某些条件可能会成为必填字段。
  • 含义：帮助确定要填写的字段的优先顺序，并确保不遗漏关键信息。
• 字段类型
  • 值：描述字段中预期的数据类型（选择、文本、附件）。
  • 描述：指明应在字段中输入的数据的格式和类型。
  • 含义：确保注册表的有效性，并降低因数据格式不正确而出现错误或被拒绝的风险。

在下面的屏幕截图中查看约旦注册的类别

让我们以更易读的格式分解所有发件人 ID 注册中常见的必填字段及其描述：

发件人 ID 信息：

1. 发件人 ID（必填）
   1. 必须是 3-11 个字母数字字符
   2. 必须包含至少一个字母
   3. 示例："示例"
2. 发件人 ID 描述（可选）
   1. 解释公司名称和发件人 ID 之间的关系
   2. 最多 500 个字符
3. 发件人 ID 连接证明（可选）
   1. 仅在公司名称和发件人 ID 之间的关联不明显时才需要
   2. 必须提供知识产权的证据

以下是主机版的屏幕截图

公司信息：

1. 公司名称（必填）
   1. 合法的公司名称
   2. 最多 100 个字符
   3. 示例："示例公司"
2. 公司 ID（必填）
   1. 法定识别码（EIN/VAT）
   2. 仅限字母数字
   3. 最多 30 个字符
3. DBA 名称（可选）
   1. 如果与法定名称不同，则为"经商身份"
   2. 最多 100 个字符
4. 网站（必填）
   1. 公司的完整网址
   2. 示例："https://www.example.com"
5. 业务领域（必填）
   1. 选择一项：农业、通信、建筑、教育、能源、娱乐、金融、政府、医疗保健、酒店、保险、制造业、房地产、零售、科技等

以下是主机版的屏幕截图

公司地址：

1. 地址行 1（必填）
2. 地址行 2（可选）
3. 城市（必填）
4. 州/省（可选）
5. 邮政编码（可选）
6. 国家代码（必填）
   1. 由两个字母组成的 ISO 代码
   2. 示例："美国"

以下是主机版的屏幕截图

联系信息：

1. 电子邮件地址（必填）
   1. 有效的电子邮件格式
   2. 示例："janedoe@example.com"
2. 电话号码（必填）
   1. 必须包含至少 3 位数字
   2. 示例："+12065550100"

以下是主机版的屏幕截图

消息用例：

1. 用例类别（必填）
   1. 选择一项：一次性密码、账户/安全警报、购买/交付通知、公共服务公告、投票/调查、按需信息、其他
2. 用例描述（必填）
   1. 最多 500 个字符
3. 每月留言量（必填）
   1. 选择一个：10、100、1,000、10,000、100,000、1,000,000、10,000,000+
4. 选择加入说明（必填）
   1. 用户将如何选择接收消息
   2. 最多 500 个字符

以下是主机版的屏幕截图

消息示例：

1. 消息示例 1（必填）
   1. 最多 306 个字符
2. 消息示例 2（可选）
   1. 最多 306 个字符
3. 消息示例 3（可选）
   1. 最多 306 个字符

以下是主机版的屏幕截图

约旦的特定要求

一些国家（并非全部）也有特定国家/地区的要求。约旦需要以下条件才能进行注册：

1. 公司注册文件（必填）
   1. 必须提供公司注册文件（本地和国际公司）
   2. 这是一种附件类型，因此我们需要先使用"createRegistrationAttachment"来将该值放入注册中。我们将在此过程中进一步介绍这个问题
2. 交易确认（必填）
   1. 必须确认只会发送交易消息
   2. 不允许发布促销内容
   3. 这是一个"选择"字段类型，唯一的选项是"是"，这意味着除非您同意此确认信息，否则您将无法注册

以下是主机版的屏幕截图

第 4 步：创建注册附件

现在您已经知道了注册约旦发件人 ID 所需的所有字段，您需要收集所有必要的数据，包括所需的附件。注册约旦发件人 ID 只需要一个附件。让我们来看看如何将此附件添加到您的注册中。

要为您的注册添加附件，请使用 CreateRegistrationAttachment API。您可以通过两种方式提供此文档：

1. 在 S3 中指定文件：
   1. 确保使用标准存储桶，不支持 S3 Express。
2. 将其作为 Base64 编码的二进制数据对象上传：
   1. 此方法允许您直接上传文档，无需先将其存储在 S3 中。

重要：成功运行"创建注册附件"命令后，您将收到"注册附件 ID"。请务必记录此 ID，因为您需要使用它来将上传的内容附加到您的注册中。

第 5 步：输入注册字段值

使用 putRegistrationFieldValue 将数据输入到每个字段。循环遍历每个输入，因为每次调用仅输入一个值。指定每次通话时先前记录的"注册 ID"。字段值的选项有：

• registrationAttachmentID：注册附件的唯一标识符
• selectChoices：先前在有效负载中指定的表单字段值数组
• TextValue：自由表单字段的文本数据

第 6 步：查看您的注册

成功输入所有注册值后，您可以通过以下两种方式之一查看您的输入：

1. 在控制台中查看：
   1. 您可以直接在亚马逊云科技管理控制台中访问您的注册详细信息。
2. 使用描述注册字段值：
   1. 你可以使用 describeRegistrationFieldValues API 提取注册信息并查看其每个值。确保使用正确的注册版本 ID。

第 7 步：提交您的注册

注册中的所有值完整无误后，使用 SubmitRegistrationVersion API 提交您的注册以供审核。拨打此电话时提供您的"注册 ID"。

初始状态：

• 您注册的初始状态将为"已创建"。
• 它应该在 24 小时内更改为"审查"。
• 如果状态在 24 小时内未从"已创建"更改为"正在审核"，并且您已确认已提交注册版本，请创建支持案例以寻求帮助。

发件人 ID 注册审查流程

每个国家都有自己的审查程序和时间表。每个国家的注册商以先入先出的方式对每项注册进行审查。亚马逊云科技不会审查您的注册，因此请确保您在完成注册时牢记这一点。有些人在审查这些注册时并不了解您的公司或您的用例，因此请务必在回复中清晰简洁。

如果注册商对您提交的内容感到困惑，他们可能会拒绝，您需要重新开始流程，必要时修改注册信息并重新提交。这会让你再次处于后面，这将延长你的时间表。

结论

使用最终用户消息 V2 API 完成发件人 ID 注册涉及多个步骤，每个步骤对于确保合规性和成功注册至关重要。通过遵循本指南，您可以高效地完成整个流程，从了解必填字段到提交注册以供审核。无论您是在约旦还是其他有不同要求的国家/地区注册，本指南都提供了成功获取发件人 ID 并通过短信与客户建立可信通信渠道所需的知识和步骤。

泰勒霍姆斯

帕特里克·维克