Skip to content
Home/
REST API Reference
/
/
Conversation stream token

Conversation stream token

A token that lets a contact's client subscribe to a realtime stream of their conversation events.

typestring

String representing the object's type. Always has the value conversation_stream_token.

Value:"conversation_stream_token"
Example:"conversation_stream_token"
expires_atinteger, (date-time)

The time the token expires, as a UNIX timestamp.

Example:1731241200
streamobject

What the client needs to connect to the stream.

{
  "type": "conversation_stream_token",
  "expires_at": 1731241200,
  "stream": {
    "provider": "ably",
    "url": "main.realtime.ably.net",
    "channel": "conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0",
    "token": "<stream token>"
  },
  "links": {
    "self": { … },
    "revoke": { … }
  }
}