contact.note.deleted

Используйте contact.note.deleted для обработки этого события на вашей конечной точке Webhook.

Триггеры

Происходит при самостоятельном удалении заметки контакта. При удалении контакта это событие не отправляется для каскадно удаляемых заметок. Подпишитесь на contact.note.deleted, когда будете настраивать конечную точку Webhook. Удаление контакта не вызывает это событие для его каскадно удаляемых заметок. Обрабатывайте id отдельно от contactId.

Синтаксис

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

{
  "id": "<ID>",
  "type": "contact.note.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactNote": {
    "id": "<ID>",
    "contactId": "<CONTACT_ID>",
    "username": "<USERNAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "content": "<CONTENT>",
    "createTime": "<CREATE_TIME>",
    "updateTime": "<UPDATE_TIME>"
  }
}

Параметры

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

Оболочка события

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

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

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

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

contactNote

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Идентификатор заметки. Минимальная длина: `24`. Максимальная длина: `24`. Шаблон: `^[0-9a-fA-F]{24}$`.
`contactId`	string	Да	Идентификатор контакта, которому принадлежит заметка.
`username`	string or null	Да	Имя пользователя контакта, которому принадлежит эта заметка, без начального символа `@`.
`phoneNumber`	string or null	Да	Номер телефона контакта, которому принадлежит эта заметка, в формате E.164.
`content`	string	Да	Текст заметки. Максимальная длина: `500`.
`createTime`	string (date-time)	Нет	Время создания заметки в формате RFC 3339.
`updateTime`	string (date-time)	Нет	Время последнего обновления заметки в формате RFC 3339.

Пример

Ниже представлен пример JSON-тела, доставляемого вашему получателю. Идентификаторы, номера телефонов и другие значения учетной записи приведены для наглядности. Отправляется только при самостоятельном удалении заметки, а не при каскадном удалении контакта.

{
  "id": "evt_3234567890abcdef12345678",
  "type": "contact.note.deleted",
  "apiVersion": "v2",
  "createTime": "2024-01-03T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+12025550124",
    "content": "Customer now prefers afternoon follow-up.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-02T12:00:00.000Z"
  }
}

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

HTTP/1.1 200 OK

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

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

Руководства

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

Webhook reference

Триггеры

Синтаксис

Параметры

Оболочка события

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

contactNote

Пример

​Триггеры

​Синтаксис

​Параметры

​Оболочка события

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

​contactNote

​Пример

Триггеры

Синтаксис

Параметры

Оболочка события

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

contactNote

Пример