Перенос номера телефона с облачного API на локальный

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

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

Примечание. Перенос номера телефона компании с одного API в другой и перенос номера из одного аккаунта WhatsApp Business в другой — это разные процессы.

Перенос НЕ влияет на следующее:

  • отображаемое имя, статус проверки и показатель качества номера телефона компании;
  • используемые этим номером телефона шаблоны и их статусы;
  • владение аккаунтом WhatsApp Business, его статус официального бизнес-аккаунта и ограничение на количество сообщений.

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

Рекомендации

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

Кроме того, мы рекомендуем выполнять перенос в часы с низким объемом трафика к локальному API.

Различия между API

До начала переноса убедитесь, что ваше приложение может обработать все эти различия.

Webhooks

Структуры полезных данных Webhooks облачного API и Business Management API отличаются от структур данных локального API. Рекомендуем создать новую конечную точку Webhooks, которая будет обрабатывать исключительно Webhooks локального API.

Информацию о различиях в полезной нагрузке см. в следующих документах:

После завершения переноса в локальный API Webhooks облачного API перестанут доставляться. Вместо этого начнут доставляться Webhooks локального API.

Медиафайлы

ID медиафайлов, загруженных в облачный API, нельзя использовать для отправки сообщений через локальный API, поэтому вам необходимо заново загрузить медиафайлы с использованием локального API, чтобы сгенерировать новые ID, или использовать URL медиафайлов, если они размещены на общедоступном сервере. См. статью Отправка сообщений с медиаданными.

Коды ошибок

Коды ошибок облачного API и Business Management API отличаются от кодов ошибок локального API. См. следующие документы:

Сообщения Push-To-Talk

Локальный API идентифицирует сообщения Push-To-Talk (PTT) в Webhooks, устанавливая для параметра messages.type значение voice, а облачный API — устанавливая для параметра messages.audio.voice значение true.

Время простоя

Время простоя начинается, как только вы выполните последний шаг регистрации (шаг 3). Оно составит несколько секунд. Сообщения, отправленные на номер телефона пользователями WhatsApp в это время, будут отклоняться без уведомления.

Мы настоятельно рекомендуем назначать перенос на время, когда активность на номере телефона минимальна, чтобы снизить вероятность негативных последствий.

Шаг 1. Интегрируйте локальный API

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

Шаг 2. Подготовьтесь к переносу

Рекомендуем не отправлять сообщения до завершения переноса.

Для правильного подключения к серверам WhatsApp клиент локального API WhatsApp Business предъявляет определенные требования к сети. Чтобы убедиться, что вы готовы к переносу, ознакомьтесь с руководством по настройке и отладки сети.

Шаг 3. Зарегистрируйте клиент API

Зарегистрируйте номер телефона компании в клиенте локального API. Для этого выполните вызов в конечной точке /account.

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: аккаунт ещё не существует. В зависимости от того, какой способ указан в запросе, вы получите код регистрации в голосовом сообщении или SMS. В ответе также содержится отображаемое имя vname, извлеченное из параметра cert. Вы можете проверить, верно ли оно указано. Если все правильно, перейдите к этому разделу и завершите регистрацию.

Все возможные поля этой конечной точки перечислены в этом разделе.

По окончании регистрации клиент локального API начнет получать сообщения.

Шаг 4. Настройка сегментов

После регистрации клиента вы также можете настроить сегменты, если это необходимо.

Шаг 5. Отправка сообщений

Теперь вы готовы к перепискам с клиентами. Если вам нужна помощь, ознакомьтесь с руководствами по отправке сообщений.