Skip to content

Phone numbers

Retrieve a phone number

GET/v1/phone-numbers/{phone_number_id}

Get one phone number by id.

On this page

Headers

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Path parameters

phone_number_idstringRequired

Returns

200 OKSuccessful Response

caller_id_namestring or nullAlways present
capabilitiesarray of stringAlways present
cooldown_entered_atstring or nullMay be absent
cooldown_sourcestring or nullMay be absent

One ofhiyabehavioral

country_codestringAlways present
created_atstringAlways present
forwarding_announcementstring or nullAlways present
forwarding_phonestring or nullAlways present
forwarding_use_org_defaultbooleanMay be absent

Default false

friendly_namestring or nullAlways present
hiya_reputationobject or nullMay be absent
idstringAlways present
inbound_after_hours_ai_enabledbooleanMay be absent

Default false

inbound_agent_idstring or nullAlways present
inbound_routing_modestringAlways present

One ofagentforward

inbound_transfer_phonestring or nullAlways present
inbound_transfer_use_org_defaultbooleanMay be absent

Default false

monthly_cost_centsinteger or nullAlways present
number_typestring or nullAlways present
organization_idstringAlways present
outbound_agent_idstring or nullAlways present
outbound_quarantinedbooleanMay be absent

Default false

phone_numberstringAlways present
pool_idstring or nullMay be absent
pool_namestring or nullMay be absent
pool_stagestringMay be absent

One ofonboardingonboarding_failedreservedialingquarantinereleasing

Default dialing

providerstringMay be absent

One oftelnyxtwiliovonage

Default telnyx

quarantine_confidencenumber or nullMay be absent
quarantine_reasonstring or nullMay be absent
quarantine_sourcestring or nullMay be absent

One ofhiyabehavioralmanualautopilot

quarantined_atstring or nullMay be absent
ready_atstring or nullMay be absent
release_afterstring or nullMay be absent
reputation_levelstring or nullAlways present
reputation_scoreinteger or nullAlways present
reputation_statestringMay be absent

One ofcleancooldown

Default clean

show_logo_on_outboundbooleanMay be absent

Default false

show_logo_opt_outbooleanMay be absent

Default false

sourcestringAlways present
spanish_transfer_phonestring or nullMay be absent
statusstringAlways present
updated_atstringAlways present
verifiedbooleanAlways present

Errors

  • 404PHONE_NUMBER_NOT_FOUND

    No phone number with that id in your organization.

    Retrying will fail the same way. Fix the request, or contact us.

  • 422VALIDATION_ERROR

    A field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.

    Retrying will fail the same way. Fix the request, or contact us.

Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.