Register a phone number
curl --request POST \
--url https://api.lehar.ai/ca/api/v0/phone-numbers \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"number": "+919876543210",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"display_name": "Sales line",
"outbound_enabled": true,
"inbound_enabled": false
}
'import requests
url = "https://api.lehar.ai/ca/api/v0/phone-numbers"
payload = {
"number": "+919876543210",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"display_name": "Sales line",
"outbound_enabled": True,
"inbound_enabled": False
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '+919876543210',
source: 'byo_trunk',
sip_trunk_id: 'trunk_x1y2z3',
display_name: 'Sales line',
outbound_enabled: true,
inbound_enabled: false
})
};
fetch('https://api.lehar.ai/ca/api/v0/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.lehar.ai/ca/api/v0/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' => '+919876543210',
'source' => 'byo_trunk',
'sip_trunk_id' => 'trunk_x1y2z3',
'display_name' => 'Sales line',
'outbound_enabled' => true,
'inbound_enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-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.lehar.ai/ca/api/v0/phone-numbers"
payload := strings.NewReader("{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.lehar.ai/ca/api/v0/phone-numbers")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lehar.ai/ca/api/v0/phone-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "pn_a1b2c3d4",
"number": "+919876543210",
"display_name": "Sales line",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"sip_trunk_name": "Acme SIP",
"status": "active",
"outbound_enabled": true,
"inbound_enabled": false,
"inbound_agent_id": null,
"provider": "acme-telecom",
"metadata": {},
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z"
}{
"error": {
"code": "invalid_request",
"message": "number must be E.164 (e.g. +919876543210)"
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication required"
}
}{
"error": {
"code": "forbidden",
"message": "This role cannot manage phone numbers"
}
}{
"error": {
"code": "not_found",
"message": "SIP trunk not found"
}
}{
"error": {
"code": "conflict",
"message": "This number is already registered"
}
}Phone Numbers
Register a phone number
Register a number into the workspace inventory: managed (platform-provisioned Vobiz DID, enters provisioning), hosted (customer-owned number hosted on the platform trunk after an LOA, enters pending_verification), or byo_trunk (number on an existing active SIP trunk, enters active). Requires the admin-tier phone_numbers:write scope (customer/platform admins, or an API key bearing the scope). Scope phone_numbers:write.
POST
/
phone-numbers
Register a phone number
curl --request POST \
--url https://api.lehar.ai/ca/api/v0/phone-numbers \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"number": "+919876543210",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"display_name": "Sales line",
"outbound_enabled": true,
"inbound_enabled": false
}
'import requests
url = "https://api.lehar.ai/ca/api/v0/phone-numbers"
payload = {
"number": "+919876543210",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"display_name": "Sales line",
"outbound_enabled": True,
"inbound_enabled": False
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '+919876543210',
source: 'byo_trunk',
sip_trunk_id: 'trunk_x1y2z3',
display_name: 'Sales line',
outbound_enabled: true,
inbound_enabled: false
})
};
fetch('https://api.lehar.ai/ca/api/v0/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.lehar.ai/ca/api/v0/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' => '+919876543210',
'source' => 'byo_trunk',
'sip_trunk_id' => 'trunk_x1y2z3',
'display_name' => 'Sales line',
'outbound_enabled' => true,
'inbound_enabled' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-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.lehar.ai/ca/api/v0/phone-numbers"
payload := strings.NewReader("{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.lehar.ai/ca/api/v0/phone-numbers")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lehar.ai/ca/api/v0/phone-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"+919876543210\",\n \"source\": \"byo_trunk\",\n \"sip_trunk_id\": \"trunk_x1y2z3\",\n \"display_name\": \"Sales line\",\n \"outbound_enabled\": true,\n \"inbound_enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "pn_a1b2c3d4",
"number": "+919876543210",
"display_name": "Sales line",
"source": "byo_trunk",
"sip_trunk_id": "trunk_x1y2z3",
"sip_trunk_name": "Acme SIP",
"status": "active",
"outbound_enabled": true,
"inbound_enabled": false,
"inbound_agent_id": null,
"provider": "acme-telecom",
"metadata": {},
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z"
}{
"error": {
"code": "invalid_request",
"message": "number must be E.164 (e.g. +919876543210)"
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication required"
}
}{
"error": {
"code": "forbidden",
"message": "This role cannot manage phone numbers"
}
}{
"error": {
"code": "not_found",
"message": "SIP trunk not found"
}
}{
"error": {
"code": "conflict",
"message": "This number is already registered"
}
}Authorizations
ApiKeyAuthBearerAuth
Body
application/json
E.164 number (e.g. +919876543210); whitespace and separators are stripped.
Registration source.
Available options:
managed, byo_trunk, hosted Human label for the number.
Required when source is byo_trunk; must reference an active SIP trunk in this workspace.
Carrier/provider label. Defaults to vobiz for managed/hosted, or the trunk's provider for byo_trunk.
Whether the number may be used as an outbound caller ID.
Whether the number answers inbound calls.
Free-form metadata. For hosted, must include loa_acknowledged: true to authorize the platform to present the number as caller ID.
Response
Number registered.