Skip to content

Which agent answers a number

GET
/voice/numbers/answering-agent

Who picks up when this number is called.

A number lives on the company profile as free text while the agent that answers it is bound on that agent’s identity, so the link is not readable from either side alone. This resolves it.

READ-ONLY by design, and the design is load-bearing: resolving a route for real marks directory members as engaged, so this deliberately does not.

Authorizations

Parameters

Query Parameters

number

The number to resolve, E.164. OPTIONAL: with no main line set yet, omitting it returns the organisation’s receptionists, which is exactly the list to choose one from.

string
""

The number to resolve, E.164. OPTIONAL: with no main line set yet, omitting it returns the organisation’s receptionists, which is exactly the list to choose one from.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a purchase result, a release, or an A2P job.

Open on purpose. A purchase returns the stored row (whose capability and provider-metadata keys differ per provider), a workflow start returns a workflow_id, and the A2P reconcile returns per-number outcomes that grow as carriers add statuses. Pinning it would silently drop whatever the provider reported that this contract had not caught up on.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string