contact.created

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

Триггеры

Происходит при создании контакта. Подпишитесь на contact.created, когда будете настраивать конечную точку Webhook.

Синтаксис

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

{
  "id": "<ID>",
  "type": "contact.created",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "contactCreated": {
    "id": "<ID>",
    "remarkName": "<REMARK_NAME>",
    "nickName": "<NICK_NAME>",
    "realName": "<REAL_NAME>",
    "phoneNumber": "<PHONE_NUMBER>",
    "countryCode": "<COUNTRY_CODE>",
    "countryName": "<COUNTRY_NAME>",
    "email": "<EMAIL>",
    "sourceType": "<SOURCE_TYPE>",
    "sourceId": "<SOURCE_ID>",
    "sourceUrl": "<SOURCE_URL>",
    "lastSeen": "<LAST_SEEN>",
    "lastConnectedNumber": "<LAST_CONNECTED_NUMBER>",
    "ownerEmail": "<OWNER_EMAIL>",
    "tags": [
      "<TAGS>"
    ],
    "createTime": "<CREATE_TIME>",
    "updateTime": "<UPDATE_TIME>",
    "blocked": "<BLOCKED_VALUE>",
    "customAttributes": {
      "attr1": "<ATTR1>",
      "attr2": "<ATTR2>",
      "attr3": "<ATTR3_VALUE>"
    }
  }
}

Параметры

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

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

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

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

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

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

contactCreated

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор объекта.
`remarkName`	string	Нет	Примечание к имени контакта, заданное бизнесом.
`nickName`	string	Нет	Псевдоним контакта.
`realName`	string	Нет	Настоящее имя контакта.
`phoneNumber`	string	Нет	Уникальный номер телефона в формате E.164.
`countryCode`	string	Нет	Двухбуквенный код страны. См. раздел двухбуквенный код страны ISO 3166-1 alpha-2.
`countryName`	string	Нет	Полное название страны.
`email`	string	Нет	Адрес электронной почты контакта. Если указан, адрес электронной почты должен быть уникальным.
`sourceType`	string	Нет	Тип источника, в котором был создан контакт.
`sourceId`	string	Нет	Идентификатор источника, в котором был создан контакт.
`sourceUrl`	string	Нет	URL-адрес источника, в котором был создан контакт.
`lastSeen`	string (date-time)	Нет	Время последней отправки сообщения контактом вашему бизнесу в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.
`lastConnectedNumber`	string	Нет	Номер телефона компании, с которым контакт связывался в последний раз.
`ownerEmail`	string	Нет	Адрес электронной почты владельца контакта.
`tags`	string[]	Нет	Теги контакта.
`createTime`	string (date-time)	Нет	Время создания контакта в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.
`updateTime`	string (date-time)	Нет	Время последнего обновления контакта в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.
`blocked`	boolean	Нет	Указывает, заблокирован ли контакт.
`customAttributes`	object	Нет	Пользовательские атрибуты контакта в виде пар «ключ-значение».

Пример

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

Событие создания контакта

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

{
  "id": "evt_2345678901",
  "type": "contact.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactCreated": {
    "id": "1824266594102064128",
    "remarkName": "Priority customer",
    "nickName": "John Doe",
    "realName": "John Smith",
    "phoneNumber": "+12025550124",
    "countryCode": "US",
    "countryName": "United States",
    "email": "recipient@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": {
      "attr1": "value1",
      "attr2": "value2",
      "attr3": 123
    }
  }
}

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

{
  "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": "+12025550124",
    "countryCode": "US",
    "countryName": "United States",
    "email": "recipient@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
    }
  }
}

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

HTTP/1.1 200 OK

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

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

Руководства

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

Webhook reference

Триггеры

Синтаксис

Параметры

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

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

contactCreated

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​contactCreated

​Пример

Триггеры

Синтаксис

Параметры

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

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

contactCreated

Пример