whatsapp.call.terminate

Используйте whatsapp.call.terminate для обработки этого события на вашей конечной точке веб-перехватчика.

Триггеры

Происходит при завершении звонка WhatsApp. Подпишитесь на whatsapp.call.terminate, когда будете настраивать конечную точку веб-перехватчика.

Синтаксис

YCloud отправляет HTTP-запрос POST на настроенный вами URL Webhook. В приведенной структуре показан один из вариантов полезной нагрузки. Значения в угловых скобках являются заполнителями; их типы перечислены в разделе Параметры. Необязательные поля и другие варианты описаны ниже.

{
  "id": "<ID>",
  "type": "whatsapp.call.terminate",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "callingTerminate": {
    "id": "<ID>",
    "wacid": "<WACID>",
    "phoneId": "<PHONE_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "direction": "<DIRECTION>",
    "startTime": "<START_TIME_VALUE>",
    "endTime": "<END_TIME_VALUE>",
    "duration": "<DURATION_VALUE>",
    "status": "<STATUS>"
  }
}

Параметры

Проверьте HTTP-заголовок YCloud-Signature перед обработкой тела JSON. См. раздел проверка подписи.

Конверт события

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `whatsapp.call.terminate`.
`apiVersion`	string	Да	Версия API, используемая для формирования этого события.
`createTime`	string (date-time)	Да	Время создания этого события в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

Полезная нагрузка события

Параметр	Тип	Обязательный	Описание
`callingTerminate`	object	Нет	Полезная нагрузка `callingTerminate` для конкретного события.

Четыре общих поля конверта являются обязательными. Поля полезной нагрузки зависят от варианта события. В каждой таблице объектов статус Обязательный применяется, когда присутствует его родительский объект. Необязательные поля могут быть опущены; наличие в примере не делает поле обязательным.

callingTerminate

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события звонка.
`wacid`	string	Да	Идентификатор звонка WhatsApp. Этот идентификатор уникально определяет сеанс звонка.
`phoneId`	string	Нет	Идентификатор номера телефона WhatsApp Business.
`from`	string	Нет	Номер телефона звонящего в формате E.164.
`fromUserId`	string	Нет	Идентификатор пользователя звонящего в рамках WhatsApp Business (BSUID) для звонков, инициированных клиентом.
`fromParentUserId`	string	Нет	Идентификатор родительского пользователя звонящего в рамках WhatsApp Business для звонков, инициированных клиентом.
`to`	string	Нет	Номер телефона принимающей стороны в формате E.164.
`toUserId`	string	Нет	Идентификатор принимающей стороны в рамках WhatsApp Business (BSUID) для звонков, инициированных компанией.
`toParentUserId`	string	Нет	Идентификатор родительского пользователя принимающей стороны в рамках WhatsApp Business для звонков, инициированных компанией.
`customerProfile`	object	Нет	Информация о профиле клиента, включая имя пользователя WhatsApp, если оно доступно.
`direction`	string	Нет	Направление звонка. `USER_INITIATED`: звонок инициирован клиентом в адрес компании. `BUSINESS_INITIATED`: звонок инициирован компанией в адрес клиента.
`startTime`	integer (int64)	Нет	Время начала звонка в миллисекундах временной метки Unix.
`endTime`	integer (int64)	Нет	Время окончания звонка в миллисекундах временной метки Unix.
`duration`	integer (int64)	Нет	Длительность звонка в секундах.
`status`	string	Нет	Финальный статус звонка. `COMPLETED`: звонок был успешно завершен. `FAILED`: произошел сбой звонка из-за ошибки.
`errorCode`	string	Нет	Код ошибки, если статус вызова — `FAILED`. Числовая строка, представляющая ошибку.

callingTerminate.customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя аккаунта WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

Пример

Следующий JSON представляет собой тело запроса, доставленное вашему получателю. Идентификаторы, номера телефонов и другие значения аккаунта приведены в качестве примера.

Событие завершения вызова WhatsApp

Пример полезной нагрузки при завершении вызова WhatsApp

{
  "id": "evt_6757b889a5a42d369ef48481",
  "type": "whatsapp.call.terminate",
  "apiVersion": "v2",
  "createTime": "2024-12-10T03:42:01.822Z",
  "callingTerminate": {
    "id": "6757b889960b25543b9ecc67",
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABIYIEFENjB",
    "phoneId": "461269257068832",
    "from": "+12025550124",
    "to": "+12025550123",
    "direction": "USER_INITIATED",
    "startTime": 1733734738000,
    "endTime": 1733734771000,
    "duration": 33,
    "status": "COMPLETED"
  }
}

Вызов завершен

{
  "id": "evt_6757b889a5a42d369ef48481",
  "type": "whatsapp.call.terminate",
  "apiVersion": "v2",
  "createTime": "2024-12-10T03:42:01.822Z",
  "callingTerminate": {
    "id": "6757b889960b25543b9ecc67",
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTE",
    "phoneId": "461269257068832",
    "from": "+12025550124",
    "fromUserId": "ID.13491208655302741918",
    "fromParentUserId": "ID.11815799212886844830",
    "to": "+12025550123",
    "direction": "USER_INITIATED",
    "startTime": 1733734738000,
    "endTime": 1733734771000,
    "duration": 33,
    "status": "COMPLETED"
  }
}

Сбой вызова

{
  "id": "evt_675907f431c55113a751d0e7",
  "type": "whatsapp.call.terminate",
  "apiVersion": "v2",
  "createTime": "2024-12-11T03:33:08.679Z",
  "callingTerminate": {
    "id": "675907a13ae4a901f05fee95",
    "wacid": "wacid.HBgNODYxNTE1NzEzNzYyM",
    "phoneId": "461269257068832",
    "from": "+12025550124",
    "fromUserId": "ID.13491208655302741918",
    "fromParentUserId": "ID.11815799212886844830",
    "to": "+12025550123",
    "direction": "USER_INITIATED",
    "startTime": 1733826484000,
    "endTime": 1733826637000,
    "duration": 30,
    "status": "FAILED",
    "errorCode": "131000"
  }
}

После проверки подписи и надежного сохранения события верните ответ 2xx. Длительные операции обрабатывайте асинхронно.

HTTP/1.1 200 OK

Пошаговые сценарии см. в разделе примеры с пояснениями.

Начало работы

Руководства

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

Webhook reference

whatsapp.call.terminate

Триггеры

Синтаксис

Параметры

Конверт события

Полезная нагрузка события

callingTerminate

Пример

​Триггеры

​Синтаксис

​Параметры

​Конверт события

​Полезная нагрузка события

​callingTerminate

​Пример

Триггеры

Синтаксис

Параметры

Конверт события

Полезная нагрузка события

callingTerminate

Пример