WhatsApp Business Bot - API с подробной информацией о боте | Документация для разработчиков

WhatsApp Business Bot - API с подробной информацией о боте

Экземпляр для программы магистратуры (LLM)

Просмотреть в формате Markdown

Версия

Этот конечный пункт позволяет разработчикам получать исчерпывающую информацию о своих продуктах

WhatsApp Business Bot, включая подсказки, команды и настройки приветственного сообщения.

Это необходимо для управления конфигурацией бота и понимания его текущего состояния.

Базовый URL

https://graph.facebook.com

Конечные точки

ПОЛУЧАТЬ

/{Version}/{WABA-Bot-ID}

GET /{Version}/{WABA-Bot-ID}

Получите исчерпывающую информацию о бизнес-боте WhatsApp, включая его подсказки

команды и настройка приветственного сообщения.

Варианты использования:

Получите конфигурацию бота и настройки автоматического ответа

Отслеживайте доступные команды бота и их описания

Проверьте статус включения приветственного сообщения

Перед внедрением автоматизации проверьте состояние бота

Настройка бота для аудита в целях обеспечения соответствия бизнес-требованиям

Ограничение скорости запросов:

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

Кэширование:

Информация о боте может кэшироваться в течение умеренного времени, но конфигурация может измениться

При обновлении настроек бота внедрите соответствующие стратегии аннулирования кэша.

Синтаксис запроса

GET / {Версия} / {WABA-Bot-ID}

Попробуйте!

Выберите язык

curl --request GET \ --url 'https://graph.facebook.com/{Version}/{WABA-Bot-ID}' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{}'

Выберите код состояния

{ "full_bot_config": { "summary": "Полная конфигурация бота со всеми функциями", "value": { "id": "1234567890123456", "prompts": [ "Добро пожаловать в нашу службу поддержки клиентов!", "Чем я могу вам помочь сегодня?", "Пожалуйста, выберите один из вариантов ниже" ], "commands": [ { "command_name": "help", "command_description": "Отображение доступных команд и справочной информации" }, { "command_name": "status", "command_description": "Проверьте статус вашего заказа" }, { "command_name": "support", "command_description": "Свяжитесь со службой поддержки клиентов" } ], "enable_welcome_message": true } }, "minimal_bot_config": { "summary": "Базовая конфигурация бота", "value": { "id": "2345678901234567", "prompts": [ "Здравствуйте! Я здесь, чтобы помочь" ], "commands": [], "enable_welcome_message": false } } }

Параметры заголовка

Строка User-Agent

Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.

Строка авторизации · обязательный

Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.

Параметры пути

Строка версии · обязательный

Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.

Строка WABA-Bot-ID · обязательна

Идентификатор вашего бизнес-бота WhatsApp. Этот идентификатор присваивается при создании бота

Его можно найти в вашем Business Manager или через API управления ботами.

Параметры запроса

поля строка

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

Будут возвращены поля по умолчанию (prompts, commands, enable_welcome_message).

Доступные поля: id, prompts, commands, enable_welcome_message

Ответы

Получите исчерпывающую информацию о бизнес-боте WhatsApp, включая его подсказки

команды и настройка приветственного сообщения.

Варианты использования:

Получите конфигурацию бота и настройки автоматического ответа

Отслеживайте доступные команды бота и их описания

Проверьте статус включения приветственного сообщения

Перед внедрением автоматизации проверьте состояние бота

Настройка бота для аудита в целях обеспечения соответствия бизнес-требованиям

Ограничение скорости запросов:

Кэширование:

Информация о боте может кэшироваться в течение умеренного времени, но конфигурация может измениться

При обновлении настроек бота внедрите соответствующие стратегии аннулирования кэша.

200

Получены данные о WhatsApp Business Bot

Тип содержимого: application/json

Схема: WhatsAppBusinessBot

Показать дочерние атрибуты

WhatsAppBusinessBot

строковый идентификатор · обязательный

Уникальный идентификатор для бизнес-бота WhatsApp

подсказки массив строк

Список подсказок бота и автоматических ответов

Показать дочерние атрибуты

подсказки[] строка

массив команд

Список доступных команд бота и их описания

Показать дочерние атрибуты

команды[] WhatsAppBusinessBotCommand

Настройка команд бота с указанием имени и описания

Показать дочерние атрибуты

command_name string · required

Название команды бота

строка описания команды · обязательный

Описание того, что делает эта команда

enable_welcome_message boolean

Включено ли приветственное сообщение для этого бота?

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

Удобное для пользователя сообщение об ошибке для отображения

Выберите язык

curl --request GET \ --url 'https://graph.facebook.com/{Version}/{WABA-Bot-ID}' \ --header 'Authorization: Bearer<Token> ' \ --header 'Content-Type: application/json' \ --data '{}'

Выберите код состояния

{ "full_bot_config": { "summary": "Полная конфигурация бота со всеми функциями", "value": { "id": "1234567890123456", "prompts": [ "Добро пожаловать в нашу службу поддержки клиентов!", "Чем я могу вам помочь сегодня?", "Пожалуйста, выберите один из вариантов ниже" ], "commands": [ { "command_name": "help", "command_description": "Отображение доступных команд и справочной информации" }, { "command_name": "status", "command_description": "Проверьте статус вашего заказа" }, { "command_name": "support", "command_description": "Свяжитесь со службой поддержки клиентов" } ], "enable_welcome_message": true } }, "minimal_bot_config": { "summary": "Базовая конфигурация бота", "value": { "id": "2345678901234567", "prompts": [ "Здравствуйте! Я здесь, чтобы помочь" ], "commands": [], "enable_welcome_message": false } } }

Аутентификация

Схема	Тип	Расположение
bearerAuth	HTTP Bearer	Заголовок: `Авторизация`

Примеры использования

bearerAuth:

Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:

bearerAuth