WhatsApp Business Account - API для автоматизации диалогов | Документация для разработчиков
WhatsApp Business Account - API для автоматизации диалогов
Экземпляр для программы магистратуры (LLM)
Версия
API для управления настройками автоматизации диалогов для телефонных номеров бизнес-аккаунтов WhatsApp.
Этот конечный пункт позволяет компаниям настраивать функции автоматизированного диалога, включая:
приветственные сообщения, подсказки для начала разговора (способы разрядить обстановку) и команды для бота
Номера телефонов WhatsApp для бизнеса.
POST /{Version}/{Phone-Number-ID}/conversational_automation
Настройте параметры автоматизации диалогов для номера телефона бизнес-аккаунта WhatsApp
включая приветственные сообщения, подсказки для начала разговора (способы разрядить обстановку) и команды для бота.
Варианты использования:
Настройте автоматические приветственные сообщения для новых клиентов
Настройте подсказки для диалога, чтобы направлять взаимодействие с клиентами
Определите команды бота для распространенных сценариев обслуживания клиентов
Обновите существующие настройки автоматизации
Включение или отключение определенных функций автоматизации
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Проверка:
Названия команд должны быть уникальными в пределах одного телефонного номера
Подсказки и описания команд должны соответствовать правилам WhatsApp Business
Для подсказок и команд установлены максимальные ограничения
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Phone-Number-IDСтрока·обязательный
Идентификатор вашего бизнес-телефона в WhatsApp. Этот идентификатор обозначает номер телефона
Этот номер можно получить из списка телефонных номеров вашего бизнес-аккаунта WhatsApp.
Необходимый
Тип содержимого: application/json
Схема: ConversationalAutomationRequest
Показать дочерние атрибуты
ConversationalAutomationRequest
enable_welcome_messageboolean
Включать ли приветственные сообщения для новых бесед
подсказкимассив строк
Список тем для начала разговора (способов разрядить обстановку), которые помогут направлять взаимодействие с клиентами
Показать дочерние атрибуты
подсказки[]строка
Текст-подсказка для индивидуального разговора
командBotCommand
Список команд бота для автоматических ответов
Показать дочерние атрибуты
команды[]BotCommand
Настройка команд бота для автоматических ответов
Показать дочерние атрибуты
command_namestring·required
Название команды бота (без косой черты в начале)
описания командыстрока·обязательный
Описание того, что делает эта команда
Ответы
Настройте параметры автоматизации диалогов для номера телефона бизнес-аккаунта WhatsApp
включая приветственные сообщения, подсказки для начала разговора (способы разрядить обстановку) и команды для бота.
Варианты использования:
Настройте автоматические приветственные сообщения для новых клиентов
Настройте подсказки для диалога, чтобы направлять взаимодействие с клиентами
Определите команды бота для распространенных сценариев обслуживания клиентов
Обновите существующие настройки автоматизации
Включение или отключение определенных функций автоматизации
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Проверка:
Названия команд должны быть уникальными в пределах одного телефонного номера
Подсказки и описания команд должны соответствовать правилам WhatsApp Business
Для подсказок и команд установлены максимальные ограничения
200
Настройки автоматизации диалога успешно настроены
Тип содержимого: application/json
Схема: ConversationalAutomationResponse
Показать дочерние атрибуты
ConversationalAutomationResponse
успехлогическое значение·обязательно
Указывает, была ли успешно выполнена настройка автоматизации
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
404
Номер телефона не найден — идентификатор номера телефона не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют