Перейти к основному содержимому

MessageRead

Отдельное сообщение в диалоге, в любом направлении. Сообщения бота могут быть запланированы на будущее и проходят состояния queued → sent → delivered → read; сообщения пользователя — входящие.

idIdrequired

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

contact_idContact Idrequired

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

dialogue_idDialogue Idrequired

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

messageMessagerequired

Текст сообщения. Для сообщений с вложенными файлами это текст для LLM; пользовательскую подпись см. в file_caption.

sideSiderequired

Направление сообщения — "bot" (исходящее) или "user" (входящее).

Possible values: [bot, user]

sentSentrequired

Отправлено ли сообщение в канал.

created_atdate-timerequired

Время создания (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

Когда сообщение было отправлено (UTC).

anyOf
date-time
sent_confirmation_at objectrequired

Когда канал подтвердил отправку (UTC).

anyOf
date-time
delivered_at object

Когда сообщение было доставлено получателю (UTC).

anyOf
date-time
read_at objectrequired

Когда получатель прочитал сообщение (UTC).

anyOf
date-time
scheduled_at objectrequired

Когда сообщение запланировано к отправке (UTC); null для уже отправленных или входящих.

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

Окончательно ли не удалась отправка после повторов.

failed_at objectrequired

Когда отправка была помечена как неуспешная (UTC).

anyOf
date-time
is_importedIs Imported

Импортировано ли сообщение из истории, а не отправлено/получено вживую.

Default value: false
cancelled_at object

Когда запланированное сообщение было отменено до отправки (UTC).

anyOf
date-time
include_in_llm_historyInclude In Llm History

Включается ли это сообщение в историю, передаваемую LLM.

Default value: true
retry_countRetry Countrequired

Число выполненных повторных попыток отправки.

ext_id objectrequired

Идентификатор сообщения, присвоенный внешним каналом/провайдером.

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

Возникло ли сообщение из внешней системы, а не на платформе.

Default value: false
is_interruptibleIs Interruptible

Отменяет ли это (запланированное) сообщение более новое входящее сообщение пользователя.

Default value: true
is_syncedIs Synced

Синхронизировано ли сообщение с подключённой CRM.

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

Для шаблонных сообщений WhatsApp Business API — использованный шаблон.

anyOf
integer
waba_paramsstring[]required

Упорядоченные значения параметров, подставляемые в шаблон WABA.

is_outreachIs Outreach

Является ли это первым исходящим сообщением диалога.

Default value: false
stage_triggered_message_id objectrequired
anyOf
integer
sequence_id objectrequired

Идентификатор, объединяющий части сообщения, разбитого из одного логического сообщения.

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

Индекс этой части (с нуля) внутри своей последовательности разбиения.

source_file_idsinteger[]

Идентификаторы файлов, вложенных в сообщение.

file_caption object

Подпись для пользователя, показываемая с вложенными файлами (тогда как поле message содержит текст для LLM).

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

Что породило сообщение (например, 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

Идентификатор кампании ручной рассылки, породившей это сообщение, если применимо.

anyOf
integer
statusStatusrequired

Производный статус доставки (например, read, delivered, sent-confirmed, failed, cancelled). Для сообщений пользователя всегда "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": {}
}