Облачный API

Платформа WhatsApp Business > Облачный API WhatsApp > Справка

Регистрация

Чтобы использовать номер телефона компании с облачным API, сначала необходимо зарегистрировать его. Регистрировать номер телефона компании необходимо в следующих случаях:

  • Создание аккаунта. Когда вы реализуете этот API, необходимо зарегистрировать номер телефона компании, который будет использоваться для отправки сообщений. Мы принудительно устанавливаем двухшаговую проверку при создании аккаунта, чтобы обеспечить дополнительную защиту аккаунтов.
  • Изменение имени. Если ваш номер телефона уже зарегистрирован, и вы хотите изменить отображаемое имя, необходимо сначала запросить смену имени в WhatsApp Manager. После того как имя будет утверждено, необходимо вновь зарегистрировать номер телефона под новым именем.
  • Перенос номера телефона с локального API в облачный. См. раздел Исключения при переносе.

Прежде чем зарегистрировать номер телефона компании, нужно подтвердить право собственности на него.

Исключения при переносе

Если вы переводите номер телефона из локального API в облачный, вам потребуется выполнить дополнительные шаги перед его регистрацией. Полный процесс см. в статье Перевод из локального API в облачный.

Регистрация номера телефона компании

Чтобы зарегистрировать подтвержденный номер телефона компании, выполните запрос POST к конечной точке PHONE_NUMBER_ID/register. Укажите следующие параметры.

Конечная точкаАутентификация

PHONE_NUMBER_ID/register

(См. раздел Получение ID номера телефона)

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

Ограничения

Действует ограничение в 10 запросов к конечной точке регистрации для одного номера телефона компании в течение 72-часового скользящего окна.

Когда вы сделаете запрос регистрации, мы проверим, сколько запросов на регистрацию этого номера вы сделали за последние 72 часа. Если уже имеется 10 запросов, API вернет ошибку с кодом 133016 и номер не будет регистрироваться в течение следующих 72 часов.

Параметры

ИмяОписание

messaging_product

Обязательный параметр.

Используемая служба обмена сообщениями. Установите значение "whatsapp".

pin

Обязательный параметр.

Если для вашего подтвержденного номера телефона компании уже включена двухшаговая проверка, укажите в этом параметре 6-значный PIN, используемый при проверке. Если вы забыли свой PIN, его можно обновить.


Если же для номера телефона не настроена двухшаговая проверка, укажите в этом параметре число из 6 цифр. Этот PIN-код будет использоваться при двухшаговой проверке нового подтвержденного номера телефона компании.

data_localization_region

Необязательный параметр.


Включает локальное хранилище для номера телефона компании. Значением должен быть 2-буквенный код страны по стандарту ISO 3166 (например, IN), задающий страну, в которой должны храниться неактивные данные.


Поддерживаемые значения:


Азиатско-Тихоокеанский регион (APAC)

  • Австралия: AU
  • Индонезия: ID
  • Индия: IN
  • Япония: JP
  • Сингапур: SG
  • Южная Корея: KR

Европа

  • ЕС (Германия): DE
  • Швейцария: CH
  • Великобритания: GB

Латинская Америка

  • Бразилия: BR

Ближний Восток и Африка

  • Бахрейн: BH
  • Южная Африка: ZA
  • Объединенные Арабские Эмираты: AE

Северная Америка

  • Канада: CA

После включения этот параметр нельзя отключить или изменить явным образом. Вместо этого необходимо отменить регистрацию номера и вновь зарегистрировать его без указания этого параметра (чтобы отключить) или с указанием в этом параметре нового кода страны (чтобы изменить).


Чтобы включить локальное хранилище для уже зарегистрированного номера, необходимо отменить регистрацию этого номера, а затем вновь зарегистрировать его с указанием этого параметра.

Пример забора без локального хранилища

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

Пример забора с локальным хранилищем

curl 'https://graph.facebook.com/v19.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, и отключит для этого номера локальное хранилище (если оно было включено).

При отмене регистрации номер и его история сообщений не удаляются. Информацию о том, как удалить номер и его историю, см. в разделе Удаление номера телефона из аккаунта WhatsApp Business.

Чтобы отменить регистрацию номера телефона компании, выполните запрос POST к конечной точке PHONE_NUMBER_ID/deregister.

Конечная точкаАутентификация

PHONE_NUMBER_ID/deregister

(См. раздел Получение ID номера телефона)

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

Ограничения

Действует ограничение в 10 запросов к конечной точке отмены регистрации для одного номера телефона компании в течение 72-часового скользящего окна.

Когда вы сделаете запрос на отмену регистрации, мы проверим, сколько запросов на отмену регистрацию этого номера вы сделали за последние 72 часа. Если уже имеется 10 запросов, API вернет ошибку с кодом 133016 и регистрация номера не будет отменяться в течение следующих 72 часов.

Пример

Пример запроса:

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

Успешный ответ выглядит следующим образом:

{
  "success": true
}

Статьи по теме