Перейти к содержанию

callsRtc#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно. В будущем за функционал может взиматься дополнительная плата.
Подключение к функционалу можно запросить через техподдержку GREEN-API

В данном разделе приводится описание общего формата входящих уведомлений с типом callsRtc. Вебхук предназначен для уведомления об изменении состояния сессии звонков и всегда включён.

Уведомление#

Формат уведомления#

В обе стороны используется единый формат сообщения. Поля, не относящиеся к конкретному сообщению, опускаются, а не передаются пустыми:

{"type": "...", "state": {}, "offer": {}, "answer": {}, "candidate": {}, "message": ""}

Поля объекта messageData исходящие {#client-messages}

Параметр Тип Описание
type string Тип принятого сообщения.
state object Объект данных о принятом текстовом сообщении или URL ссылки
answer object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой
candidate object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой
message object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой

Поля объекта messageData входящие {#server-messages}

Параметр Тип Описание
type string Тип принятого сообщения.
state object Объект данных о принятом текстовом сообщении или URL ссылки
answer object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой
candidate object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой
message object Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой