Skip to content

Read Dialer Preferences

GET
/dialer/settings/preferences/{user_email}

CONTACTS NOBODY. One rep’s dialer preferences.

The app’s path is /preferences/{org_id}/{user_email} and its handler reads whichever organisation the path names. The org segment is NOT published - it comes from the key - so this cannot read another tenant’s configuration.

Voice additionally refuses to read a rep other than the authenticated one (dialer_settings.py:23-41). An organisation API key is not a rep, so it supplies the rep the caller named: the tenant boundary holds, the rep-versus-rep boundary does not apply to an org credential.

Authorizations

Parameters

Path Parameters

user_email
required

The rep whose preferences to read.

string

The rep whose preferences to read.

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