Dialer

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

put/dialer/sessions/driver-lease

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/dialer/sessions/driver-lease
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

client_idstring required

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

surface'desktop' | 'web' required

Which kind of client holds the lease.

session_idstring nullable

The dialer session this client is driving, echoed back to other clients as the holder.

takeoverboolean

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

Response

Successful Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.