Skip to navigation
API referencePhone Numbers

Read assignments and setup status

A stored assignment is not proof provider routing is ready.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

number_idstringRequired1-128 characters
Resource identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
ETagstringOptional
Strong number revision. Use for number assignment edits.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

Read assignments and setup status.
idstring<=128 characters
Opaque number identifier. Do not parse its contents.
numberstringformat: "^\+[1-9][0-9]{7,14}$"
labelstring or null
providerstring
revisionstring
supports_inboundboolean
supports_outboundboolean
inbound_agent_idstring or null<=128 characters
inbound_setupstring

Open response vocabulary. Preserve unknown values; never assume they mean success.

next_actionstring or null
Safe setup guidance, never a callback secret or signed URL.
outbound_agent_idslist of strings
outbound_primary_agent_idslist of stringsOptional

The agents, among outbound_agent_ids, whose primary outbound number this is. An agent has at most one primary: the first number assigned, then the oldest remaining one when it is removed. An agent whose numbers predate this field has none until its next outbound assignment change. createCall without from_number_id dials from it when the agent has several numbers.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error