Локальный API платформы WhatsApp Business

Аккаунт

/v1/account

Узел account предназначен для регистрации клиента API WhatsApp Business.

Обратите внимание: если для кластера с уже зарегистрированным номером будет зарегистрирован новый номер, Coreapp перезапустится.

Границы контекста

С этим узлом связаны следующие границы контекста:

Граница контекстаОписание

/verify

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

Прежде чем начать

Вам понадобятся:

Скопируйте сертификат в кодировке Base64

Этот сертификат (строка в кодировке Base64) автоматически генерируется и используется при регистрации клиента API WhatsApp Business.

  1. В Meta Business Manager откройте раздел Настройки компании.
  2. В меню Аккаунты выберите пункт Аккаунты WhatsApp и найдите в списке свой аккаунт WhatsApp (если он ещё не выбран).
  3. Перейдите на вкладку Настройки и нажмите кнопку WhatsApp Manager.
  4. На вкладке Номера телефонов найдите нужный номер и нажмите кнопку Просмотреть рядом с ним.
    Получение сертификата
  5. Откроется диалог, в котором будет показан сертификат (строка в сером поле). Нажмите Получить сертификат.
    Скачивание строки сертификата
  6. При регистрации на конечной точке account укажите эту строку сертификата в параметре cert.

Дополнительные сведения см. в статье Отображаемые имена.

Ограничения

  • Для регистрации приложения необходимо использовать аккаунт admin.
  • Если вы регистрируете аккаунт повторно, по завершении регистрации необходимо перезапустить Coreapp.

Запросы

Чтобы запросить код регистрации, отправьте вызов POST к этой конечной точке. В вызове укажите номер телефона и строку сертификата в кодировке Base64. Получить код можно с помощью голосового вызова или в SMS.

Пример

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. Вы можете проверить, верно ли оно указано. Если все правильно, перейдите к этому разделу и завершите регистрацию.
{
  "account": [{
      "vname": "decoded-vname-from-cert"
  }]
}

Если возвращаются сообщения об ошибках, см. их описания и коды статусов.

Параметры

ИмяОписание

cc

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

Цифровой код страны для регистрируемого номера телефона.

phone_number

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

Регистрируемый номер телефона без кода страны и знака "плюс" (+).

method

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

Способ получения кода регистрации.
Возможные варианты:voice, sms.

cert

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

Сертификат в кодировке Base64.

pin

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

Существующий шестизначный PIN-код (требуется, только если в аккаунте используется двухшаговая проверка).

Изменение PIN-кода двухшаговой проверки

Чтобы изменить PIN-код двухшаговой проверки номера телефона вашей компании, выполните следующие действия:

  1. Загрузите свое бизнес-портфолио в WhatsApp Manager.
  2. Если панель Номера телефонов не открылась автоматически, выберите Инструменты аккаунта (значок с инструментами) > Номера телефонов.
  3. Нажмите значок настроек номера телефона (с изображением шестеренки).
  4. Нажмите Двухшаговая проверка.
  5. Нажмите Изменить PIN-код и завершите процесс.

Для этого потребуется ввести текущий PIN-код. Кроме того, задать новый PIN-код можно с помощью наших API:

Отключение двухшаговой проверки

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

Часто задаваемые вопросы

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

Постоянная ссылка

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

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

Подробнее о номерах с бесплатным вызовом.

Постоянная ссылка

Если вы создадите резервную копию текущей конфигурации и восстановите ее на новом компьютере, регистрационные данные должны быть перенесены вместе с остальными настройками. Дополнительные сведения см. в разделе Резервное копирование и восстановление настроек.

Постоянная ссылка

Регистрировать для аккаунта WhatsApp новые номера телефонов и удалять старые можно в Facebook Business Manager.

  1. В своем аккаунте WhatsApp откройте Настройки.
  2. Нажмите WhatsApp Manager.
  3. Откройте вкладку Номера телефонов. Здесь можно управлять всеми номерами телефонов для текущего аккаунта.
Постоянная ссылка

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

Постоянная ссылка

К сожалению, вам придется выбрать другой номер, на который можно принять SMS или голосовой вызов, чтобы мы могли отправить вам код регистрации. Ранее мы разрешали принимать коды регистрации вручную, но сейчас такая возможность не поддерживается. Поддержка номеров телефонов, для которых ранее использовались ручные коды регистрации, будет сохранена. Для новых номеров регистрационные коды отправляются только через SMS и посредством голосовых вызовов.

Если вы хотели бы использовать номер 1800 или бесплатный номер, ознакомьтесь с этим руководством.

Постоянная ссылка

Подробнее