List sessions

Returns sessions issued by your account, newest first. Sessions stay listed for three months after creation, whatever their status. Filter by your own client_reference_id to see everything issued for one customer or device. Responses never include token.

Query Parameters
client_reference_id string Possible values: length ≤ 256 Return only sessions created with this reference.
status string Possible values: [pending, active, idle, used, expired, revoked] pending: issued, no stream opened yet, connect window still open active: at least one stream is running idle: reusable token that has been used before, no stream running, connect window still open used: single-use token whose stream has finished; cannot be used again expired: connect window has passed and no stream is running revoked: revoked by you Return only sessions in this state.
created_from date-time Return sessions created at or after this time.
created_to date-time Return sessions created before this time.
page_size integer Possible values: 1 ≤ value ≤ 100 Number of sessions on one page.
page_token string Value of next_page_token from the previous page.

Responses
200 Page of sessions. Schema — OPTIONAL ok boolean Possible values: [true] data object sessions object[] id string Session identifier. Use it to inspect, revoke and report on the session. token string — OPTIONAL Credential the end user connects with. Returned by POST /v2/sessions and GET /v2/sessions/{id} only. intent string Possible values: [s2s, stt, tts] Product the session token is valid for: s2s: speech-to-speech translation stt: speech-to-text tts: text-to-speech A token presented to a different product is refused. connection_type string Possible values: [ws, webrtc] Transport the end user will connect with. webrtc is available for s2s only. A token issued for one transport cannot be used with the other. single_use boolean true if the token opens only one stream in its lifetime. client_reference_id string — OPTIONAL Possible values: length ≤ 256 Your identifier from the create request. status string Possible values: [pending, active, idle, used, expired, revoked] pending: issued, no stream opened yet, connect window still open active: at least one stream is running idle: reusable token that has been used before, no stream running, connect window still open used: single-use token whose stream has finished; cannot be used again expired: connect window has passed and no stream is running revoked: revoked by you created_at date-time When the session was created. connect_by date-time Moment after which the token can no longer open a new stream. max_session_duration_seconds integer — OPTIONAL Duration cap applied to each stream, if one was set. first_connected_at date-time — OPTIONAL When the first stream was opened with this token, or null if none yet. active_stream_count integer Number of streams running with this token. webrtc object — OPTIONAL Present for connection_type: webrtc only. url string WebRTC endpoint the publisher and listeners connect to. room_name string Room the session runs in. subscriber_keys string[] — OPTIONAL Listener tokens, one per requested subscriber. Returned on creation only. next_page_token string — OPTIONAL Token of the next page, or null on the last page.
401
422
500