ContactRead

Контакт — это один адрес, по которому с лидом связываются в конкретном канале. У лида может быть несколько контактов (например, номер телефона и Telegram-username). Сочетание (contact_type, channel_type, ext_channel_id, channel_vendor) точно определяет, где этот адрес действителен.

idIdrequired

Уникальный числовой идентификатор записи.

lead_idLead Idrequired

Идентификатор лида, к которому относится запись.

product_idProduct Idrequired

Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

customer_id object

Канонический идентификатор клиента на уровне компании, общий для контактов и диалогов, сопоставленных с одним реальным клиентом; null для ещё не сопоставленных записей.

anyOf

• integer
• null

integer

contactContactrequired

Само значение адреса — например, номер телефона, username, chat_id или email.

contact_typeContactTyperequired

Вид адреса — phone, username, chat_id или email.

Possible values: [phone, username, chat_id, email]

channel_type objectrequired

Мессенджер, в котором действителен адрес. null означает универсальный адрес (обычно номер телефона).

anyOf

• string
• null

string

Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

ext_channel_id objectrequired

Необязательная привязка к конкретному внешнему каналу; сужает область применения адреса.

anyOf

• string
• null

string

channel_vendor objectrequired

Необязательный провайдер, к которому привязан адрес.

anyOf

• string
• null

string

Possible values: [wazzup24, self_wz, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]

created_atdate-timerequired

Время создания (UTC, ISO 8601).

is_mainIs Mainrequired

Является ли контакт основным для лида.

crm_id object

Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

anyOf

• string
• null

string

contact_sourceContactSourcerequired

Источник появления контакта (например, api, custom_field, default_field, derived_title).

Possible values: [custom_field, default_field, derived_title, api, unknown]

source_name object

Произвольная метка, описывающая происхождение контакта.

anyOf

• string
• null

string

last_dialogue_id objectrequired

Идентификатор последнего диалога, который вёлся через этот контакт.

anyOf

• integer
• null

integer

skip_routingSkip Routingrequired

Если true, контакт исключается из автоматической маршрутизации исходящих рассылок.

waba_window_open_until objectrequired

Для контактов WhatsApp Business API — когда закрывается текущее 24-часовое окно свободной переписки (UTC).

anyOf

• date-time
• null

date-time

waba_windows_openedWaba Windows Openedrequired

Сколько окон переписки WABA уже было открыто для этого контакта.

ContactRead

{
  "id": 0,
  "lead_id": 0,
  "product_id": 0,
  "customer_id": 0,
  "contact": "string",
  "contact_type": "phone",
  "channel_type": "telegram",
  "ext_channel_id": "string",
  "channel_vendor": "wazzup24",
  "created_at": "2024-07-29T15:51:28.071Z",
  "is_main": true,
  "crm_id": "string",
  "contact_source": "custom_field",
  "source_name": "string",
  "last_dialogue_id": 0,
  "skip_routing": true,
  "waba_window_open_until": "2024-07-29T15:51:28.071Z",
  "waba_windows_opened": 0
}