Skip to content

Mint Session Ws Ticket

POST
/dialer/sessions/{session_id}/ws-ticket

CONTACTS NOBODY. Mints a one-shot ticket for the session event stream.

The WebSocket itself is not part of this contract - a socket cannot be described as a request/response operation or generated into an SDK method. This mints the ticket that opens one, which IS an ordinary POST.

Authorizations

Parameters

Path Parameters

session_id
required

Session to subscribe to.

string

Session to subscribe to.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one dialer result.

Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string