Get a number

GEThttps://api.trillet.ai/partner/v1/tenants/{tenantId}/numbers/{numberId}

Needs resources:read. A number that is not in the tenant returns 404 number_not_found.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

tenantIdstringrequired

The tenant ID.

Pattern: ^[a-fA-F0-9]{24}$

numberIdstringrequired

Pattern: ^[a-fA-F0-9]{24}$

application/json

The number.

objectstringrequired

idstringrequired

Use it as phoneNumberId when binding the number to an agent.

Pattern: ^[a-fA-F0-9]{24}$

tenantIdstringrequired

Pattern: ^[a-fA-F0-9]{24}$

phoneNumberstringrequired

E.164 format.

providerstring | null

typestring | null

externalbooleanrequired

true for numbers you registered yourself.

statusstring | null

agentIdstring | null

callFlowIdstring | null

billingany

Present for numbers bought through Trillet OEM, null for your own numbers.

createdAtstring | null<date-time>