LeadDispatchAttemptListRead

A dispatch attempt records one outreach step against one of a lead's contacts within a dispatch run — which contact/channel was tried, the resulting dialogue and message, and the outcome.

idIdrequired

Unique numeric identifier of the record.

dispatch_run_idDispatch Run Idrequired

ID of the dispatch run this attempt belongs to.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

lead_idLead Idrequired

ID of the lead this record relates to.

contact_idContact Idrequired

ID of the contact this record relates to.

step_indexStep Indexrequired

Zero-based index of the dispatch step (from the campaign's configured steps) this attempt corresponds to.

contact_typeContactTyperequired

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

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

channel_type object

The messaging platform used for this attempt.

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 object

The specific external channel used, if pinned.

anyOf

• string
• null

string

channel_id objectrequired

ID of the messaging channel this record relates to.

anyOf

• integer
• null

integer

dialogue_id objectrequired

ID of the dialogue (conversation) this record relates to.

anyOf

• integer
• null

integer

message_id objectrequired

ID of the outreach message created for this attempt, if one was sent.

anyOf

• integer
• null

integer

statusLeadDispatchAttemptStatusrequired

Attempt outcome — scheduled, materializing (message generation has been claimed), sent, pending_reply, replied, timed_out, send_failed, cancelled, superseded, or skipped.

Possible values: [scheduled, materializing, sent, pending_reply, replied, timed_out, send_failed, cancelled, superseded, skipped]

reason objectrequired

Human-readable explanation for the current status (e.g. failure reason).

anyOf

• string
• null

string

no_reply_timeout_secondsNo Reply Timeout Secondsrequired

How long to wait for a reply before moving to the next step.

no_send_confirmation_timeout_secondsNo Send Confirmation Timeout Secondsrequired

How long to wait for a send confirmation before treating the send as failed.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

contact object

The contact address that was tried.

anyOf

• string
• null

string

LeadDispatchAttemptListRead

{
  "id": 0,
  "dispatch_run_id": 0,
  "agent_id": 0,
  "lead_id": 0,
  "contact_id": 0,
  "step_index": 0,
  "contact_type": "phone",
  "channel_type": "telegram",
  "ext_channel_id": "string",
  "channel_id": 0,
  "dialogue_id": 0,
  "message_id": 0,
  "status": "scheduled",
  "reason": "string",
  "no_reply_timeout_seconds": 0,
  "no_send_confirmation_timeout_seconds": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "contact": "string"
}