Register a phone number
curl --request POST \
--url https://api.kataven.ai/v1/api/v1/telephony/numbers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"credentials_id": "prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"e164": "+12025550123",
"inbound_enabled": true,
"outbound_enabled": true,
"provider": "twilio"
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/telephony/numbers"
payload = {
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"credentials_id": "prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"e164": "+12025550123",
"inbound_enabled": True,
"outbound_enabled": True,
"provider": "twilio"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
credentials_id: 'prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
e164: '+12025550123',
inbound_enabled: true,
outbound_enabled: true,
provider: 'twilio'
})
};
fetch('https://api.kataven.ai/v1/api/v1/telephony/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.kataven.ai/v1/api/v1/telephony/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([
'agent_id' => 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'credentials_id' => 'prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'e164' => '+12025550123',
'inbound_enabled' => true,
'outbound_enabled' => true,
'provider' => 'twilio'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.kataven.ai/v1/api/v1/telephony/numbers"
payload := strings.NewReader("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.kataven.ai/v1/api/v1/telephony/numbers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/telephony/numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}"
response = http.request(request)
puts response.read_body{}"<string>"Telephony
Register a phone number
Binds an E.164 number to a carrier credential row and (optionally) pins it to one agent. Inbound + outbound default to enabled.
POST
/
api
/
v1
/
telephony
/
numbers
Register a phone number
curl --request POST \
--url https://api.kataven.ai/v1/api/v1/telephony/numbers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"credentials_id": "prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"e164": "+12025550123",
"inbound_enabled": true,
"outbound_enabled": true,
"provider": "twilio"
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/telephony/numbers"
payload = {
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"credentials_id": "prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"e164": "+12025550123",
"inbound_enabled": True,
"outbound_enabled": True,
"provider": "twilio"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
credentials_id: 'prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
e164: '+12025550123',
inbound_enabled: true,
outbound_enabled: true,
provider: 'twilio'
})
};
fetch('https://api.kataven.ai/v1/api/v1/telephony/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.kataven.ai/v1/api/v1/telephony/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([
'agent_id' => 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'credentials_id' => 'prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'e164' => '+12025550123',
'inbound_enabled' => true,
'outbound_enabled' => true,
'provider' => 'twilio'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.kataven.ai/v1/api/v1/telephony/numbers"
payload := strings.NewReader("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.kataven.ai/v1/api/v1/telephony/numbers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/telephony/numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"credentials_id\": \"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"e164\": \"+12025550123\",\n \"inbound_enabled\": true,\n \"outbound_enabled\": true,\n \"provider\": \"twilio\"\n}"
response = http.request(request)
puts response.read_body{}"<string>"Authorizations
Headers
Tenant database. Required when using a Zitadel JWT.
Body
application/json
Number spec
Number spec
Example:
"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z"
Example:
"prov_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z"
Example:
"+12025550123"
Example:
true
Example:
true
Available options:
twilio, plivo, vobiz Example:
"twilio"
Response
Created

