WhatsApp Business — API для назначенных учетных записей WhatsApp Business | Документация для разработчиков
WhatsApp Business - API для назначенных бизнес-аккаунтов WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
API для получения бизнес-аккаунтов WhatsApp, назначенных конкретному пользователю.
Этот конечный пункт позволяет приложениям получать доступ к бизнес-аккаунтам WhatsApp, назначенным определенным пользователям
конкретных пользователей.
GET /{Version}/{User-ID}/assigned_whatsapp_business_accounts
Получить доступ к бизнес-аккаунтам WhatsApp, назначенным конкретному пользователю.
Этот конечный пункт предоставляет информацию о назначении учетных записей, правах доступа и т. д
Текущий статус, соответствующий узлу GraphAssignedWhatsAppBusinessAccountsEdge.
Варианты использования:
Получить все бизнес-аккаунты WhatsApp, назначенные пользователю
Проверьте права доступа пользователей к конкретным учетным записям
Отслеживайте статус и изменения назначения учетных записей
Перед выполнением бизнес-операций необходимо проверить доступ пользователя
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о задании может кэшироваться на короткие периоды, но права доступа и статус сохраняются
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
идентификатора пользователяСтрока·обязательный
Идентификатор пользователя, для которого необходимо получить доступ к назначенным бизнес-аккаунтам WhatsApp.
Это должен быть действительный идентификатор пользователя в рамках вашего решения или партнерства.
Параметры запроса
полястрока
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, name, status).
Доступные поля: id, name, status, assignment_date, permissions, business_id, phone_numbers
limitinteger [min: 1, max: 100]
Максимальное количество учетных записей, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
послестроки
Курсор для постраничной навигации. Используйте его, чтобы перейти на следующую страницу результатов.
передстрокой
Курсор для постраничной навигации. Используйте его, чтобы перейти на предыдущую страницу результатов.
Ответы
Получить доступ к бизнес-аккаунтам WhatsApp, назначенным конкретному пользователю.
Этот конечный пункт предоставляет информацию о назначении учетных записей, правах доступа и т. д
Текущий статус, соответствующий узлу GraphAssignedWhatsAppBusinessAccountsEdge.
Варианты использования:
Получить все бизнес-аккаунты WhatsApp, назначенные пользователю
Проверьте права доступа пользователей к конкретным учетным записям
Отслеживайте статус и изменения назначения учетных записей
Перед выполнением бизнес-операций необходимо проверить доступ пользователя
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о задании может кэшироваться на короткие периоды, но права доступа и статус сохраняются
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно получены назначенные бизнес-аккаунты WhatsApp
Тип содержимого: application/json
Схема: AssignedAccountsResponse
Показать дочерние атрибуты
AssignedAccountsResponse
данныхмассив·обязательный
Список назначенных бизнес-аккаунтов WhatsApp
Показать дочерние атрибуты
data[]AssignedWhatsAppBusinessAccount
Аккаунт WhatsApp Business, назначенный пользователю
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Уникальный идентификатор для бизнес-аккаунта WhatsApp
именистрока·обязательный
Отображаемое имя бизнес-аккаунта WhatsApp
статусWhatsAppBusinessAccountStatus·обязательный
Текущий статус бизнес-аккаунта WhatsApp
assignment_datestring (date-time)
Дата и время присвоения учетной записи пользователю
разрешениймассив
Список разрешений, предоставленных пользователю для этой учетной записи
Показать дочерние атрибуты
разрешения[]WhatsAppBusinessAccountPermission
Уровень доступа для бизнес-аккаунта WhatsApp
business_idstring
Идентификатор компании, которой принадлежит этот бизнес-аккаунт WhatsApp
phone_numbers,массив
Номера телефонов, связанные с этим бизнес-аккаунтом WhatsApp
Показать дочерние атрибуты
phone_numbers[]PhoneNumberInfo
Информация о номере телефона для бизнес-аккаунта WhatsApp
Показать дочерние атрибуты
идентификаторастрока
Номер телефона ID
display_phone_numberstring
Отформатированный номер телефона для отображения
verified_namestring
Подтвержденное название компании для этого номера телефона
Статус:Один из "ПОДКЛЮЧЕНО", "ОТКЛЮЧЕНО", "ПЕРЕЙДИРОВАНО", "ОЖИДАЕТСЯ", "УДАЛЕНО"
Статус телефонного номера
пейджингPagingInfo
Информация о нумерации страниц для ответа
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Курсор для перехода на предыдущую страницу
послестроки
Наведите курсор для перехода на следующую страницу
следующаястрока
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
Комментарии отсутствуют
Комментарии отсутствуют