Полный каталог на основе схемы см. в разделе все примеры.
Что это такое
Обработка событийcontact.deleted и contact.note.deleted.
Перед началом работы
- Создайте общедоступную конечную точку HTTPS в своем приложении.
- Настройте конечную точку Webhook в YCloud для необходимых типов событий.
- Надежно сохраните секрет подписи конечной точки.
- Обеспечьте идемпотентность обработки событий.
Как это работает
YCloud отправляет HTTP-запросPOST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и выполняйте длительные операции асинхронно.
Запрос
Ниже приведены сценарии запросов, отправляемых на ваш URL-адрес Webhook. Используйтеid события в качестве идентификатора доставки, а type — для маршрутизации полезной нагрузки.
Ответ
Возвращайте статус2xx после успешного принятия события.
Информацию о настройке конечной точки, проверке подписи и механизме повторных попыток см. в разделе Настройка Webhook.
- URL-адрес конечной точки Webhook должен быть предоставлен вашим сервером, а не YCloud. Обязательно замените URL-адрес на фактический URL-адрес вашей конечной точки Webhook.
- Убедитесь, что ваша конечная точка Webhook настроена на прослушивание соответствующих типов событий. См. также Настройка Webhook, API получения конечной точки Webhook.
Базовый пример удаления контакта
Запрос
Ответ
Подтвердите доставку после надежного сохранения события.Пояснение
- Минимум информации: объект
contactDeletedсодержит только основные сведения:id,nickName,phoneNumberиupdateTime. - Значения Null: поле
nickNameможет иметь значениеnull, если у контакта не был задан псевдоним. - Время обновления: поле
updateTimeуказывает, когда контакт был изменен в последний раз перед удалением. - Идентификатор контакта: поле
idсодержит уникальный идентификатор удаленного контакта для справки. - Номер телефона: поле
phoneNumberприсутствует всегда и отформатировано в стандарте E.164.
Удаление заметки контакта
Используйтеcontact.note.deleted при удалении заметки контакта.
Запрос
Ответ
Подтвердите доставку после надежного сохранения события.Пояснение
ИспользуйтеcontactNote.id для идентификации заметки и contactId для идентификации контакта, которому она принадлежит. Поля username и phoneNumber описывают контакт и могут иметь значение null. Полезная нагрузка содержит снимок заметки, видимый клиенту, включая content, без внутренних идентификаторов операторов. Это событие генерируется при независимом удалении заметки. При удалении контакта оно не генерируется для каждой каскадно удаляемой заметки.
