Skip to main content
GET
Wait for the next reply

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Path Parameters

id
string
required

Consultation/conversation ID

Query Parameters

afterMessageId
string

Await the reply after this message (the last one you have seen)

maxWaitSeconds
integer
default:55

How long one call may block. Defaults to 55 so a plain HTTP client's 60-second timeout is never hit; clamped to 300.

Required range: 5 <= x <= 300

Response

The next reply, several pending replies, or stillWaiting

One of: a single reply, several pending replies, stillWaiting (resume with the same call), connected (a provider joined), or a note that the conversation has nothing pending to wait for.

conversationId
string
status
any
reply
object

A single inbound message or visit event.

replies
object[]

Several replies had already arrived. Relay them in order, then call again with afterMessageId set to the LAST reply's messageId.

stillWaiting
boolean

True when nothing arrived within the window. Call again with the same parameters to resume; no duplicate side effects.

waitedSeconds
integer

With stillWaiting, how long this call blocked.

connected
boolean

True when a provider joined while waiting. Fetch the conversation, then message the provider.

note
string

Why there was nothing to wait for (IDLE, PAYMENT_REQUIRED, EMERGENCY).

nextStep
string
nextStepArgs
object