WhatsApp Business Cloud API - API для запросов к группам | Документация для разработчиков
WhatsApp Business Cloud API - API для запросов к группам
Экземпляр для программы магистратуры (LLM)
Версия
API для работы с группами предоставляет простые функции для управления группами на протяжении всего их жизненного цикла.
При создании новой группы создается ссылка-приглашение для приглашения участников в группу.
Поскольку добавлять участников в группу вручную невозможно, просто отправьте сообщение со ссылкой-приглашением пользователям WhatsApp, которых вы хотели бы пригласить в группу.
Базовый URL
https://graph.facebook.com |
Конечные точки
ПОЛУЧАТЬ | |
ПОЧТА | |
УДАЛИТЬ |
GET /{Version}/{group_id}
Получение метаданных об отдельной группе
Синтаксис запроса
GET /{Version}/{group_id}
Попробуйте!
Выберите язык
curl--requestGET \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
group_idстрока·обязательный
Идентификатор группы
Параметры запроса
полястрока
Список полей, разделенных запятыми, для возврата
Ответы
Получение метаданных об отдельной группе
200
Информация о группе
Тип содержимого: application/json
Схема: GroupInfo
Показать дочерние атрибуты
GroupInfo
идентификаторастрока
Идентификатор группы
messaging_productstring
join_approval_modeОдин из "approval_required", "auto_approve"
Присоединяйтесь к группе в режиме подтверждения
темыстрока
Групповой предмет
описаниястрока
Описание группы
приостановленныйлогический
Возвращает true, если группа была заблокирована WhatsApp
creation_timestampцелое число
UNIX-метка времени в секундах, в которую была создана группа
участникимассив объектов
Список участников группы
Показать дочерние атрибуты
участники[]объект
Показать дочерние атрибуты
wa_idстрока
Идентификатор пользователя WhatsApp
total_participant_countinteger
Общее количество участников группы, за исключением вашей компании
Выберите язык
curl--requestGET \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
POST /{Version}/{group_id}
Обновите тему, описание и фотографию группы
Синтаксис запроса
POST /{Version}/{group_id}
Попробуйте!
Выберите язык
curl--request POST \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
group_idстрока·обязательный
Идентификатор группы
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_product"whatsapp"·required
темыстрока
Новая тема для группы
описаниястрока
Новое описание группы
profile_picture_fileстрока
Путь к файлу изображения для групповой фотографии профиля
Тип содержимого: multipart/form-data
Схема: объект
Показать дочерние атрибуты
messaging_product"whatsapp"
файл(двоичный)
Файл изображения для групповой фотографии профиля (JPEG, максимальный размер 5 МБ, квадратный формат, минимальный размер 192x192)
Ответы
Обновите тему, описание и фотографию группы
200
Настройки группы успешно обновлены
Выберите язык
curl--request POST \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
Удалить /{Версия}/{group_id}
Удалите группу и всех её участников, включая бизнес-группу
Синтаксис запроса
УДАЛИТЬ /{Версия}/{group_id}
Попробуйте!
Выберите язык
curl--request DELETE \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
Выберите код состояния
{
"success": "true"
}
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
group_idстрока·обязательный
Идентификатор группы
Ответы
Удалите группу и всех её участников, включая бизнес-группу
200
Удаление группы прошло успешно
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
успехлогическое значение
Выберите язык
curl--request DELETE \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--header'Authorization: Bearer \
--header'Content-Type: application/json' \
--data'{}'
Выберите код состояния
{
"success": "true"
}
Аутентификация
Схема | Тип | Расположение |
bearerAuth | HTTP Bearer | Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth