Cossistant Logocossistant

Report a visitor typing state

arrow-leftPreviousNextarrow-right

Emit a typing indicator event for the visitor. Either visitorId must be provided via body or headers.

POST
/v1/conversations/{conversationId}/typing

Authorization

Path Parameters

conversationIdstring

The ID of the conversation receiving the typing update

Header Parameters

X-Public-Key?string

Public API key for browser-based authentication. Can only be used from whitelisted domains. Format: pk_[live|test]_...

Match^pk_(live|test)_[a-f0-9]{64}$
X-Visitor-Id?string

Visitor ID from localStorage.

Match^[0-9A-HJKMNP-TV-Z]{26}$

Request Body

isTypingboolean

Whether the visitor is currently typing

visitorPreview?string

Optional preview of the visitor's message while typing. Only processed when the visitor is typing.

Lengthlength <= 2000
visitorId?string

Visitor ID associated with the conversation. Optional if provided via the X-Visitor-Id header.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.cossistant.com/v1/v1/conversations/string/typing" \  -H "Content-Type: application/json" \  -d '{    "isTyping": true  }'
{
  "conversationId": "string",
  "isTyping": true,
  "visitorPreview": "string",
  "sentAt": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
arrow-left Get conversation timeline items GETSend a message (timeline item) to a conversation POST arrow-right