Platform APIPhone Numbers

Get a phone number

Retrieves detailed information about a specific phone number.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

phone_number_slugstringRequired

The phone number slug (phone number without the leading +).

Query parameters

workspacestringRequired
Workspace ID.

Response

200
slugstring

The phone number slug (phone number without the leading +).

address_requirementstring
Address requirement for the phone number.
phone_numberstring
The full phone number in E.164 format.
friendly_namestring

A human-readable name for the phone number.

is_sms_capableboolean
Whether the phone number can send and receive SMS.
is_voice_capableboolean
Whether the phone number can make and receive voice calls.
iso_countrystring
ISO country code for the phone number.
localitystring
The locality or city associated with the phone number.
sip_auth_usernamestring or null
SIP authentication username, if configured.
sip_outbound_proxystring or null
SIP outbound proxy, if configured.
sip_term_uristring
SIP termination URI.
sidstring
Phone number SID from the provider.
provider_namestring
Name of the telephony provider.
regionstring
The region associated with the phone number.
agency_workspace_idstring or null
Agency workspace ID, if applicable.
workspace_idstring
The workspace ID the phone number belongs to.
created_atdatetime
Timestamp when the phone number was created.
updated_atdatetime or null
Timestamp when the phone number was last updated.
assistantslist of strings
List of assistant IDs attached to this phone number.

Errors

400
Bad Request Error