PLATFORM APIPhone Numbers

Get a phone number

View as Markdown
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
slugstringOptional

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

address_requirementstringOptional
Address requirement for the phone number.
phone_numberstringOptional
The full phone number in E.164 format.
friendly_namestringOptional

A human-readable name for the phone number.

is_sms_capablebooleanOptional
Whether the phone number can send and receive SMS.
is_voice_capablebooleanOptional
Whether the phone number can make and receive voice calls.
iso_countrystringOptional
ISO country code for the phone number.
localitystringOptional
The locality or city associated with the phone number.
sip_auth_usernamestring or nullOptional
SIP authentication username, if configured.
sip_outbound_proxystring or nullOptional
SIP outbound proxy, if configured.
sip_term_uristringOptional
SIP termination URI.
uac_enabledbooleanOptional

Whether outbound SIP registration (REGISTER) is enabled for this number.

uac_register_expiresinteger or nullOptional60-3600
SIP registration refresh interval in seconds when registration is enabled.
sidstringOptional
Phone number SID from the provider.
provider_namestringOptional

Name of the telephony provider. Common values include twilio, telnyx, vonage, ring_central, ringcx, custom, zoom, and five9.

regionstringOptional
The region associated with the phone number.
is_availablebooleanOptional
Whether the number is available for inbound assignment.
agency_workspace_idstring or nullOptional
Agency workspace ID, if applicable.
workspace_idstringOptional
The workspace ID the phone number belongs to.
created_atdatetimeOptional
Timestamp when the phone number was created.
updated_atdatetime or nullOptional
Timestamp when the phone number was last updated.
assistantslist of stringsOptional
List of assistant IDs attached to this phone number.

Errors

400
Bad Request Error