WhatsApp Business Cloud API — API для управления группами | Документация для разработчиков
WhatsApp Business Cloud API - API для управления группами
Экземпляр для программы магистратуры (LLM)
Версия
Создавайте и управляйте бизнес-группами WhatsApp с настройками авторизации.
Возвращает ссылки-приглашения для добавления участников в группы.
Получение списков активных групп с поддержкой постраничной навигации.
Выберите язык
POST /{Version}/{Phone-Number-ID}/groups
Создайте новую группу и получите ссылку-приглашение
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Параметры пути
Строка версии · обязательный
Строка идентификатора номера телефона · обязательный
Идентификатор номера телефона компании
Необходимый
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_product "whatsapp" · required
Продукт для обмена сообщениями
строка темы · обязательный
Тема группы. Максимальное количество символов: 128. Пробелы удаляются.
строка описания
Описание группы. Максимальное количество символов: 2048.
join_approval_mode Один из "approval_required", "auto_approve"
Указывает, могут ли пользователи WhatsApp, перешедшие по ссылке-приглашению, присоединиться к группе с предварительным одобрением или без него.
approval_required: Пользователи WhatsApp должны получить одобрение в виде запроса на вступление, прежде чем смогут получить доступ к группе
auto_approve: Пользователи WhatsApp могут присоединиться к группе без одобрения
Ответы
Создайте новую группу и получите ссылку-приглашение
200
Запрос на создание группы успешно отправлен
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_product string
request_id string
Идентификатор запроса на создание группы
400
Неверный запрос - Недопустимые параметры запроса
Тип содержимого: application/json
Схема: ErrorResponse
Показать дочерние атрибуты
ErrorResponse
ошибка ErrorObject · требуется
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое описание ошибки
тип строка · обязательный
Классификация типов ошибок
код целое число · обязательный
Числовой код ошибки
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Схема: ErrorResponse
Показать дочерние атрибуты
ErrorResponse
ошибка ErrorObject · требуется
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое описание ошибки
тип строка · обязательный
Классификация типов ошибок
код целое число · обязательный
Числовой код ошибки
500
Внутренняя ошибка сервера — произошла непредвиденная ошибка
Тип содержимого: application/json
Схема: ErrorResponse
Показать дочерние атрибуты
ErrorResponse
ошибка ErrorObject · требуется
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое описание ошибки
тип строка · обязательный
Классификация типов ошибок
код целое число · обязательный
Числовой код ошибки
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют