Buy a phone number
curl --request POST \
--url https://api.brilo.ai/v1/phone_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"accept_monthly_price": 1,
"phone_number": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.brilo.ai/v1/phone_numbers"
payload = {
"accept_monthly_price": 1,
"phone_number": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
accept_monthly_price: 1,
phone_number: '<string>',
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.brilo.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.brilo.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([
'accept_monthly_price' => 1,
'phone_number' => '<string>',
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.brilo.ai/v1/phone_numbers"
payload := strings.NewReader("{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.brilo.ai/v1/phone_numbers")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brilo.ai/v1/phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"created_at": "<string>",
"currency": "<string>",
"failure": {
"error_code": "<string>",
"message": "<string>"
},
"id": "<string>",
"imported": true,
"managed_by_plan": true,
"monthly_price": 123,
"phone_number": "<string>",
"refunded": true,
"release_at": "<string>",
"revision": "<string>",
"status": "provisioning",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
},
"try_it": {},
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}Phone numbers
Buy a phone number
Buys a number from search for its monthly price. accept_monthly_price must equal the current price, so nothing is bought at a price the owner did not see. Answers 202 with status: provisioning and an id that stays the same once the number is active; poll it, or pass ?wait= seconds (at most 30). With agent_id the number answers for that agent once active. At most 5 a day per workspace through the API; paired-assistant keys cannot buy.
POST
/
phone_numbers
Buy a phone number
curl --request POST \
--url https://api.brilo.ai/v1/phone_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"accept_monthly_price": 1,
"phone_number": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.brilo.ai/v1/phone_numbers"
payload = {
"accept_monthly_price": 1,
"phone_number": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
accept_monthly_price: 1,
phone_number: '<string>',
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.brilo.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.brilo.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([
'accept_monthly_price' => 1,
'phone_number' => '<string>',
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.brilo.ai/v1/phone_numbers"
payload := strings.NewReader("{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.brilo.ai/v1/phone_numbers")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brilo.ai/v1/phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accept_monthly_price\": 1,\n \"phone_number\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"created_at": "<string>",
"currency": "<string>",
"failure": {
"error_code": "<string>",
"message": "<string>"
},
"id": "<string>",
"imported": true,
"managed_by_plan": true,
"monthly_price": 123,
"phone_number": "<string>",
"refunded": true,
"release_at": "<string>",
"revision": "<string>",
"status": "provisioning",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
},
"try_it": {},
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}{
"error_code": "<string>",
"message": "<string>",
"status": 0,
"details": {},
"errors": [
{
"error_code": "<string>",
"field": "<string>",
"message": "<string>"
}
],
"hint": "<string>",
"next_action": {
"method": "<string>",
"path": "<string>",
"tool": "<string>",
"body": {}
}
}Authorizations
Enter your API key (Bearer token)
Headers
Required. Send the same key when you retry this purchase; you get the same number back and are never charged twice.
Query Parameters
Seconds to wait for the purchase to finish before answering, at most 30.
Required range:
0 <= x <= 30Body
application/json
The monthly_price the owner agreed to, exactly as search returned it (0 inside the plan allowance). A different current price returns price_not_accepted.
Required range:
x >= 0A number from search_available_phone_numbers, in E.164 form.
Pattern:
^\+[1-9]\d{6,14}$Answer calls to the number with this agent as soon as it is bought.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Why a failed purchase failed. Null unless status is failed.
Show child attributes
Show child attributes
Stable from the first response: the purchase id becomes the number id.
Part of an Agent Phone Plan: give it up by cancelling the plan.
A failed purchase whose payment was refunded in full.
When a releasing number goes away. PATCH release_at null to keep it.
released only answers the release of an imported number, which is removed at once.
Available options:
provisioning, active, releasing, failed, released Show child attributes
Show child attributes
Ways to hear the agent on this number, as on agent writes.
Show child attributes
Show child attributes
Show child attributes
Show child attributes