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

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

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

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

База

URL
Выберите язык

https://graph.facebook.com

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


ПОЛУЧАТЬ /{Version}/{group_id}/join_requests

ПолучатьУтвердить аодин списокили открытогоболее запросы на присоединение для группы

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

ПОЛУЧАТЬПОЧТА /{Версия}/{group_id}/join_requests
Попробуйте!
Выберите язык

Выберите код состояния

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

данныеmessaging_product"WhatsApp"·необходимый

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

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

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

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

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

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

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

донить
Перед курсором

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

предыдущийнить
URL предыдущей страницы

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

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}/join_requests' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'

ПОЧТА /{Version}/{group_id}/join_requests

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

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

ПОЧТА /{Версия}/{group_id}/join_requests
Пытаться200 это
Ответ на запрос о присоединении
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

messaging_productнить

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

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

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

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

join_request_idнить

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

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

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

сообщениенить
Сообщение об ошибке

заголовокнить
Заголовок ошибки

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

подробностинить
Подробности ошибки

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

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

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

сообщениенить
Сообщение об ошибке

заголовокнить
Заголовок ошибки

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

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

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{group_id}/join_requests' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

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

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

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

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

УДАЛИТЬ /{Версия}/{group_id}/join_requests
Попробуйте!
Выберите язык

Выберите код состояния

{
"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[rejected_join_requests[]нить
Идентификатор одобренныйотклоненный запрос на присоединение

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

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

join_request_id string

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

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

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

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

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

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

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

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

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

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

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

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

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

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

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{group_id}/join_requests' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

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

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

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

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

УДАЛИТЬ /{Версия}/{group_id}/join_requests
Попробуйте!
Выберите язык

локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}/join_requests' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
"messaging_product""\"whatsapp\""
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
group_idнить·необходимый
Идентификатор группы
Текст запросаНеобходимый
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

messaging_product"WhatsApp"·необходимый

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

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

messaging_productнить

отклоненные_запросы_присоединениямассив строк
Показать дочерние атрибуты

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

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

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

join_request_idнить

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

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

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

сообщениенить
Сообщение об ошибке

заголовокнить
Заголовок ошибки

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

подробностинить
Подробности ошибки

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

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

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

сообщениенить
Сообщение об ошибке

заголовокнить
Заголовок ошибки

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

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

локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{group_id}/join_requests' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

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

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

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

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

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

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

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