API для бизнес-аккаунтов WhatsApp | Документация для разработчиков
API для бизнес-аккаунтов WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
API для управления бизнес-аккаунтами WhatsApp в рамках бизнес-портфеля.
Этот интерфейс позволяет компаниям получать и создавать бизнес-аккаунты WhatsApp (WABA)
для обмена сообщениями и деловой коммуникации. WABA могут быть связаны
с указанным портфелем бизнеса и настроенным с использованием предоставленных параметров.
GET /{Version}/{Business-ID}/whatsapp_business_accounts
Получите список бизнес-аккаунтов WhatsApp, принадлежащих указанному бизнес-портфелю.
Этот конечный пункт предоставляет информацию о принадлежащих вам бизнес-аккаунтах WhatsApp
от компании, включая их конфигурацию, статус и основные свойства
соответствует функциональности GraphBusinessWhatsAppBusinessAccountsEdge.
Варианты использования:
Получить список принадлежащих вам бизнес-аккаунтов WhatsApp
Отслеживание состояния и конфигурации WABA
Проверьте данные WABA для интеграции с бизнес-системами
Управление настройками корпоративной мессенджерной системы WhatsApp
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация WABA может кэшироваться в течение умеренного времени, но информация о состоянии может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка Business-ID · обязательный
Идентификатор вашего бизнес-портфеля. Этот идентификатор можно найти в Meta Business Suite
или через API для управления бизнес-процессами.
Параметры запроса
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, name, currency, timezone_id).
Доступные поля: id, name, account_review_status, purchase_order_number, currency, timezone_id, business_verification_status, country, on_behalf_of_business_info, is_enabled_for_insights, message_template_namespace
business_type — массив, содержащий один из элементов "ENTERPRISE", "SMB".
Фильтрация результатов по типу бизнес-аккаунта WhatsApp
limit integer [min: 1, max: 100]
Максимальное количество бизнес-аккаунтов WhatsApp, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
после строки
Курсор для постраничной навигации. Используйте его, чтобы перейти на следующую страницу результатов.
перед строкой
Курсор для постраничной навигации. Используйте его, чтобы перейти на предыдущую страницу результатов.
найти строку
Найдите конкретный бизнес-аккаунт WhatsApp по ID
Ответы
Получите список бизнес-аккаунтов WhatsApp, принадлежащих указанному бизнес-портфелю.
Этот конечный пункт предоставляет информацию о принадлежащих вам бизнес-аккаунтах WhatsApp
от компании, включая их конфигурацию, статус и основные свойства
соответствует функциональности GraphBusinessWhatsAppBusinessAccountsEdge.
Варианты использования:
Получить список принадлежащих вам бизнес-аккаунтов WhatsApp
Отслеживание состояния и конфигурации WABA
Проверьте данные WABA для интеграции с бизнес-системами
Управление настройками корпоративной мессенджерной системы WhatsApp
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация WABA может кэшироваться в течение умеренного времени, но информация о состоянии может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
200
Аккаунты WhatsApp Business успешно восстановлены
Тип содержимого: application/json
Схема: WhatsAppBusinessAccountsResponse
Показать дочерние атрибуты
Ответ от бизнес-аккаунтов WhatsApp
данных WhatsAppBusinessAccount
Множество бизнес-аккаунтов WhatsApp
Показать дочерние атрибуты
данные[] WhatsAppBusinessAccount
Информация и настройки бизнес-аккаунта WhatsApp
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор для бизнес-аккаунта WhatsApp
строка имени · обязательный
Удобочитаемое название бизнес-аккаунта WhatsApp
account_review_status AccountReviewStatus
Проверка статуса бизнес-аккаунта WhatsApp
номер_заказа_покупки строка
Номер заказа на покупку, связанный с учетной записью
строка валюты
Код валюты для WABA (формат ISO 4217)
timezone_id string
Идентификатор часового пояса для WABA
business_verification_status BusinessVerificationStatus
Статус проверки предприятия, связанного с WABA
кантри струна
Код страны, в которой зарегистрирована WABA
on_behalf_of_business_info OnBehalfOfBusinessInfo
Информация о компании, от имени которой действует WABA
Показать дочерние атрибуты
строка идентификатора
Идентификатор предприятия
строка имени
Название компании
is_enabled_for_insights boolean
Доступна ли функция анализа данных для этого WABA?
message_template_namespace string
Пространство имен для шаблонов сообщений
навигация КурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
объект курсоров
Показать дочерние атрибуты
перед строкой
Курсор, указывающий на начало страницы данных
после строки
Курсор указывает на конец страницы данных
предыдущая строка
URL предыдущей страницы результатов
следующая строка
URL для следующей страницы результатов
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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
POST /{Version}/{Business-ID}/whatsapp_business_accounts
Создайте новый бизнес-аккаунт WhatsApp в рамках указанного бизнес-портфеля.
Эта конечная точка создает новый объект WABA с предоставленной конфигурацией и связывает его с другими объектами
с бизнес-портфелем. Счет будет открыт с указанной оплатой
метод и бизнес-условия.
Ограничение скорости запросов:
Действуют стандартные ограничения скорости запросов к Graph API. При создании учетной записи могут применяться дополнительные ограничения
Ограничение скорости запросов для предотвращения злоупотреблений.
Бизнес-логика:
Название учетной записи должно быть уникальным в рамках бизнес-портфеля
Способ оплаты должен быть действительным и активным
Для создания WABA компания должна иметь соответствующие разрешения
Созданный аккаунт будет находиться в состоянии ожидания до завершения проверки
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка Business-ID · обязательный
Идентификатор вашего бизнес-портфеля. Этот идентификатор можно найти в Meta Business Suite
или через API для управления бизнес-процессами.
Необходимый
Тип содержимого: application/json
Схема: WhatsAppBusinessAccountCreationRequest
Показать дочерние атрибуты
Запрос на создание бизнес-аккаунта WhatsApp
строка имени · обязательный
Удобочитаемое название для бизнес-аккаунта WhatsApp
primary_funding_id string
Идентификатор основного источника финансирования (кредитная карта или расширенный кредит)
номер_заказа_покупки строка
Номер заказа на покупку для выставления счета
строка валюты
Код валюты для выставления счетов (формат ISO 4217)
timezone_id целое число
Идентификатор часового пояса для учетной записи
тип бизнеса WhatsAppBusinessType
Тип аккаунта WhatsApp для бизнеса
on_behalf_of_business_id string
Идентификатор компании при создании учетной записи от имени другой компании
Ответы
Создайте новый бизнес-аккаунт WhatsApp в рамках указанного бизнес-портфеля.
Эта конечная точка создает новый объект WABA с предоставленной конфигурацией и связывает его с другими объектами
с бизнес-портфелем. Счет будет открыт с указанной оплатой
метод и бизнес-условия.
Ограничение скорости запросов:
Действуют стандартные ограничения скорости запросов к Graph API. При создании учетной записи могут применяться дополнительные ограничения
Ограничение скорости запросов для предотвращения злоупотреблений.
Бизнес-логика:
Название учетной записи должно быть уникальным в рамках бизнес-портфеля
Способ оплаты должен быть действительным и активным
Для создания WABA компания должна иметь соответствующие разрешения
Созданный аккаунт будет находиться в состоянии ожидания до завершения проверки
200
Аккаунт WhatsApp Business успешно создан
Тип содержимого: application/json
Схема: WhatsAppBusinessAccountCreationResponse
Показать дочерние атрибуты
WhatsAppBusinessAccountCreationResponse
строковый идентификатор · обязательный
Уникальный идентификатор для созданного бизнес-аккаунта WhatsApp
payment_account_id строка · обязательный
Идентификатор связанного платежного счета для выставления счетов
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
Комментарии отсутствуют
Комментарии отсутствуют