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

WhatsApp Business Platform > On-Premises API

Начало работы

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

Начало работы с этим API предполагает три основных шага:

Подготовка объектов. Сначала нужно настроить объекты, необходимые для интеграции API, в том числе бизнес-аккаунт WhatsApp.
Установка клиента облачного API. Затем установите клиент API. После этого можно обновить настройки приложения.
Начало работы с клиентом. Зарегистрируйте свой номер телефона, выполнив вызов API к конечной точке /account, и отправьте тестовое сообщение, выполнив вызов к конечной точке /messages.

Перед началом работы

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

аккаунт Facebook Business Manager;
подтвержденная компания;
бизнес-аккаунт WhatsApp;
кредитная линия для бизнес-аккаунта WhatsApp (процесс биллинга подробно описан в этом разделе);
инструмент командной строки (например, "Терминал") или приложение, которое может выполнять запросы cURL (например, Postman).

После подтверждения компании мы проверим, отвечает ли она требованиям пользовательского соглашения WhatsApp и торговой политики WhatsApp. Переход на этот этап происходит автоматически. Узнать статус подтверждения компании можно на вкладке Настройки бизнес-аккаунта WhatsApp в Business Manager. После его прохождения в поле Проверка компании появится значение Пройдена, а в поле Статус аккаунта — Одобрен.

Настройка аккаунта WhatsApp

Добавьте в бизнес-аккаунт WhatsApp номер телефона и связанное с ним отображаемое имя. После этого отображаемое имя будет отправлено на проверку.

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

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

Проверка информации о биллинге и расценках

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

Программное обеспечение	Версия	Сведения
Локальный API	См. журнал изменений	См. журнал изменений
Локальный API для AWS	См. журнал изменений Версия шаблона: `v3.0.1`	См. журнал изменений
MySQL	`5.7.xx` и `8.0.xx`	Обратите внимание: если база данных перенесена в MySQL 8, использование более ранней версии MySQL 5 невозможно. Следовательно, перед переносом базы данных необходимо сделать ее резервную копию.
PostgreSQL	`13.8`	Поддерживаются версии `13.x`, `12.x` и `11.x`.
Docker	Версия `18.04` и более поздние, за исключением `19.03.7`.	Начиная с `v2.33` требуется версия `18.04`. Убедитесь, что системный вызов statx находится в списке разрешенных системных вызовов для Docker.
Postman	Любая недавняя версия
libseccomp	`2.3.3`	Поддерживается только версия `2.3.3`.
glibc	`2.28`	Поддерживается только версия `2.28` и более поздние.
Операционная система	Последняя версия	Необходима версия ядра `4.11` и более поздние.

Шаг 1. Установка клиента локального API

Среда

Клиент локального API работает на платформе Docker. Информацию обо всех компонентах см. в статье, посвященной архитектуре клиента.

В настоящее время клиент локального API не работает в Docker для Windows и подсистемы Windows для Linux. В целях разработки рекомендуется запускать Docker на виртуальной машине Linux. В рабочей среде во избежание проблем с совместимостью и производительностью рекомендуем использовать сервер Linux.

Оборудование

Клиент локального API будет работать на любом устройстве, если оно подключено к Интернету и на нем может выполняться Docker для Linux. Это может быть как виртуальная машина, так и сервер Linux. Подробнее см. в разделе Часто задаваемые вопросы. Например, простое тестирование можно выполнить на обычном ноутбуке. Минимальные требования к серверу рабочей среды: твердотельный накопитель емкостью 250 ГБ, 16 ГБ ОЗУ, четырехъядерный ЦП. Использовать обычные жесткие диски не рекомендуется из-за низкой скорости ввода-вывода: при высокой нагрузке это будет мешать работе.

В общем случае база данных должна работать на отдельном физическом сервере (не на том, где размещены контейнеры Coreapp и Webapp). Допустимая задержка при передаче данных между этим сервером и компьютером — не более нескольких миллисекунд.

Установка

Развернуть локальный API можно двумя способами:

Локальное развертывание. Вы можете самостоятельно настроить контейнеры Docker (см. наше руководство по установке). Мы рекомендуем начать с одной из конфигураций для разработчиков, чтобы ознакомиться с процессом настройки и отправки сообщений. Сначала можно развернуть локальное решение на компьютере, а затем перенести его в рабочую среду.
Amazon Web Services (AWS). Если вы уже используете эту платформу или хотите иметь полностью независимое решение, следуйте инструкциям из нашего руководства по AWS. В этом случае вы получите полнофункциональное решение локального API с инструментами резервного копирования и восстановления, а также другими возможностями, доступными в вашем облаке AWS.

Чтобы выполнить настройку после запуска клиента локального API, войдите в систему как admin.

Обновление настроек

После запуска клиента локального API можно изменить настройки приложения. Доступ к настройкам профиля клиента локального API открывается только после завершения регистрации.

Настройки приложения управляют работой клиента. Они относятся к обратным вызовам, Webhooks, средству извещения по вызову, статусу отправки, поведению при скачивании медиафайлов и т. п. Примечание. Настоятельно рекомендуется настроить URL Webhooks для получения уведомлений о входящих сообщениях или ошибках.
Настройки бизнес-профиля и настройки профиля содержат информацию о компании: физический адрес, электронный адрес, сайт, сферу деятельности, общую информацию о компании и фото профиля.

Шаг 2. Начало работы с клиентом

Регистрация

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

Отправка тестового сообщения

Тестовые сообщения можно отправлять с помощью конечной точки messages. Сначала проверьте статус номера телефона, который используется для тестирования. Отправьте своему аккаунту WhatsApp сообщение с тестового номера телефона. После этого начнется 24-часовой период обслуживания клиента, в течение которого можно будет отправить любое сообщение (сведения об ограничении доставки сообщений см. в этом разделе). Затем отправьте текстовое сообщение на тестовый номер телефона. Если сообщение будет получено, это означает, что клиент настроен правильно. Если сообщение не будет получено, проверьте уведомления Webhooks, в которых может содержаться информация об ошибках.

Безопасность

Информацию о паролях, аутентификации, конфигурации SSL, разделении сетей, зашифрованной связи, заголовках HTTP и протоколе веб-серверов TLS в контексте клиента локального API см. в нашем руководстве по безопасности.

Процесс запуска

После подключения к серверу локальный API WhatsApp проходит процедуру запуска. Это позволит обеспечить наличие эффективных и надежных инструментов для отправки и получения сообщений. Во время этой фазы запуска основное приложение (Coreapp) ожидает выполнения нескольких предварительных условий, в том числе:

загрузки сообщений с шаблонами (в процессе инициализации API загружает сообщения с шаблонами с сервера);
получения и обработки офлайн-сообщений (он также получает и обрабатывает офлайн-сообщения).

Если попытка отправить сообщение будет предпринята, когда предварительные условия ещё не выполнены, Coreapp выдаст сообщение об ошибке "Coreapp not ready" (Coreapp не готово), а в журналах появится ошибка "Service not ready" (Служба не готова). Важно отметить, что этот процесс запуска выполняется при каждом новом подключении к серверу WhatsApp. Следовательно, чтобы основное приложение перешло в состояние готовности в случае его перезапуска или отключения, процесс запуска будет выполнен повторно. Это обеспечивает надежность и готовность локального API WhatsApp для обмена сообщениями.

Обработка офлайн-сообщений

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

В обычных условиях локальный API WhatsApp соблюдает стандартный протокол для обработки офлайн-сообщений. Он ожидает получения и обработки всех офлайн-сообщений в течение заранее определенного максимального периода времени, составляющего 6 минут. Через 6 минут фаза обработки офлайн-сообщений считается выполненной.

Дополнительные рекомендации

ЧТО СЛЕДУЕТ ДЕЛАТЬ

Начните с обмена сообщениями с собственными сотрудниками, чтобы убедиться в том, что система работает.

Отвечайте всем клиентам в течение 24 часов.

Соблюдайте наши правила, изложенные в Политике WhatsApp Business и Торговой политике WhatsApp.

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

Прежде чем обращаться в прямую поддержку, ознакомьтесь с часто задаваемыми вопросами.

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

При подаче заявки в службу поддержки прилагайте информацию, которая поможет воспроизвести ошибку. Например, прилагайте журналы, информацию о поддержке с узлов health и support, данные WADebug, вызовы API и т. п.

ЧЕГО НЕ СЛЕДУЕТ ДЕЛАТЬ

Отправлять одинаковые уведомления по нескольким каналам.

Отправлять спам.

Использовать для тестирования бесплатные номера (номера на 800).

Создавать новый аккаунт специально для интеграции WhatsApp. Если у вас уже есть аккаунт Business Manager, используйте его.

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

Дополнительная информация

Платформа WhatsApp Business | Облачный API | Локальный API | API Business Management