Skip to main content
POST
Publish session typing

Path Parameters

tenantID
string<uuid>
required

The tenant of the conversation.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
sessionID
string<uuid>
required

The session where the typing indicator is shown.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
action
enum<string>
required

start shows the indicator; stop clears it on the channels that support it (WebChat).

Available options:
start,
stop
messageID
string<uuid>

Contact message being answered. Omit it to use the latest message the contact sent in the session; when sent, it must be that message.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Response for status 202.

action
enum<string>
required

The action received.

Available options:
start,
stop
hasExternalID
boolean
required

false when that message has no channel id: only the Talqui app shows the indicator.

messageID
string<uuid>
required

The contact message the indicator was anchored to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
published
boolean
required

false when the call fell inside the throttle window and nothing was sent.

reason
enum<string>

Why nothing was published, when published is false.

Available options:
throttled