Sign in

v2

latestOpenAPI 3.1.02026-08-05100545344.4 KB
phoneNumbers

Get a phone number

Retrieves detailed information about a specific phone number.

get/numbers/{phone_number_slug}

Path parameters

phone_number_slugstring required

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

Query parameters

workspacestring required

Workspace ID.

Headers

Authorizationstring required

Bearer authentication

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 nullable

SIP authentication username, if configured.

sip_outbound_proxystring nullable

SIP outbound proxy, if configured.

sip_term_uristring

SIP termination URI.

uac_enabledboolean

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

uac_register_expiresinteger nullable

SIP registration refresh interval in seconds when registration is enabled.

sidstring

Phone number SID from the provider.

provider_namestring

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

regionstring

The region associated with the phone number.

is_availableboolean

Whether the number is available for inbound assignment.

agency_workspace_idstring nullable

Agency workspace ID, if applicable.

workspace_idstring

The workspace ID the phone number belongs to.

created_atstring date-time

Timestamp when the phone number was created.

updated_atstring date-time nullable

Timestamp when the phone number was last updated.

assistantsstring[]

List of assistant IDs attached to this phone number.