Skip to main content
POST
Send a customer message to an assistant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenantId
string
required

Tenant-scoped path ID; must be nonempty, cannot contain slash, and cannot be . or .. .

Minimum string length: 1
botId
string
required

Tenant-scoped path ID; must be nonempty, cannot contain slash, and cannot be . or .. .

Minimum string length: 1

Body

application/json

All other root fields are arbitrary business input and are preserved. No business-key allowlist.

conversationId
string
required

Must contain non-whitespace text; original value is preserved.

Minimum string length: 1
Pattern: \S
message
string
required

Must contain non-whitespace text; original value is preserved.

Minimum string length: 1
Pattern: \S
messageId
string | null

Nonempty caller message ID; omitted/null generates an ID.

Minimum string length: 1
Pattern: \S
context
object

Arbitrary business fields; context wins over duplicate business root keys. Null/arrays are invalid.

Response

Public assistant reply, tags and handoff outcome; partial/empty text and retained-handoff null text are valid.

conversationId
string
required
messageId
string
required
state
enum<string>
required
Available options:
active,
handed_off
handoff
boolean
required
message
string | null
required

Public plain text, possibly partial/empty; null for a retained completed handoff.

tags
string[]
required

Includes c7o; completed handoff includes c7o_handoff.

screenPopComment
string

Present on a newly processed handoff.

scriptResult
object

Ticket Fields Script JSON result on a newly processed handoff.