List the phone numbers this account owns
Returns the phone numbers this account owns, newest first, as a { object: "list", data } array.
Returns the phone numbers this account owns, newest first, as a { object: "list", data } array. Released numbers are excluded by default; pass includeReleased=true to include soft-deleted rows kept for the audit trail. Each number carries its status (active, pending, or released), capabilities, monthlyCostUsd, setupCostUsd, any regulatory requirements, the inboxId/agentId it is bound to, and its inbound agent settings (inboundInstructions, inboundGreeting, inboundVoice, inboundLanguage). This endpoint is not cursor-paginated — it always returns the most recent 100. Requires the phone:read scope.
Scope: phone:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeReleased | boolean | no | Include numbers that were released back to the provider pool. |
Response
200 Success. Body: application/json, PhoneNumberListResponse.
| Field | Type | Required | Description |
|---|---|---|---|
object | "list" | yes | |
data | array of PhoneNumber | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Browse the Telegram voice catalog
Returns a page of voices for Telegram voice messages, ordered by popularity (most popular first), as a data array.
Provision a phone number
Provisions the exact number a prior available search returned, passed as phoneNumber in E.164, and starts recurring monthly billing for it.