PaginatedResponse[MessageRead]
items object[]required
Unique numeric identifier of the record.
ID of the contact this record relates to.
ID of the dialogue (conversation) this record relates to.
The message text. For messages with attached files this is the LLM-facing text; see file_caption for the user-facing caption.
Direction of the message — "bot" (outgoing) or "user" (incoming).
Possible values: [bot, user]
Whether the message has been dispatched to the channel.
Creation time (UTC, ISO 8601).
prompt_id objectrequired
- integer
- null
prompt_version_id object
- integer
- null
prepared_message_id objectrequired
- integer
- null
ping_config_id objectrequired
- integer
- null
ping_step_number objectrequired
- integer
- null
meeting_reminder_step_number objectrequired
- integer
- null
sent_at objectrequired
When the message was sent (UTC).
- date-time
- null
sent_confirmation_at objectrequired
When the channel confirmed the send (UTC).
- date-time
- null
delivered_at object
When the message was delivered to the recipient (UTC).
- date-time
- null
read_at objectrequired
When the recipient read the message (UTC).
- date-time
- null
scheduled_at objectrequired
When the message is scheduled to be sent (UTC); null for already-sent or inbound messages.
- date-time
- null
falseWhether sending ultimately failed after retries.
failed_at objectrequired
When sending was marked failed (UTC).
- date-time
- null
Whether the message was imported from history rather than sent/received live.
falsecancelled_at object
When the scheduled message was cancelled before sending (UTC).
- date-time
- null
Whether this message is included in the history fed to the LLM.
trueNumber of send retries attempted.
ext_id objectrequired
The message identifier assigned by the external channel/provider.
- string
- null
task_id object
- string
- null
rendered_prompt object
- string
- null
Whether the message originated from an external system rather than the platform.
falseWhether a newer incoming user message cancels this (scheduled) message.
trueWhether the message has been synced to the connected CRM.
false0waba_template_id objectrequired
For WhatsApp Business API template messages, the template used.
- integer
- null
Ordered parameter values substituted into the WABA template.
Whether this message is the initial outreach message of a dialogue.
falsestage_triggered_message_id objectrequired
- integer
- null
sequence_id objectrequired
Identifier grouping message parts that were split from one logical message.
- string
- null
llm_run_id objectrequired
- string
- null
falsereply_on_msg_id objectrequired
- integer
- null
Zero-based index of this part within its split sequence.
IDs of files attached to this message.
file_caption object
User-facing caption shown with attached files (while "message" holds the LLM-facing text).
- string
- null
sender_participant_id object
- integer
- null
email_from object
- string
- null
log_req_id object
- string
- null
creator object
What produced the message (e.g. chatbot, inbound_lead_quick_reply, api, ping, initial_outreach).
- MessageCreator
- null
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.
- integer
- null
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
- string
- date-time
{
"items": [
{
"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": {}
}
],
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}