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

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

Бета-версия

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

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

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

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

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

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

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

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

Параметр Тип Описание
typeWebhook string Тип входящего уведомления. Для уведомлений данного типа поле принимает значение outgoingCall
instanceData object Объект данных с информацией об инстансе
timestamp integer Время наступления события в UNIX-формате
idMessage string Идентификатор исходящего звонка
from string Идентификатор чата, в котором был совершен звонок
isVideo boolean Флаг, указывающий, был ли это видеозвонок
duration integer Длительность звонка в секундах
status string Статус звонка. Может принимать следующие значения:
pickUp - на звонок ответил как минимум один участник
hungUp - все участники не приняли звонок или у номера на который был совершен звонок не существует аккаунта WhatsApp
invalid - не получилось дозвониться или обработать статус. Например, номера на который совершался звонок, не существует
participants array Статус звонка по каждому участнику. В личных звонках поле будет содержать только один объект

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

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

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

Поле Тип Описание
id string Идентификатор личного чата участника звонка
status string Статус звонка у конкретного участника. Может принимать следующие значения:
pickUp - собеседник поднял трубку
hungUp - собеседник не принял звонок или номера, на который был совершен звонок, не существует
declined - собеседник отклонил звонок
invalid - не получилось дозвониться или обработать статус

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

{
    "typeWebhook": "outgoingCall",
    "instanceData": {
        "idInstance": 1101ХХХХХХ,
        "wid": "7ХХХХХХХХХХ@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1768888295,
    "idMessage": "AC88AD4AA553FCBB95BEB6BF98F704B1",
    "from": "16381924658ХХХ@c.us",
    "isVideo": false,
    "duration": 0,
    "status": "hungUp",
    "participants": [
        {
            "id": "16381924658ХХХ@c.us",
            "status": "hungUp"
        }
    ]
}