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

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

WhatsApp Business Cloud API - API для запросов на вступление в группы

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

Базовый URL

https://graph.facebook.com

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


GET /{Version}/{group_id}/join_requests

Получить список открытых запросов на вступление в группу

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

GET / {Version} / {group_id} /join_requests
Попробуйте!
Выберите язык

curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
group_id строка · обязательный
Идентификатор группы
Ответы
Получить список открытых запросов на вступление в группу
200
Список запросов на присоединение
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты

данных объекта
Показать дочерние атрибуты

объект данных[]
Показать дочерние атрибуты

join_request_id string
Идентификатор запроса на присоединение

строка wa_id
Идентификатор пользователя WhatsApp

creation_timestamp целое число
Unix-метка времени, указывающая, когда был создан запрос на присоединение

пейджинг PagingInfo
Показать дочерние атрибуты

объект курсоров
Показать дочерние атрибуты

перед строкой
Перед курсором

после строки
После курсора

предыдущая строка
URL предыдущей страницы

следующая строка
URL следующей страницы
Выберите язык

curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'

POST /{Version}/{group_id}/join_requests

Одобрить один или несколько запросов на присоединение

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

POST / {Version} / {group_id} /join_requests
Попробуйте!
Выберите язык

curl
--request POST \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"messaging_product"
: "\"whatsapp\"" }
Параметры заголовка
Строка 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

join_requests массив строк · обязательный
Массив идентификаторов запросов на присоединение для утверждения
Показать дочерние атрибуты

join_requests[] string
Идентификатор запроса на присоединение
Ответы
Одобрить один или несколько запросов на присоединение
200
Ответ на запрос о присоединении
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты

messaging_product string

approved_join_requests массив строк
Показать дочерние атрибуты

approved_join_requests[] string
Идентификатор одобренного запроса на присоединение

массив объектов failed_join_requests
Показать дочерние атрибуты

объект failed_join_requests[]
Показать дочерние атрибуты

join_request_id string

массив ошибок
Показать дочерние атрибуты

ошибки[] Ошибка
Показать дочерние атрибуты

код целое число
Код ошибки

строка сообщения
Сообщение об ошибке

строка заголовка
Заголовок ошибки

объект error_data
Показать дочерние атрибуты

строка подробностей
Подробности ошибки

массив ошибок
Показать дочерние атрибуты

ошибки[] Ошибка
Показать дочерние атрибуты

код целое число
Код ошибки

строка сообщения
Сообщение об ошибке

строка заголовка
Заголовок ошибки

объект error_data
Показать дочерние атрибуты

строка подробностей
Подробности ошибки
Выберите язык

curl
--request POST \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"messaging_product"
: "\"whatsapp\"" }

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

Отклонить один или несколько запросов на присоединение

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

DELETE / {Version} / {group_id} /join_requests
Попробуйте!
Выберите язык

curl
--request DELETE \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"messaging_product"
: "\"whatsapp\"" }
Параметры заголовка
Строка 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

join_requests массив строк · обязательный
Массив идентификаторов запросов на присоединение, подлежащих отклонению
Показать дочерние атрибуты

join_requests[] string
Идентификатор запроса на присоединение
Ответы
Отклонить один или несколько запросов на присоединение
200
Ответ на отклонение запроса на присоединение
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты

messaging_product string

rejected_join_requests массив строк
Показать дочерние атрибуты

rejected_join_requests[] string
Идентификатор отклоненного запроса на присоединение

массив объектов failed_join_requests
Показать дочерние атрибуты

объект failed_join_requests[]
Показать дочерние атрибуты

join_request_id string

массив ошибок
Показать дочерние атрибуты

ошибки[] Ошибка
Показать дочерние атрибуты

код целое число
Код ошибки

строка сообщения
Сообщение об ошибке

строка заголовка
Заголовок ошибки

объект error_data
Показать дочерние атрибуты

строка подробностей
Подробности ошибки

массив ошибок
Показать дочерние атрибуты

ошибки[] Ошибка
Показать дочерние атрибуты

код целое число
Код ошибки

строка сообщения
Сообщение об ошибке

строка заголовка
Заголовок ошибки

объект error_data
Показать дочерние атрибуты

строка подробностей
Подробности ошибки
Выберите язык

curl
--request DELETE \ --url
'https://graph.facebook.com/{Version}/{group_id}/join_requests ' \ --header
'Authorization: Bearer' ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"messaging_product"
: "\"whatsapp\"" }

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

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

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

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

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

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