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 и доступные функции.
Строка идентификатора номера телефона · обязательный
Идентификатор вашего бизнес-телефона в WhatsApp. Этот идентификатор обозначает номер телефона
Этот номер можно получить из списка телефонных номеров вашего бизнес-аккаунта WhatsApp.
Необходимый
Тип содержимого: application/json
Схема: ConversationalAutomationRequest
Показать дочерние атрибуты
ConversationalAutomationRequest
enable_welcome_message boolean
Включать ли приветственные сообщения для новых бесед
подсказки массив строк
Список тем для начала разговора (способов разрядить обстановку), которые помогут направлять взаимодействие с клиентами
Показать дочерние атрибуты
подсказки[] строка
Текст-подсказка для индивидуального разговора
команд BotCommand
Список команд бота для автоматических ответов
Показать дочерние атрибуты
команды[] BotCommand
Настройка команд бота для автоматических ответов
Показать дочерние атрибуты
command_name string · required
Название команды бота (без косой черты в начале)
строка описания команды · обязательный
Описание того, что делает эта команда
Ответы
Настройте параметры автоматизации диалогов для номера телефона бизнес-аккаунта WhatsApp
включая приветственные сообщения, подсказки для начала разговора (способы разрядить обстановку) и команды для бота.
Варианты использования:
Настройте автоматические приветственные сообщения для новых клиентов
Настройте подсказки для диалога, чтобы направлять взаимодействие с клиентами
Определите команды бота для распространенных сценариев обслуживания клиентов
Обновите существующие настройки автоматизации
Включение или отключение определенных функций автоматизации
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Проверка:
Названия команд должны быть уникальными в пределах одного телефонного номера
Подсказки и описания команд должны соответствовать правилам WhatsApp Business
Для подсказок и команд установлены максимальные ограничения
200
Настройки автоматизации диалога успешно настроены
Тип содержимого: application/json
Схема: ConversationalAutomationResponse
Показать дочерние атрибуты
ConversationalAutomationResponse
успех логическое значение · обязательно
Указывает, была ли успешно выполнена настройка автоматизации
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
404
Номер телефона не найден — идентификатор номера телефона не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют