注册

如要将您的公司电话号码用于云端 API,必须先注册该号码。以下情况需要注册公司电话号码:

  • 帐户创建:实现此 API 时,您需要注册要用于发送消息的公司电话号码。我们会在创建帐户时实施两步验证设置,为您的帐户再添加一层安全保护。
  • 显示名更改:在这种情况下,您的电话号码已经过注册,而您想更改显示名。为此,您必须先在 WhatsApp 管理工具上申请更改显示名。名称获批后,您需要使用新显示名重新注册电话号码。
  • 将您的电话号码从 On-Premises API 迁移至云端 API。请参阅迁移例外情况

在注册公司电话号码之前,您必须先验证号码的所有权

迁移例外情况

如果您要将电话号码从本地 API 迁移到云端 API,则在通过云端 API 注册电话号码之前,需要采取额外步骤。如需获取完整流程,请参阅本地 API 和云端 API 之间的迁移

注册公司电话号码

如要注册已认证的公司电话号码,请向 PHONE_NUMBER_ID/register 发出 POST 调用,并在调用中加入下列参数。

端点身份验证

PHONE_NUMBER_ID/register

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

限制

在连续 72 小时的时间期限内,每个公司电话号码只能对注册端点提出 10 次请求。

在您提出注册请求时,我们将检查您在过去 72 小时内为注册该号码提出的注册请求次数。如果您已提出 10 次请求,API 会返回错误代码 133016,系统在接下来的 72 小时将禁止注册该号码。

参数

名称描述

messaging_product

必要。

所使用的消息服务。将其设为 "whatsapp"

pin

必要。

如果您为已认证公司电话号码启用了两步验证功能,请将此值设为该号码的 6 位两步验证 PIN 码。如果忘记了 PIN 码,可以更新该码


如果您尚未为已认证公司电话号码启用两步验证功能,则请将此值设为一串 6 位数字。这将是新认证公司电话号码的两步验证 PIN 码。

data_localization_region

可选。


加入此参数会启用公司电话号码上的本地存储。值必须是一个 2 个字母组成的 ISO 3166 国家/地区代码(如 IN),表示您希望将静态数据存储在哪个国家/地区。


支持的值:


亚太地区

  • 澳大利亚:AU
  • 印度尼西亚:ID
  • 印度:IN
  • 日本:JP
  • 新加坡:SG
  • 韩国:KR

欧洲地区

  • 欧盟(德国):DE
  • 瑞士:CH
  • 英国:GB

拉美地区

  • 巴西:BR

中东和非洲地区

  • 巴林:BH
  • 南非:ZA
  • 阿拉伯联合酋长国:AE

北美地区

  • 加拿大:CA

一经启用,便无法禁用或直接更改。您必须注销此号码,然后重新注册。重新注册时,可以不添加此参数(以禁用此功能),或者添加此参数并将值设为新国家/地区代码(以更改此功能)。


如要在已注册的号码上启用本地存储,您必须注销此号码,然后重新注册(须添加此参数)。

禁用本地存储的请求示例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834"
}

启用本地存储的请求示例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834",
  "data_localization_region": "CH"
}

All API calls require authentication with access tokens.

Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup.

Solution Partners must authenticate themselves with an access token with the whatsapp_business_messaging and whatsapp_business_management permissions. See System User Access Tokens for information.

注销公司电话号码

注销某个公司电话号码后,该号码将无法再用于云端 API,并且系统会禁用此号码上的本地存储(如已启用)。

注销号码不会删除相应号码及其消息记录。如要删除某个号码及其消息记录,请参阅删除 WABA 中的电话号码

如要注销某个公司电话号码,请向 PHONE_NUMBER_ID/deregister 发出 POST 调用:

端点身份验证

PHONE_NUMBER_ID/deregister

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

限制

在连续 72 小时的时间期限内,每个公司电话号码只能对注销端点提出 10 次请求。

在您提出注销请求时,我们将检查您在过去 72 小时内为注销该号码提出的注销请求次数。如果您已提出 10 次请求,API 会返回错误代码 133016,系统在接下来的 72 小时将禁止注销该号码。

示例

请求示例:

curl -X POST \  
 'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/deregister' \  
 -H 'Authorization: Bearer ACCESS_TOKEN'

成功的响应结果如下:

{
  "success": true
}