[go: up one dir, main page]
Перейти к содержанию

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

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

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

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

  1. Через личный кабинет включить настройку Получать уведомления о звонках

  2. Через метод SetSettings включить настройку incomingCallWebhook

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

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

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

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

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

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

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

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

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

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

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

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