Skip to main content
POST
Send message in a consultation

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Path Parameters

id
string
required

Consultation/conversation ID

Body

application/json
messages
string[]

Array of message texts to send

text
string

Single message text (alternative to messages array)

lastSeenMessageId
string

Newest message id you have seen. Satisfies the read-first gate without a separate read; a stale value is refused.

waitForReply
boolean
default:true

Wait up to ~55s for the next reply and return it inline. On timeout the response carries stillWaiting - the message is already sent, so never re-send.

Response

Message sent

sent
boolean

False on a READ_REQUIRED or PAYMENT_REQUIRED refusal

messagesSent
integer
status
string

Conversation status, or READ_REQUIRED / PAYMENT_REQUIRED on a refusal

reply
object

A message in a consultation

replies
object[]
stillWaiting
boolean

The wait timed out; the message is sent, keep waiting

connected
boolean

A provider joined while waiting (status WITH_PROVIDER)

statusChanged
string

The status the conversation moved to during the wait

paymentRequired
boolean

The send completed triage, so the patient must confirm payment

paymentGate
object

Payment gate information when triage is complete

latestMessageId
string

On READ_REQUIRED, retry with this as lastSeenMessageId

conversation
object

Full conversation details with messages

userMessage
string

Patient-facing wording to relay

agentInstructions
string[]
note
string
nextStep
string

Suggested follow-up call

nextStepArgs
object

Arguments to pass to nextStep