Phone Numbers
Buy Phone Number
Buy a number onto the carrier account; bind it with
POST /v1/phone-numbers. Admin only. Irreversible on the carrier side:
the number stays on the account (and is billed) until released.
POST
/
v1
/
phone-numbers
/
purchase
Buy Phone Number
curl --request POST \
--url https://api.example.com/v1/phone-numbers/purchase \
--header 'Content-Type: application/json' \
--data '
{
"e164_number": "<string>",
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"carrier": "twilio"
}
'import requests
url = "https://api.example.com/v1/phone-numbers/purchase"
payload = {
"e164_number": "<string>",
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"carrier": "twilio"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
e164_number: '<string>',
twilio_account_sid: '<string>',
twilio_auth_token: '<string>',
carrier: 'twilio'
})
};
fetch('https://api.example.com/v1/phone-numbers/purchase', 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.example.com/v1/phone-numbers/purchase",
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([
'e164_number' => '<string>',
'twilio_account_sid' => '<string>',
'twilio_auth_token' => '<string>',
'carrier' => 'twilio'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/phone-numbers/purchase"
payload := strings.NewReader("{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/phone-numbers/purchase")
.header("Content-Type", "application/json")
.body("{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/phone-numbers/purchase")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Buy a number a search returned. On Twilio, the account it is bought on is the pair given here, else the platform's TWILIO_* account; bind the number with the same pair.
Response
Successful Response
The response is of type Response Buy Phone Number V1 Phone Numbers Purchase Post · object.
Was this page helpful?
⌘I
Buy Phone Number
curl --request POST \
--url https://api.example.com/v1/phone-numbers/purchase \
--header 'Content-Type: application/json' \
--data '
{
"e164_number": "<string>",
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"carrier": "twilio"
}
'import requests
url = "https://api.example.com/v1/phone-numbers/purchase"
payload = {
"e164_number": "<string>",
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>",
"carrier": "twilio"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
e164_number: '<string>',
twilio_account_sid: '<string>',
twilio_auth_token: '<string>',
carrier: 'twilio'
})
};
fetch('https://api.example.com/v1/phone-numbers/purchase', 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.example.com/v1/phone-numbers/purchase",
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([
'e164_number' => '<string>',
'twilio_account_sid' => '<string>',
'twilio_auth_token' => '<string>',
'carrier' => 'twilio'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/phone-numbers/purchase"
payload := strings.NewReader("{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/phone-numbers/purchase")
.header("Content-Type", "application/json")
.body("{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/phone-numbers/purchase")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"e164_number\": \"<string>\",\n \"twilio_account_sid\": \"<string>\",\n \"twilio_auth_token\": \"<string>\",\n \"carrier\": \"twilio\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}