Примеры Webhook для создания контактов и заметок

Полный каталог на основе схемы см. в разделе все примеры.

Что это такое

Обработка событий contact.created и contact.note.created.

Перед началом работы

Создайте общедоступную конечную точку HTTPS в своем приложении.
Настройте конечную точку Webhook в YCloud для необходимых типов событий.
Обеспечьте безопасное хранение секрета подписи конечной точки.
Сделайте обработку событий идемпотентной.

Как это работает

YCloud отправляет HTTP-запрос POST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и обрабатывайте длительные операции асинхронно.

Запрос

Ниже приведены сценарии запросов, отправляемых на ваш URL Webhook. Используйте id события в качестве идентификатора доставки, а type — для маршрутизации полезной нагрузки.

Ответ

Возвращайте статус 2xx после принятия события.

HTTP/1.1 200 OK

Информацию о настройке конечной точки, проверке подписи и повторных попытках см. в разделе Настройка Webhook.

Срабатывает при создании нового контакта. Полезная нагрузка Webhook содержит полную информацию о созданном контакте.

Пример создания контакта

Запрос

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+16315551111",
    "countryCode": "US",
    "countryName": "United States",
    "email": "john.doe@example.com",
    "sourceType": "api",
    "sourceId": "import_batch_123",
    "sourceUrl": "https://example.com/signup",
    "lastSeen": "2024-01-01T11:59:00.000Z",
    "lastConnectedNumber": "+16315552222",
    "ownerEmail": "owner@example.com",
    "tags": [
      "premium",
      "newsletter"
    ],
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "blocked": false,
    "customAttributes": {
      "company": "YCloud Inc",
      "age": 25
    }
  }
}

Ответ

Подтверждайте доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Полная информация о контакте: объект contactCreated содержит всю доступную информацию о контакте на момент создания.
Пользовательские атрибуты: поле customAttributes содержит любые пользовательские данные, связанные с контактом.
Теги: массив tags содержит любые теги, присвоенные контакту при создании.

Создана заметка к контакту

Используйте contact.note.created при создании заметки к контакту.

Запрос

{
  "id": "evt_1234567890abcdef12345678",
  "type": "contact.note.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactNote": {
    "id": "6a3de646e18f344f743aaa4d",
    "contactId": "1824266594102064128",
    "username": "alice_01",
    "phoneNumber": "+16315551111",
    "content": "Customer prefers follow-up in the morning.",
    "createTime": "2024-01-01T12:00:00.000Z",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Ответ

Подтверждайте доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Используйте contactNote.id для идентификации заметки и contactId для идентификации контакта, которому она принадлежит. Поля username и phoneNumber описывают контакт и могут иметь значение null. Полезная нагрузка содержит снимок заметки, предназначенный для клиента, включая content, без внутренних идентификаторов оператора.

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

Руководства

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

Webhooks

Примеры Webhook для создания контактов и заметок

Что это такое

Перед началом работы

Как это работает

Запрос

Ответ

Пример создания контакта

Запрос

Ответ

Пояснение

Создана заметка к контакту

Запрос

Ответ

Пояснение

​Что это такое

​Перед началом работы

​Как это работает

​Запрос

​Ответ

​Пример создания контакта

​Запрос

​Ответ

​Пояснение

​Создана заметка к контакту

​Запрос

​Ответ

​Пояснение

Что это такое

Перед началом работы

Как это работает

Запрос

Ответ

Пример создания контакта

Запрос

Ответ

Пояснение

Создана заметка к контакту

Запрос

Ответ

Пояснение