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--requestGET \
--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_idstring
Идентификатор запроса на присоединение
wa_idстрока
Идентификатор пользователя WhatsApp
creation_timestampцелое число
Unix-метка времени, указывающая, когда был создан запрос на присоединение
пейджингPagingInfo
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Перед курсором
послестроки
После курсора
предыдущаястрока
URL предыдущей страницы
следующаястрока
URL следующей страницы
Выберите язык
curl--requestGET \
--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"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
group_idстрока·обязательный
Идентификатор группы
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_product"whatsapp"·required
join_requestsмассив строк·обязательный
Массив идентификаторов запросов на присоединение для утверждения
Показать дочерние атрибуты
join_requests[]string
Идентификатор запроса на присоединение
Ответы
Одобрить один или несколько запросов на присоединение
200
Ответ на запрос о присоединении
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_productstring
approved_join_requestsмассив строк
Показать дочерние атрибуты
approved_join_requests[]string
Идентификатор одобренного запроса на присоединение
failed_join_requestsмассив объектов
Показать дочерние атрибуты
failed_join_requests[]объект
Показать дочерние атрибуты
join_request_idstring
ошибокмассив
Показать дочерние атрибуты
ошибки[]Ошибка
Показать дочерние атрибуты
кодцелое число
Код ошибки
сообщениястрока
Сообщение об ошибке
заголовкастрока
Заголовок ошибки
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"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
group_idстрока·обязательный
Идентификатор группы
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_product"whatsapp"·required
join_requestsмассив строк·обязательный
Массив идентификаторов запросов на присоединение, подлежащих отклонению
Показать дочерние атрибуты
join_requests[]string
Идентификатор запроса на присоединение
Ответы
Отклонить один или несколько запросов на присоединение
200
Ответ на отклонение запроса на присоединение
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
messaging_productstring
rejected_join_requestsмассив строк
Показать дочерние атрибуты
rejected_join_requests[]string
Идентификатор отклоненного запроса на присоединение
failed_join_requestsмассив объектов
Показать дочерние атрибуты
failed_join_requests[]объект
Показать дочерние атрибуты
join_request_idstring
ошибокмассив
Показать дочерние атрибуты
ошибки[]Ошибка
Показать дочерние атрибуты
кодцелое число
Код ошибки
сообщениястрока
Сообщение об ошибке
заголовкастрока
Заголовок ошибки
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