API для управления назначенными пользователями в бизнес-аккаунте WhatsApp | Документация для разработчиков
API для управления назначенными пользователями в бизнес-аккаунте WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
API для управления назначениями пользователей и правами доступа к бизнес-аккаунтам WhatsApp.
Этот интерфейс позволяет компаниям управлять доступом пользователей к своим бизнес-аккаунтам WhatsApp
включая отображение списка назначенных пользователей, добавление пользователей с определенными правами доступа и удаление доступа у пользователей.
GET /{Version}/{WhatsApp-Business-Account-ID}/assigned_users
Получите список пользователей, назначенных на бизнес-аккаунт WhatsApp, с указанием их прав доступа
и данные пользователя. Эта конечная точка поддерживает пагинацию и фильтрацию.
Варианты использования:
Проверка доступа пользователей к бизнес-аккаунту WhatsApp
Получение назначений прав доступа пользователей для обеспечения соответствия требованиям
Список всех пользователей, имеющих права доступа, для целей управления
Отслеживайте схемы доступа и назначения прав пользователям
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные о назначении пользователей могут кэшироваться на короткие периоды, но при этом могут происходить изменения прав доступа
часто. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
GET / {Version} / {WhatsApp-Business-Account-ID} /assigned_users
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора бизнес-аккаунта WhatsApp · обязательный
Идентификатор вашего бизнес-аккаунта WhatsApp. Этот идентификатор присваивается при создании аккаунта
Его можно найти в вашем Business Manager или через API управления учетными записями.
Параметры запроса
строка бизнес- · обязательный
Идентификатор компании, владеющей или имеющей доступ к бизнес-аккаунту WhatsApp.
Этот параметр необходим для указания бизнес-контекста при назначении пользователей.
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, name). Доступные поля: id, name, business, user_type
limit integer [min: 1, max: 100]
Максимальное количество назначенных пользователей, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
после строки
Курсор для постраничной навигации. Используйте его, чтобы перейти на следующую страницу результатов.
перед строкой
Курсор для постраничной навигации. Используйте его, чтобы перейти на предыдущую страницу результатов.
Ответы
Получите список пользователей, назначенных на бизнес-аккаунт WhatsApp, с указанием их прав доступа
и данные пользователя. Эта конечная точка поддерживает пагинацию и фильтрацию.
Варианты использования:
Проверка доступа пользователей к бизнес-аккаунту WhatsApp
Получение назначений прав доступа пользователей для обеспечения соответствия требованиям
Список всех пользователей, имеющих права доступа, для целей управления
Отслеживайте схемы доступа и назначения прав пользователям
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные о назначении пользователей могут кэшироваться на короткие периоды, но при этом могут происходить изменения прав доступа
часто. Внедрите соответствующие стратегии аннулирования кэша.
200
Список назначенных пользователей успешно получен
Тип содержимого: application/json
Схема: AssignedUsersResponse
Показать дочерние атрибуты
AssignedUsersResponse
данных AssignedUser · обязательный
Массив назначенных пользователей
Показать дочерние атрибуты
data[] AssignedUser
Пользователь, которому назначен бизнес-аккаунт WhatsApp с соответствующими правами доступа
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор назначенного пользователя
строка имени · обязательный
Отображаемое имя назначенного пользователя
бизнес BusinessNode
Бизнес-субъект, связанный с пользователем
Показать дочерние атрибуты
строка идентификатора
Уникальный идентификатор для бизнеса
строка имени
Название компании
user_type AssignedUserType
Тип назначения пользователя
навигация КурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
объект курсоров
Показать дочерние атрибуты
перед строкой
Курсор, указывающий на начало страницы данных
после строки
Курсор указывает на конец страницы данных
следующая строка
Конечная точка Graph API для следующей страницы результатов
предыдущая строка
Конечная точка Graph API для предыдущей страницы результатов
сводка НазначенныеПользователиСводка
Сводная информация о назначенных пользователях
Показать дочерние атрибуты
total_count целое число
Общее количество назначенных пользователей
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
Не найдено — идентификатор бизнес-аккаунта WhatsApp не существует или недоступен
Тип содержимого: 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}/{WhatsApp-Business-Account-ID}/assigned_users
Добавить пользователя в бизнес-аккаунт WhatsApp с заданными правами доступа для выполнения определенных задач.
Эта операция предоставляет пользователю доступ к выполнению определенных действий в учетной записи
на основе предоставленных задач по получению разрешений.
Варианты использования:
Предоставьте пользователю доступ к управлению бизнес-аккаунтом WhatsApp
Назначайте конкретные задачи по управлению правами доступа для детального контроля доступа
Добавление новых членов команды в работу с бизнес-аккаунтом WhatsApp
Настройте права доступа пользователей для различных бизнес-ролей
Задачи по получению разрешений:
Различные задачи по предоставлению разрешений обеспечивают доступ к различным функциям бизнес-аккаунта WhatsApp:
УПРАВЛЕНИЕ: Общие права доступа к управлению учетной записью
РАЗРАБОТКА: Права доступа к разработке и API
MANAGE_TEMPLATES: Управление шаблонами сообщений
MANAGE_PHONE: Управление номерами телефонов
ОБМЕН СООБЩЕНИЯМИ: Отправка и получение сообщений
ПОЛНЫЙ КОНТРОЛЬ: Полный доступ ко всем функциям учетной записи
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Синтаксис запроса
POST / {Version} / {WhatsApp-Business-Account-ID} /assigned_users
Попробуйте!
Выберите язык
Выберите код состояния
{ "success": true }Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора бизнес-аккаунта WhatsApp · обязательный
Идентификатор вашего бизнес-аккаунта WhatsApp. Этот идентификатор присваивается при создании аккаунта
Его можно найти в вашем Business Manager или через API управления учетными записями.
Текст запросаНеобходимый
Тип содержимого: application/x-www-form-urlencoded
Схема: объект
Показать дочерние атрибуты
строка пользователя · обязательный
Идентификатор пользователя, которого нужно добавить в бизнес-аккаунт WhatsApp.
Это должен быть действительный идентификатор пользователя Facebook.
массив задач · обязательные
Массив задач по предоставлению разрешений пользователю. Эти задачи определяют
Какие действия пользователь может выполнять в бизнес-аккаунте WhatsApp.
Показать дочерние атрибуты
задачи[] WhatsAppBusinessAccountPermissionTask
Детализированные задачи по предоставлению разрешений для доступа к бизнес-аккаунту WhatsApp
Ответы
Добавить пользователя в бизнес-аккаунт WhatsApp с заданными правами доступа для выполнения определенных задач.
Эта операция предоставляет пользователю доступ к выполнению определенных действий в учетной записи
на основе предоставленных задач по получению разрешений.
Варианты использования:
Предоставьте пользователю доступ к управлению бизнес-аккаунтом WhatsApp
Назначайте конкретные задачи по управлению правами доступа для детального контроля доступа
Добавление новых членов команды в работу с бизнес-аккаунтом WhatsApp
Настройте права доступа пользователей для различных бизнес-ролей
Задачи по получению разрешений:
Различные задачи по предоставлению разрешений обеспечивают доступ к различным функциям бизнес-аккаунта WhatsApp:
УПРАВЛЕНИЕ: Общие права доступа к управлению учетной записью
РАЗРАБОТКА: Права доступа к разработке и API
MANAGE_TEMPLATES: Управление шаблонами сообщений
MANAGE_PHONE: Управление номерами телефонов
ОБМЕН СООБЩЕНИЯМИ: Отправка и получение сообщений
ПОЛНЫЙ КОНТРОЛЬ: Полный доступ ко всем функциям учетной записи
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
200
Пользователь успешно добавлен в бизнес-аккаунт WhatsApp
Тип содержимого: application/json
Схема: SuccessResponse
Показать дочерние атрибуты
УспехОтвет
успех логическое значение · обязательно
Указывает, была ли операция успешной
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
Не найдено - Идентификатор учетной записи или пользователя WhatsApp Business не существует
Тип содержимого: 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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
{ "success": true }Удалить /{Версия}/{ID учетной записи WhatsApp для бизнеса}/assigned_users
Удалить доступ пользователя к бизнес-аккаунту WhatsApp. Эта операция аннулирует доступ
Все разрешения и права доступа для указанного пользователя к учетной записи.
Варианты использования:
Отзывайте права доступа пользователей при их увольнении из организации
Отменить временные разрешения на доступ
Устраните нарушения прав доступа пользователей в соответствии с требованиями безопасности
Управление жизненным циклом пользователей и контролем доступа
Важные примечания:
Эта операция удаляет ВСЕ разрешения для пользователя в этом бизнес-аккаунте WhatsApp
Пользователь потеряет доступ ко всем функциям и данным своей учетной записи
Это действие необратимо — пользователя необходимо добавить заново, если доступ потребуется снова
Веб-хуки могут быть активированы для уведомления об изменениях в доступе пользователей
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Синтаксис запроса
DELETE / {Version} / {WhatsApp-Business-Account-ID} /assigned_users
Попробуйте!
Выберите язык
Выберите код состояния
{ "success": true }Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора бизнес-аккаунта WhatsApp · обязательный
Идентификатор вашего бизнес-аккаунта WhatsApp. Этот идентификатор присваивается при создании аккаунта
Его можно найти в вашем Business Manager или через API управления учетными записями.
Текст запросаНеобходимый
Тип содержимого: application/x-www-form-urlencoded
Схема: объект
Показать дочерние атрибуты
строка пользователя · обязательный
Идентификатор пользователя, которого нужно удалить из бизнес-аккаунта WhatsApp.
Это должен быть действительный идентификатор пользователя Facebook, который в настоящее время присвоен учетной записи.
Ответы
Удалить доступ пользователя к бизнес-аккаунту WhatsApp. Эта операция аннулирует доступ
Все разрешения и права доступа для указанного пользователя к учетной записи.
Варианты использования:
Отзывайте права доступа пользователей при их увольнении из организации
Отменить временные разрешения на доступ
Устраните нарушения прав доступа пользователей в соответствии с требованиями безопасности
Управление жизненным циклом пользователей и контролем доступа
Важные примечания:
Эта операция удаляет ВСЕ разрешения для пользователя в этом бизнес-аккаунте WhatsApp
Пользователь потеряет доступ ко всем функциям и данным своей учетной записи
Это действие необратимо — пользователя необходимо добавить заново, если доступ потребуется снова
Веб-хуки могут быть активированы для уведомления об изменениях в доступе пользователей
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
200
Пользователь успешно удален из бизнес-аккаунта WhatsApp
Тип содержимого: application/json
Схема: SuccessResponse
Показать дочерние атрибуты
УспехОтвет
успех логическое значение · обязательно
Указывает, была ли операция успешной
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
Не найдено — идентификатор учетной записи или пользователя WhatsApp Business не существует или не назначен
Тип содержимого: 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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
{ "success": true }Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth