Skip to content

Put Driver Lease

PUT
/dialer/sessions/driver-lease

CONTACTS NOBODY. Grant, refresh or take over YOUR dialer driver lease.

Only one client at a time may drive a user’s dialer. Call this on a timer from the client that is driving; takeover: true moves the lease from another client of the SAME user. Personal key only: the lease belongs to the key’s own user.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Take, refresh or take over the per-user dialer driver lease (“one driver per user”).

object
client_id
required

Stable id of THIS client (a browser tab, the desktop app, your own app).

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
session_id
Any of:
string
<= 128 characters /^[A-Za-z0-9_-]+$/
surface
required

Which kind of client holds the lease.

string
Allowed values: desktop web
takeover

Take the lease from the current holder instead of being refused.

boolean

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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