50% OFF with code BLACKFRIDAY5020% OFF with code BLACKFRIDAY20
Интеграции и APIGrowth / Pro и выше

API: список и отправка шаблонов WhatsApp

Два метода позволяют вашей программе использовать шаблоны WhatsApp. GET /api/v1/whatsapp/templates выдаёт список ваших одобренных шаблонов, а POST /api/v1/whatsapp/send-template отправляет один клиенту с вашего номера по умолчанию. Для обоих нужен ключ с доступом WhatsApp.

Где
Ask Menuthere support for a key
Тариф
Нужен подключённый номер WhatsApp Business, а он начинается с Starter / Pro.
Обновлено

Получите список шаблонов

curl 'https://menuthere.com/api/v1/whatsapp/templates' -H 'Authorization: Bearer ck_live_YOUR_KEY'

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

ПолеЗначение
name, languageНазвание шаблона и код языка.
category, statusКатегория, например MARKETING или UTILITY. Статус — APPROVED.
body_variablesСколько значений {{n}} нужно основному тексту.
has_header, header_formatЕсть ли заголовок и какой он: TEXT, IMAGE, VIDEO или DOCUMENT.

Отправьте шаблон

POST /api/v1/whatsapp/send-template с телом JSON. Сообщение уходит с вашего отправителя по умолчанию, который задаётся в разделе Несколько номеров и основной номер. Выбрать номер в вызове нельзя.

ПолеОбязательноЧто это
toДаНомер клиента с кодом страны.
template_nameДаНазвание из вызова со списком.
languageНетЕсли не указать, берётся из одобренного шаблона.
body_paramsНетМассив значений для {{1}}, {{2}} и так далее, по порядку.
header_paramsНетМассив значений для текстового заголовка.
header_media_url, header_media_typeНетСсылка и image, video или document для медиазаголовка.
button_paramsНетМассив значений для динамической кнопки со ссылкой.
idempotency_keyНетСсылка, которую вы выбираете сами. Работают также id и заголовок Idempotency-Key.

Успешная отправка возвращает ok: true, message_id, номер to и status: "sent". Если отправить тот же ключ идемпотентности снова, вы получите первый результат с duplicate: true, и ничего не уйдёт дважды. Неудачная отправка освобождает ключ, чтобы можно было повторить.

Ошибки и лимиты

Статус`error`Значение
400missing_fields, invalid_json, invalid_number, template_errorНе хватает обязательного поля, номер выглядит неверно, либо шаблон не подходит к отправленным значениям.
404template_not_foundНа вашем номере по умолчанию нет одобренного шаблона с таким названием.
409recipient_opted_outКлиент ответил STOP. Сообщение не отправляется.
409in_progressЗапрос с тем же ключом идемпотентности ещё выполняется.
412no_whatsapp_numberНомер WhatsApp по умолчанию не подключён.
429daily_limit_reached, rate_limitedСуточный лимит WhatsApp вашего номера исчерпан, либо ключ превысил свой лимит запросов.
502send_failedДо WhatsApp не удалось достучаться. Повторите попытку.
Что стоит знатьКаждая отправка через API — обычное сообщение WhatsApp, поэтому Meta берёт за неё плату, как и за любое другое. См. Сколько стоят сообщения WhatsApp. Шаблон должен быть одобрен, прежде чем его можно отправить. См. Шаблоны сообщений.

Вопросы

Можно ли отправить через API обычное текстовое сообщение?
Нет. API отправляет только одобренные шаблоны, которые доходят и до клиентов вне 24-часового окна.
Напишет ли он тому, кто отказался от сообщений?
Нет. Клиент, ответивший STOP, пропускается, а вызов возвращает recipient_opted_out.

Не нашли ответ? Напишите на help@mail.menuthere.com или в чат, с 9:00 до 21:00.Справочный центрЦеныmenuthere.com