Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Query Parameters

id
string | null

The phone number's id: the id from the list for this resource. Return this one number with its outbound calling setup options.

include
string | null

With id: a comma list of history (recent texts and calls), usage (what uses the number), alpha_sender and documents (what the carrier still needs).

view
enum<string> | null

available searches numbers you can buy, with prices (country_code, phone_number_type, features, search_by, search_value, number_pattern_type, number_pattern, consecutive, limit); requirements shows what the carrier needs for one number (phone_number).

Available options:
available,
requirements

Response

Successful Response

id
string
required

The phone number's id. Pass it to any endpoint that takes number_id.

number
string
required

Number returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

assigned_agent_id
string | null

The voice agent this is assigned to: an id from List or get agents.

capability_readiness
Capability Readiness · object

Capability readiness returned by the Sendora API.

inbound_agent_id
string | null

The voice agent that answers incoming calls: an id from List or get agents.

inbound_agent_name
string | null

Inbound agent name returned by the Sendora API.

provisioning_state
string | null

Provisioning state returned by the Sendora API.

source
string | null

Source returned by the Sendora API.

supports_mms
boolean | null

Supports mms returned by the Sendora API.

supports_sms
boolean | null

Supports sms returned by the Sendora API.

supports_voice
boolean | null

Supports voice returned by the Sendora API.