Входящий звонок#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно.

Уведомление данного типа возникает при входящем звонке и содержит информацию об инициаторе и адресате звонка.

Настройка инстанса

Чтобы получать входящие уведомления о входящих звонках, необходимо включить настройки одним из представленных вариантов:

Через личный кабинет включить настройки Получать уведомления о входящих сообщениях и файлах и Получать уведомления о звонках
Через метод SetSettings включить настройки incomingWebhook и incomingCallWebhook

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

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

Параметр	Тип	Описание
`from`	string	Идентификатор инициатора звонка
`typeWebhook`	string	Тип входящего уведомления. Для уведомлений данного типа поле принимает значение `incomingCall`
`instanceData`	object	Объект данных с информацией об инстансе
`status`	string	Статус входящего звонка, принимает значения:
		`offer` - входящий звонок
		`pickUp` - отвеченный входящий звонок
		`hungUp` - получатель входящего звонка прервал соединение или на телефоне активирована функция "Не беспокоить"
		`missed` - инициатор звонка отменил звонок. Статус устарел, вместо него приходит `declined`
		`declined` - пропущенный звонок или инициатор звонка отменил звонок
`timestamp`	integer	Время наступления события в UNIX-формате
`idMessage`	string	Идентификатор входящего звонка

Поля объекта instanceData

Параметр	Тип	Описание
`idInstance`	integer	Идентификатор инстанса. Размер integer равен int64. Значения лежат в диапазоне от 1 до 10 разрядов
`wid`	string	Идентификатор аккаунта в формате WhatsApp
`typeInstance`	string	Тип мессенджера для инстанса

Статусы звонков

При входящем звонке система формирует по очереди два уведомления:

Первое уведомление со статусом offer, что указывает на получение нового входящего звонка.
Второе уведомление со статусом pickUp, hungUp или declined, в зависимости от исхода звонка.

Сценарий получения уведомлений:

offer + pickUp - успешный входящий звонок, адресат ответил на звонок
offer + hungUp - не отвеченный входящий звонок, адресат прервал соединение или на телефоне активирована функция "Не беспокоить" (положили трубку)
offer + declined - пропущенный входящий звонок, инициатор прервал соединение (звонивший завершил звонок)
offer + declined - пропущенный входящий звонок, приложение завершило соединение из-за таймаута (WhatsApp завершил звонок)

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

{
    "from": "79001234500@c.us",
    "typeWebhook": "incomingCall",
    "instanceData": {
        "idInstance": 1101123456,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
     "status": "pickUp",
     "timestamp": 1617691757,
     "idMessage": "104179EDB7F5328988D8834107EEBE50"
}