API для управления бизнес-аккаунтами WhatsApp — собственные бизнес-аккаунты WhatsApp | Документация для разработчиков
API для управления бизнес-аккаунтами WhatsApp — собственные бизнес-аккаунты WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
API для получения информации о бизнес-аккаунтах WhatsApp, принадлежащих конкретной компании.
Этот конечный пункт позволяет компаниям получать исчерпывающую информацию о своих..
Информация о принадлежащих мне бизнес-аккаунтах WhatsApp, включая данные об аккаунте, его статус и конфигурацию.
GET /{Version}/{Business-ID}/owned_whatsapp_business_accounts
Получение бизнес-аккаунтов WhatsApp, принадлежащих указанной компании. Данная конечная точка
предоставляет исчерпывающую информацию обо всех принадлежащих компании компаниях WABA, включая:
Сведения об учетной записи, конфигурации и состоянии.
Варианты использования:
Получить все бизнес-аккаунты WhatsApp, принадлежащие компании
Фильтрация учетных записей по типу бизнеса
Найти конкретные учетные записи по идентификатору
Мониторинг бизнес-портфеля аккаунтов WhatsApp Business
Управление доступом к учетным записям и правами доступа в нескольких WABA
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация об учетной записи может кэшироваться на короткие периоды, но статус и конфигурация сохраняются в кэше
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Business-IDСтрока·обязательный
Идентификатор вашей компании. Этот идентификатор представляет собой портфель компаний, владеющих данной компанией
Аккаунты WhatsApp Business можно найти в настройках вашего Business Manager.
Параметры запроса
business_typeиз WhatsAppBusinessType
Фильтрация учетных записей по типу бизнеса. Можно указать несколько типов в виде значений, разделенных запятыми.
Используйте это для фильтрации между корпоративными и малыми/средними бизнес-аккаунтами.
послестроки
Для постраничной навигации используйте курсор из предыдущего ответа
чтобы перейти на следующую страницу результатов.
первоецелое число [мин.: 1, макс.: 100]
Количество результатов, возвращаемых при постраничной навигации. Максимальное значение — 100.
Используйте курсор 'after' для постраничной навигации.
передстрокой
Для навигации в обратном порядке используйте курсор из предыдущего ответа
чтобы вернуться на предыдущую страницу результатов.
последнеецелое число [мин: 1, макс: 100]
Количество результатов, возвращаемых при обратной постраничной навигации. Максимальное значение — 100.
Используйте курсор 'before' для постраничной навигации в обратном порядке.
найтистроку
Найдите конкретный бизнес-аккаунт WhatsApp по ID среди имеющихся аккаунтов.
Используйте это для быстрого поиска конкретной учетной записи.
Ответы
Получение бизнес-аккаунтов WhatsApp, принадлежащих указанной компании. Данная конечная точка
предоставляет исчерпывающую информацию обо всех принадлежащих компании компаниях WABA, включая:
Сведения об учетной записи, конфигурации и состоянии.
Варианты использования:
Получить все бизнес-аккаунты WhatsApp, принадлежащие компании
Фильтрация учетных записей по типу бизнеса
Найти конкретные учетные записи по идентификатору
Мониторинг бизнес-портфеля аккаунтов WhatsApp Business
Управление доступом к учетным записям и правами доступа в нескольких WABA
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация об учетной записи может кэшироваться на короткие периоды, но статус и конфигурация сохраняются в кэше
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно восстановлены принадлежащие вам бизнес-аккаунты WhatsApp
Тип содержимого: application/json
Схема: WhatsAppBusinessAccountsConnection
Показать дочерние атрибуты
Подключение бизнес-аккаунтов WhatsApp
данныхмассив·обязательный
Массив записей о принадлежащих мне бизнес-аккаунтах WhatsApp
Показать дочерние атрибуты
данные[]WhatsAppBusinessAccount
Аккаунт WhatsApp Business принадлежит компании
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Уникальный идентификатор для бизнес-аккаунта WhatsApp
именистрока·обязательный
Удобочитаемое название бизнес-аккаунта WhatsApp
message_template_namespacestring·required
Идентификатор пространства имен для шаблонов сообщений, связанных с этой учетной записью
timezone_idстрока·обязательный
Указатель часового пояса для бизнес-аккаунта WhatsApp
навигацияКурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Курсор, указывающий на начало страницы с возвращенными данными
послестроки
Курсор, указывающий на конец страницы с возвращенными данными
следующаястрока
URL для следующей страницы результатов
предыдущаястрока
URL предыдущей страницы результатов
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