账户

/v1/account

我们将弃用 On-Premises API。此端点无法再用于注册公司电话号码,且现在将返回以下错误:

{
  "code": 1005,
  "title": "Access denied",
  "details": "Unknown error: biz_link_on_prem_reg_blocked"
}

account 节点用于注册 WhatsApp Business API 客户端。

请注意,如果集群上已注册一个号码,再注册新号码时,核心应用将重启。

连线

以下连线会连接至此节点:

连线描述

/verify

在您通过指定方式收到注册码后,请使用此连线完成您的帐户注册。

前期准备

您需要提供:

复制以 Base64 方式编码的证书

在 WhatsApp Business API 客户端注册期间,系统会为您生成以 Base64 方式编码的证书字符串,以供验证时使用。

  1. 前往 Meta 商务管理平台中的业务设置
  2. 如果您的 WhatsApp 帐号尚未高亮显示,请点击帐号菜单下的 WhatsApp 帐号,然后从 WhatsApp 帐号列表中选择该帐号。
  3. 前往设置选项卡,然后点击 WhatsApp 管理工具按钮。
  4. 电话号码选项卡下应当会列出您的电话号码。在您想为其获取证书的电话号码所在栏中点击查看按钮。
    获取证书
  5. 弹出对话框的灰色框中会显示证书字符串。点击获取证书
    下载证书字符串
  6. 使用 account 端点进行注册时,在 cert 参数中使用此证书字符串。

如需更多信息,请参阅显示名文档。

限制

  • 您必须使用 admin 帐号来注册应用程序。
  • 如果您正在重新注册帐号,则需在完成注册后重启核心应用。

请求

向此终端发起 POST 通话,以请求注册代码。在调用过程中,添加您的手机号码和以 Base64 方式编码的证书字符串。您可以通过短信或语音通话来接收代码。

示例

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

根据收到的响应,我们可以认为注册程序已完成,或需要其他步骤来完成。如果注册成功,您会收到下列 HTTP 状态代码中的一个。请根据您收到的响应执行相应操作:

  • 201 Created — 该帐户已经存在。您已经注册过应用,因此无需进行其他操作。
  • 202 Accepted — 该帐户不存在。请根据您在请求中选择的方式,检查用于接收注册代码的短信或语音通话号码。此响应将包括一个返回的负载,其中包含从 cert 参数解码的 vname,供您确认要设置的显示名称正确无误。如果正确,请继续在完成您的帐户注册部分来完成注册。
{
  "account": [{
      "vname": "decoded-vname-from-cert"
  }]
}

如果返回任何错误,请参阅错误和状态消息,以获取更多信息。

参数

名称描述

cc

必要。

您所要注册电话号码的国家/地区数字代码

phone_number

必要。

您所要注册的电话号码,请勿带有国家/地区代码或加号 (+)。

method

必要。

注册代码的接收方式
选项:voicesms

cert

必要。

以 Base64 方式编码的证书。

pin

非必要。

现有的 6 位 PIN 码,仅在此帐号启用双重验证时为必需项。

更改两步验证 PIN 码

如要更改您商家电话号码的两步验证 PIN 码,请按照下列步骤操作:

  1. WhatsApp 管理工具中加载您的业务资产组合。
  2. 如果此工具无法自动加载电话号码窗口,请前往账户工具(工具箱图标)>电话号码
  3. 点击电话号码的设置图标(齿轮)。
  4. 点击两步验证
  5. 点击更改 PIN 码并完成相应流程。

您必须提供您当前的 PIN 码才能进行更改。请注意,您还可以使用我们的 API 设置新的 PIN 码:

禁用两步验证功能

如要禁用两步验证功能,请按照更改 PIN 码的步骤进行操作,但最后一步改为点击关闭两步验证。届时,系统将向与您业务资产组合关联的邮箱发送一封包含链接的邮件。请使用此链接禁用两步验证功能。禁用后,您可以通过设置新 PIN 码重新启用此功能。

常见问题

可以,我们可以在您准备就绪,能够开始直播时设置新手机号或更改已验证名称。

只要免费号码包含您所在地点的国家/地区代码就可以。这是因为同一个号码可能会适用于两个不同的国家,如果免费号码不含国家/地区代码,我们便无法确定其适用于哪个国家/地区。

另外,请注意,如果使用免费号码,情况会有些复杂。通常情况下,如果您在国家/地区内拨打带有国家/地区代码的免费号码,通话将无法接通。也就是说,如果您所在国家/地区的客户拨打公司联系方式中显示的电话号码(带有国家/地区代码),则将无法与您取得联系。如果这是问题,则您需要明确告知客户。

点击此处,详细了解免费号码。

如果您备份当前设置,并在新设备上将其还原,则注册信息应和其余实现一起迁移到新设备中。详情请参阅“备份和恢复设置”文档

您可以在 Facebook 商务管理平台的“WhatsApp 帐户”中注册新手机号和删除旧手机号。

  1. 在“WhatsApp 帐户”中,前往设置
  2. 点击 WhatsApp 管理工具
  3. 选择手机号选项卡。您可以在此处管理该帐户的所有手机号。

如果您在使用“短信”注册时,因尝试次数过多而导致失败,并看到带有“拒绝访问”字样的消息,则请使用“语音通话”的方式来尝试注册

很遗憾,您需要使用可以接收短信或语音电话的不同电话号,以便我们向您发送注册码。过去我们允许用户使用手动注册码,但现在已不再支持此服务。我们会视需要继续向之前使用手动注册码的手机号提供支持。对于任何新电话号码,我们仅会通过短信或语音来电的形式向您发送注册码。

如果您想使用 1800 或免费号码,请阅读本指南