Перейти к основному содержимому

WhatsApp Business Cloud API - API для запросов к группам | Документация для разработчиков

WhatsApp Business Cloud API - API для запросов к группам

Экземпляр для программы магистратуры (LLM)
Версия
API для работы с группами предоставляет простые функции для управления группами на протяжении всего их жизненного цикла.
При создании новой группы создается ссылка-приглашение для приглашения участников в группу.
Поскольку добавлять участников в группу вручную невозможно, просто отправьте сообщение со ссылкой-приглашением пользователям WhatsApp, которых вы хотели бы пригласить в группу.

База

URL
Выберите язык
https://graph.facebook.com

Конечные точки

GET /{Version}/{group_id}

Получение метаданных об отдельной группе

Синтаксис запроса

ПОЛУЧАТЬ /{Версия}/{group_id}
Попробуйте!
Выберите язык
локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Путь Параметры
Версиянить·необходимый
group_idнить·необходимый
Группа ИДЕНТИФИКАТОР
Параметры запроса
полянить
Список полей, разделенных запятыми, для возврата
Ответы
Получение метаданных об отдельной группе
200
Информация о группе
Тип контента: приложение/json
Схема: GroupInfo
Показать дочерние атрибуты
GroupInfo
идентификаторнить
Идентификатор группы
messaging_productнить
режим_присоединения_одобренияОдин из параметров: "approval_required", "auto_approve"
Присоединяйтесь к группе в режиме подтверждения
предметнить
Групповой предмет
описаниенить
Описание группы
приостановленныйлогический
Возвращает true, если группа была заблокирована WhatsApp
creation_timestampцелое число
UNIX-метка времени в секундах, в которую была создана группа
участникимассив объектов
Список участников группы
Показать дочерние атрибуты
участники[]объект
Показать дочерние атрибуты
wa_idнить
Идентификатор пользователя WhatsApp
общее_количество_участниковцелое число
Общее количество участников группы, за исключением вашей компании
Выберите язык
локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'

ПОЧТА /{Версия}/{group_id}

Обновите тему, описание и фотографию группы

Синтаксис запроса

ПОЧТА /{Версия}/{group_id}
Попробуйте!
Выберите язык
локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
group_idнить·необходимый
Идентификатор группы
Текст запросаНеобходимый
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты
messaging_product"WhatsApp"·необходимый
предметнить
Новая тема для группы
описаниенить
Новое описание группы
файл_изображения_профилянить
Путь к файлу изображения для групповой фотографии профиля
Тип контента: multipart/form-data
Схема: объект
Показать дочерние атрибуты
messaging_product"WhatsApp"
файлстрока (двоичная)
Файл изображения для групповой фотографии профиля (JPEG, максимальный размер 5 МБ, квадратный формат, минимальный размер 192x192)
Ответы
Обновите тему, описание и фотографию группы
200
Настройки группы успешно обновлены
Выберите язык
локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'

Удалить /{Версия}/{group_id}

Удалите группу и всех её участников, включая бизнес-группу

Синтаксис запроса

УДАЛИТЬ /{Версия}/{group_id}
Попробуйте!
Выберите язык
локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния
{
"успех": "истинный"
}
Заголовок Параметры
Агент пользователянить
Он Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
group_idнить·необходимый
Идентификатор группы
Ответы
Удалите группу и всех её участников, включая бизнес-группу
200
Удаление группы прошло успешно
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты
успехлогический
Выберите язык
локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния
{
 "success"
 : "true" }

Аутентификация

Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок: Авторизация

Примеры использования

bearerAuth:
Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:
bearerAuth
Вернуться наверх