Phone numbers
Retrieve a phone number
GET/v1/phone-numbers/{phone_number_id}
Get one phone number by id.
On this page
Headers
AuthorizationstringRequiredApiKey $ENTROVOX_KEY. Keys are issued per organization.Path parameters
phone_number_idstringRequiredReturns
200 OKSuccessful Response
caller_id_namestring or nullAlways presentcapabilitiesarray of stringAlways presentcooldown_entered_atstring or nullMay be absentcooldown_sourcestring or nullMay be absentOne ofhiyabehavioral
country_codestringAlways presentcreated_atstringAlways presentforwarding_announcementstring or nullAlways presentforwarding_phonestring or nullAlways presentforwarding_use_org_defaultbooleanMay be absentDefault false
friendly_namestring or nullAlways presenthiya_reputationobject or nullMay be absentidstringAlways presentinbound_after_hours_ai_enabledbooleanMay be absentDefault false
inbound_agent_idstring or nullAlways presentinbound_routing_modestringAlways presentOne ofagentforward
inbound_transfer_phonestring or nullAlways presentinbound_transfer_use_org_defaultbooleanMay be absentDefault false
monthly_cost_centsinteger or nullAlways presentnumber_typestring or nullAlways presentorganization_idstringAlways presentoutbound_agent_idstring or nullAlways presentoutbound_quarantinedbooleanMay be absentDefault false
phone_numberstringAlways presentpool_idstring or nullMay be absentpool_namestring or nullMay be absentpool_stagestringMay be absentOne ofonboardingonboarding_failedreservedialingquarantinereleasing
Default dialing
providerstringMay be absentOne oftelnyxtwiliovonage
Default telnyx
quarantine_confidencenumber or nullMay be absentquarantine_reasonstring or nullMay be absentquarantine_sourcestring or nullMay be absentOne ofhiyabehavioralmanualautopilot
quarantined_atstring or nullMay be absentready_atstring or nullMay be absentrelease_afterstring or nullMay be absentreputation_levelstring or nullAlways presentreputation_scoreinteger or nullAlways presentreputation_statestringMay be absentOne ofcleancooldown
Default clean
show_logo_on_outboundbooleanMay be absentDefault false
show_logo_opt_outbooleanMay be absentDefault false
sourcestringAlways presentspanish_transfer_phonestring or nullMay be absentstatusstringAlways presentupdated_atstringAlways presentverifiedbooleanAlways presentErrors
- 404
PHONE_NUMBER_NOT_FOUNDNo phone number with that id in your organization.
Retrying will fail the same way. Fix the request, or contact us.
- 422
VALIDATION_ERRORA 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.