Skip to content

Add a colleague to the directory

POST
/voice/phone-directory

SPENDS NOTHING. Adds an entry. The organisation is the key’s; a body value is not accepted. Voice answers 400 with its own detail when the row cannot be inserted (for example a duplicate extension).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A colleague the receptionist and the in-call transfer picker can reach.

extension and phone_number are both optional: the number a transfer actually dials is resolved from the work-number inventory first, and the stored phone_number is only the hand-entered override.

object
availability
string
default: available
department
required
string
extension
Any of:
string
is_active
boolean
default: true
phone_number
Any of:
string
user_email
required
string
user_name
required
string

Responses

201

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

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