API-интерфейс для создания бизнес-аккаунтов WhatsApp | Документация для разработчиков
Список решений для бизнес-аккаунтов WhatsApp с помощью API
Экземпляр для программы магистратуры (LLM)
Версия
API для получения информации о многопартнерских решениях, связанных с бизнес-аккаунтом WhatsApp (WABA).
Эта конечная точка позволяет авторизованным приложениям получать список решений, объединяющих несколько партнеров
которые связаны с конкретным бизнес-аккаунтом WhatsApp.
GET /{Version}/{WABA-ID}/solutions
Получить постраничный список многопартнерских решений, связанных с указанным объектом
Бизнес-аккаунт WhatsApp. Данная конечная точка поддерживает выбор полей и выбор с помощью курсора
Пагинация для эффективного поиска данных.
Варианты использования:
Ознакомьтесь с доступными многопартнерскими решениями для адаптации новых клиентов
Отслеживайте состояние и доступность решения в рамках вашей системы WABA
Получите информацию о владельце решения и его правах доступа
Фильтрация решений по определенным полям или требованиям к статусу
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Списки решений могут кэшироваться на короткие периоды, но информация о состоянии может изменяться
Часто во время переходов. Внедрите соответствующие стратегии аннулирования кэша.
Пагинация:
Этот конечный пункт поддерживает постраничную навигацию с использованием курсора, применяя
параметры limit, afterи before.параметры. Используйте
пагинации в ответах для навигации по наборам результатов.Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
WABA-IDСтрока·обязательный
Идентификатор бизнес-аккаунта WhatsApp, по которому можно получить доступ к связанным многопартнерским решениям.
Этот идентификатор можно найти в вашем WhatsApp Business Manager или через API управления WABA.
Параметры запроса
полястрока
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (имя, статус, статус для ожидающего запроса).
Доступные поля: id, name, status, status_for_pending_request, owner_app, owner_permissions
limitinteger [min: 1, max: 100]
Максимальное количество решений, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
послестроки
Курсор для постраничной навигации. Возвращает решения, расположенные после этой позиции курсора.
предыдущего ответа
paging.cursors.after .передстрокой
Курсор для постраничной навигации. Возвращает решения, расположенные перед этой позицией курсора.
предыдущего ответа
paging.cursors.before .Ответы
Получить постраничный список многопартнерских решений, связанных с указанным объектом
Бизнес-аккаунт WhatsApp. Данная конечная точка поддерживает выбор полей и выбор с помощью курсора
Пагинация для эффективного поиска данных.
Варианты использования:
Ознакомьтесь с доступными многопартнерскими решениями для адаптации новых клиентов
Отслеживайте состояние и доступность решения в рамках вашей системы WABA
Получите информацию о владельце решения и его правах доступа
Фильтрация решений по определенным полям или требованиям к статусу
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Списки решений могут кэшироваться на короткие периоды, но информация о состоянии может изменяться
Часто во время переходов. Внедрите соответствующие стратегии аннулирования кэша.
Пагинация:
Этот конечный пункт поддерживает постраничную навигацию с использованием курсора, применяя
параметры limit, afterи before.параметры. Используйте
пагинации в ответах для навигации по наборам результатов.200
Список многопартнерских решений успешно получен
Тип содержимого: application/json
Схема: SolutionsList
Показать дочерние атрибуты
SolutionsList
данныхмассив·обязательный
Множество многосторонних партнерских решений, связанных с WABA
Показать дочерние атрибуты
данные[]WhatsAppBusinessSolution
Подробности и конфигурация многопартнерского решения
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Уникальный идентификатор для многопартнерского решения
именистрока·обязательный
Удобочитаемое название многопартнерского решения
статусWhatsAppBusinessSolutionStatus·обязательный
Текущий статус функционирования многопартнерского решения
Показать дочерние атрибуты
status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required
Статус любых ожидающих запросов на изменение статуса решения
owner_appApplicationNode
Мета-приложение, владеющее многопартнерским решением
Показать дочерние атрибуты
идентификаторастрока
Уникальный идентификатор приложения Meta
именистрока
Название приложения Meta
owner_permissionsмассив
Список разрешений для бизнес-аккаунта WhatsApp, предоставленных владельцу решения
Показать дочерние атрибуты
owner_permissions[]WhatsAppBusinessAccountPermissionTask
Детализированные задачи по предоставлению разрешений для доступа к бизнес-аккаунту WhatsApp
пейджинг
Информация о постраничной навигации для навигации с помощью курсора
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Курсор, указывающий на начало страницы с возвращенными данными
послестроки
Курсор, указывающий на конец страницы с возвращенными данными
предыдущаястрока
URL-адрес конечной точки Graph API для предыдущей страницы данных
следующаястрока
URL-адрес конечной точки Graph API для следующей страницы данных
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
Не найдено — идентификатор WABA не существует или недоступен
Тип содержимого: 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
Комментарии отсутствуют
Комментарии отсутствуют