Skip to main content

MessageRead

A single chat message within a dialogue, in either direction. Bot messages may be scheduled for future sending and pass through queued -> sent -> delivered -> read states; user messages are inbound.

idIdrequired

Unique numeric identifier of the record.

contact_idContact Idrequired

ID of the contact this record relates to.

dialogue_idDialogue Idrequired

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

messageMessagerequired

The message text. For messages with attached files this is the LLM-facing text; see file_caption for the user-facing caption.

sideSiderequired

Direction of the message — "bot" (outgoing) or "user" (incoming).

Possible values: [bot, user]

sentSentrequired

Whether the message has been dispatched to the channel.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

prompt_id objectrequired
anyOf
integer
prompt_version_id object
anyOf
integer
prepared_message_id objectrequired
anyOf
integer
ping_config_id objectrequired
anyOf
integer
ping_step_number objectrequired
anyOf
integer
meeting_reminder_step_number objectrequired
anyOf
integer
sent_at objectrequired

When the message was sent (UTC).

anyOf
date-time
sent_confirmation_at objectrequired

When the channel confirmed the send (UTC).

anyOf
date-time
delivered_at object

When the message was delivered to the recipient (UTC).

anyOf
date-time
read_at objectrequired

When the recipient read the message (UTC).

anyOf
date-time
scheduled_at objectrequired

When the message is scheduled to be sent (UTC); null for already-sent or inbound messages.

anyOf
date-time
force_send_nowForce Send Now
Default value: false
is_failedIs Failedrequired

Whether sending ultimately failed after retries.

failed_at objectrequired

When sending was marked failed (UTC).

anyOf
date-time
is_importedIs Imported

Whether the message was imported from history rather than sent/received live.

Default value: false
cancelled_at object

When the scheduled message was cancelled before sending (UTC).

anyOf
date-time
include_in_llm_historyInclude In Llm History

Whether this message is included in the history fed to the LLM.

Default value: true
retry_countRetry Countrequired

Number of send retries attempted.

ext_id objectrequired

The message identifier assigned by the external channel/provider.

anyOf
string
task_id object
anyOf
string
rendered_prompt object
anyOf
string
from_externalFrom External

Whether the message originated from an external system rather than the platform.

Default value: false
is_interruptibleIs Interruptible

Whether a newer incoming user message cancels this (scheduled) message.

Default value: true
is_syncedIs Synced

Whether the message has been synced to the connected CRM.

Default value: false
sync_retry_countSync Retry Count
Default value: 0
waba_template_id objectrequired

For WhatsApp Business API template messages, the template used.

anyOf
integer
waba_paramsstring[]required

Ordered parameter values substituted into the WABA template.

is_outreachIs Outreach

Whether this message is the initial outreach message of a dialogue.

Default value: false
stage_triggered_message_id objectrequired
anyOf
integer
sequence_id objectrequired

Identifier grouping message parts that were split from one logical message.

anyOf
string
llm_run_id objectrequired
anyOf
string
is_queuedIs Queued
Default value: false
reply_on_msg_id objectrequired
anyOf
integer
part_indexPart Indexrequired

Zero-based index of this part within its split sequence.

source_file_idsinteger[]

IDs of files attached to this message.

file_caption object

User-facing caption shown with attached files (while "message" holds the LLM-facing text).

anyOf
string
sender_participant_id object
anyOf
integer
email_from object
anyOf
string
email_tostring[]
email_ccstring[]
log_req_id object
anyOf
string
creator object

What produced the message (e.g. chatbot, inbound_lead_quick_reply, api, ping, initial_outreach).

anyOf
MessageCreator

Possible values: [chatbot, pending_follow_up, human_clarification_follow_up, human_clarification_timeout_follow_up, redirect_follow_up, api, api_bulk, state_tree_action, dialogue_resumer, ping, stage_triggered_message, waba_opener, meetings_reminder, callback_task_reminder, customer_support_resolution_check, customer_support_csi, customer_support_csi_ack, customer_support_closer, input_sanitizer_auto_reply, inbound_lead_quick_reply, inbound_lead_reply_to_start, command, imported_history, phone_warmup, initial_outreach, warm_handoff]

manual_sending_campaign_id object

ID of the manual sending campaign that produced this message, if any.

anyOf
integer
statusStatusrequired

Derived delivery status (e.g. read, delivered, sent-confirmed, failed, cancelled). For user messages this is always "read".

dt_order_key objectrequired
property name* object
anyOf
string
MessageRead
{
  "id": 0,
  "contact_id": 0,
  "dialogue_id": 0,
  "message": "string",
  "side": "bot",
  "sent": true,
  "created_at": "2024-07-29T15:51:28.071Z",
  "prompt_id": 0,
  "prompt_version_id": 0,
  "prepared_message_id": 0,
  "ping_config_id": 0,
  "ping_step_number": 0,
  "meeting_reminder_step_number": 0,
  "sent_at": "2024-07-29T15:51:28.071Z",
  "sent_confirmation_at": "2024-07-29T15:51:28.071Z",
  "delivered_at": "2024-07-29T15:51:28.071Z",
  "read_at": "2024-07-29T15:51:28.071Z",
  "scheduled_at": "2024-07-29T15:51:28.071Z",
  "force_send_now": false,
  "is_failed": true,
  "failed_at": "2024-07-29T15:51:28.071Z",
  "is_imported": false,
  "cancelled_at": "2024-07-29T15:51:28.071Z",
  "include_in_llm_history": true,
  "retry_count": 0,
  "ext_id": "string",
  "task_id": "string",
  "rendered_prompt": "string",
  "from_external": false,
  "is_interruptible": true,
  "is_synced": false,
  "sync_retry_count": 0,
  "waba_template_id": 0,
  "waba_params": [
    "string"
  ],
  "is_outreach": false,
  "stage_triggered_message_id": 0,
  "sequence_id": "string",
  "llm_run_id": "string",
  "is_queued": false,
  "reply_on_msg_id": 0,
  "part_index": 0,
  "source_file_ids": [
    0
  ],
  "file_caption": "string",
  "sender_participant_id": 0,
  "email_from": "string",
  "email_to": [
    "string"
  ],
  "email_cc": [
    "string"
  ],
  "log_req_id": "string",
  "creator": "chatbot",
  "manual_sending_campaign_id": 0,
  "status": "string",
  "dt_order_key": {}
}