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"
}
'
import requests

url = "https://api.topcalls.ai/v1/phone-numbers"

payload = {
"number": "+18005551234",
"voip_carrier_sid": "660e8400-e29b-41d4-a716-446655440001",
"label": "Main Line"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '+18005551234',
voip_carrier_sid: '660e8400-e29b-41d4-a716-446655440001',
label: 'Main Line'
})
};

fetch('https://api.topcalls.ai/v1/phone-numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topcalls.ai/v1/phone-numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '+18005551234',
'voip_carrier_sid' => '660e8400-e29b-41d4-a716-446655440001',
'label' => 'Main Line'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.topcalls.ai/v1/phone-numbers"

payload := strings.NewReader("{\n \"number\": \"+18005551234\",\n \"voip_carrier_sid\": \"660e8400-e29b-41d4-a716-446655440001\",\n \"label\": \"Main Line\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.topcalls.ai/v1/phone-numbers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"+18005551234\",\n \"voip_carrier_sid\": \"660e8400-e29b-41d4-a716-446655440001\",\n \"label\": \"Main Line\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.topcalls.ai/v1/phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"+18005551234\",\n \"voip_carrier_sid\": \"660e8400-e29b-41d4-a716-446655440001\",\n \"label\": \"Main Line\"\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid or missing API key"
}
{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope: calls:write"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}

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; 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>