Skip to main content
POST
/
v1
/
phone-numbers
Add phone number
curl --request POST \
  --url https://api.topcalls.ai/v1/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "+18005551234",
  "voip_carrier_sid": "660e8400-e29b-41d4-a716-446655440001",
  "label": "Main Line"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "<string>",
  "voip_carrier_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier_name": "<string>",
  "phone_number_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.topcalls.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

​
Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Body

application/json
​
number
string
required

Phone number in E.164 format (also validated as dialable by libphonenumber-js — country codes that don't exist are rejected)

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+18005551234"

​
voip_carrier_sid
string<uuid>

Carrier UUID (defaults to account/system default)

​
label
string

User-friendly label

Maximum string length: 100

Response

Phone number added successfully

​
id
string<uuid>

Phone number UUID

​
number
string

Phone number in E.164 format

​
voip_carrier_sid
string<uuid>

Carrier UUID used

​
carrier_name
string

Carrier display name

​
source
enum<string>

Phone number source

Available options:
topcalls,
byoc
​
phone_number_sid
string<uuid>

Provisioned phone number ID in the telephony system

​
status
enum<string>

Initial status

Available options:
active,
pending
​
label
string | null

User-friendly label

​
account_id
string<uuid>

Account UUID

​
created_at
string<date-time>