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
--request GET \ --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_product string
join_approval_mode Один из "approval_required", "auto_approve"
Присоединяйтесь к группе в режиме подтверждения
строка темы
Групповой предмет
строка описания
Описание группы
приостановленный логический
Возвращает true, если группа была заблокирована WhatsApp
creation_timestamp целое число
UNIX-метка времени в секундах, в которую была создана группа
участники массив объектов
Список участников группы
Показать дочерние атрибуты
участники[] объект
Показать дочерние атрибуты
строка wa_id
Идентификатор пользователя WhatsApp
total_participant_count integer
Общее количество участников группы, за исключением вашей компании
Выберите язык
curl
--request GET \ --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" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
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" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
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
Комментарии отсутствуют
Комментарии отсутствуют