ScheduleMessageRequest

Request to schedule a bot message in an existing dialogue. Used by the platform's dialogue UI and by n8n callbacks. The text may be split into multiple parts and is subject to working-hours scheduling and typing delays unless disabled.

dialogue_idDialogue Idrequired

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

messageMessagerequired

The message text to send. For file messages this is used as the default file caption when file_caption is omitted.

source_file_idsinteger[]

IDs of product files to attach to this manual message.

file_caption object

Optional user-facing caption for attached files. If omitted, message is used as the caption.

anyOf

• string
• null

string

send_not_before object

Earliest time the message may be sent (UTC); scheduling still respects working hours.

anyOf

• date-time
• null

date-time

reply_on_msg_id object

If a newer user message than this id arrives before sending, the scheduled message is cancelled.

anyOf

• integer
• null

integer

delay_enabledDelay Enabled

Apply a human-like typing delay before sending. Defaults to true.

Default value: true

schedule_enabledSchedule Enabled

Respect the agent's working-hours schedule. Defaults to true.

Default value: true

split object

Whether to split long text into multiple messages. Null uses the default behavior.

anyOf

• boolean
• null

boolean

debounce_guardDebounce Guard

Perform one stale-reply check before scheduling and skip if a newer user message exists. Defaults to true.

Default value: true

prompt_id object

Optional prompt this message was generated from (for attribution).

anyOf

• integer
• null

integer

prepared_message_id object

Optional prepared-message template this message came from (for attribution).

anyOf

• integer
• null

integer

ping_config_id object

Optional ping config this message belongs to (for attribution).

anyOf

• integer
• null

integer

ping_step_number object

Optional ping step number this message belongs to.

anyOf

• integer
• null

integer

is_interruptibleIs Interruptible

Whether a newer incoming user message cancels this scheduled message. Defaults to true.

Default value: true

ScheduleMessageRequest

{
  "dialogue_id": 0,
  "message": "string",
  "source_file_ids": [
    0
  ],
  "file_caption": "string",
  "send_not_before": "2024-07-29T15:51:28.071Z",
  "reply_on_msg_id": 0,
  "delay_enabled": true,
  "schedule_enabled": true,
  "split": true,
  "debounce_guard": true,
  "prompt_id": 0,
  "prepared_message_id": 0,
  "ping_config_id": 0,
  "ping_step_number": 0,
  "is_interruptible": true
}