ContactRead

A contact is a single address through which a lead is reached on a messaging channel. A lead can have several contacts (e.g. a phone number and a Telegram username). The (contact_type, channel_type, ext_channel_id, channel_vendor) combination defines exactly where the address is valid.

idIdrequired

Unique numeric identifier of the record.

lead_idLead Idrequired

ID of the lead this record relates to.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

customer_id object

Canonical company-level customer ID shared by contacts and dialogues resolved as the same real customer; null for records not yet resolved.

anyOf

• integer
• null

integer

contactContactrequired

The address value itself — e.g. a phone number, a username, a chat id, or an email.

contact_typeContactTyperequired

The kind of address — phone, username, chat_id, or email.

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

channel_type objectrequired

The messaging platform the address is valid on. Null means universal (typically a phone number).

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

Optional binding to a specific external channel; narrows where the address is used.

anyOf

• string
• null

string

channel_vendor objectrequired

Optional messaging-provider vendor the address is pinned to.

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

Creation time (UTC, ISO 8601).

is_mainIs Mainrequired

Whether this is the lead's primary contact.

crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf

• string
• null

string

contact_sourceContactSourcerequired

Where this contact originated (e.g. api, custom_field, default_field, derived_title).

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

source_name object

Free-form label describing the origin of the contact.

anyOf

• string
• null

string

last_dialogue_id objectrequired

ID of the most recent dialogue conducted through this contact.

anyOf

• integer
• null

integer

skip_routingSkip Routingrequired

When true, the contact is excluded from automatic outreach routing.

waba_window_open_until objectrequired

For WhatsApp Business API contacts, when the current 24-hour free-form messaging window closes (UTC).

anyOf

• date-time
• null

date-time

waba_windows_openedWaba Windows Openedrequired

Count of WABA messaging windows opened for this contact so far.

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
}