Skip to content

Delete Driver Lease

DELETE
/dialer/sessions/driver-lease

CONTACTS NOBODY. Release YOUR driver lease, only if client_id is the current holder.

Answers {released: true|false}; releasing a lease someone else holds is a no-op.

Authorizations

Parameters

Query Parameters

client_id
required

The client releasing its lease.

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/

The client releasing its lease.

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
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