Create a SIP carrier
curl --request POST \
--url https://api.callers.ai/organization/sip \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"register_username": "<string>",
"register_password": "<string>",
"requires_register": false,
"register_sip_realm": "<string>",
"register_from_user": "<string>",
"register_from_domain": "<string>",
"register_public_ip_in_contact": true,
"tech_prefix": "<string>",
"diversion": "<string>",
"e164_leading_plus": false,
"gateways": [
{
"outbound": true,
"inbound": false,
"ipv4": "",
"netmask": 32,
"port": 5060,
"protocol": "udp",
"send_options_ping": false,
"use_sips_scheme": false,
"pad_crypto": false
}
],
"phoneNumbers": [],
"outbound_sip_proxy": "<string>",
"updatedBy": "<string>",
"cps": 10,
"isTriggerCarrier": true
}
'import requests
url = "https://api.callers.ai/organization/sip"
payload = {
"name": "<string>",
"register_username": "<string>",
"register_password": "<string>",
"requires_register": False,
"register_sip_realm": "<string>",
"register_from_user": "<string>",
"register_from_domain": "<string>",
"register_public_ip_in_contact": True,
"tech_prefix": "<string>",
"diversion": "<string>",
"e164_leading_plus": False,
"gateways": [
{
"outbound": True,
"inbound": False,
"ipv4": "",
"netmask": 32,
"port": 5060,
"protocol": "udp",
"send_options_ping": False,
"use_sips_scheme": False,
"pad_crypto": False
}
],
"phoneNumbers": [],
"outbound_sip_proxy": "<string>",
"updatedBy": "<string>",
"cps": 10,
"isTriggerCarrier": True
}
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({
name: '<string>',
register_username: '<string>',
register_password: '<string>',
requires_register: false,
register_sip_realm: '<string>',
register_from_user: '<string>',
register_from_domain: '<string>',
register_public_ip_in_contact: true,
tech_prefix: '<string>',
diversion: '<string>',
e164_leading_plus: false,
gateways: [
{
outbound: true,
inbound: false,
ipv4: '',
netmask: 32,
port: 5060,
protocol: 'udp',
send_options_ping: false,
use_sips_scheme: false,
pad_crypto: false
}
],
phoneNumbers: [],
outbound_sip_proxy: '<string>',
updatedBy: '<string>',
cps: 10,
isTriggerCarrier: true
})
};
fetch('https://api.callers.ai/organization/sip', 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.callers.ai/organization/sip",
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([
'name' => '<string>',
'register_username' => '<string>',
'register_password' => '<string>',
'requires_register' => false,
'register_sip_realm' => '<string>',
'register_from_user' => '<string>',
'register_from_domain' => '<string>',
'register_public_ip_in_contact' => true,
'tech_prefix' => '<string>',
'diversion' => '<string>',
'e164_leading_plus' => false,
'gateways' => [
[
'outbound' => true,
'inbound' => false,
'ipv4' => '',
'netmask' => 32,
'port' => 5060,
'protocol' => 'udp',
'send_options_ping' => false,
'use_sips_scheme' => false,
'pad_crypto' => false
]
],
'phoneNumbers' => [
],
'outbound_sip_proxy' => '<string>',
'updatedBy' => '<string>',
'cps' => 10,
'isTriggerCarrier' => true
]),
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.callers.ai/organization/sip"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\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.callers.ai/organization/sip")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callers.ai/organization/sip")
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 \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": "error",
"message": "<string>",
"data": [
{}
]
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Organizations
Create a SIP carrier
POST
/
organization
/
sip
Create a SIP carrier
curl --request POST \
--url https://api.callers.ai/organization/sip \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"register_username": "<string>",
"register_password": "<string>",
"requires_register": false,
"register_sip_realm": "<string>",
"register_from_user": "<string>",
"register_from_domain": "<string>",
"register_public_ip_in_contact": true,
"tech_prefix": "<string>",
"diversion": "<string>",
"e164_leading_plus": false,
"gateways": [
{
"outbound": true,
"inbound": false,
"ipv4": "",
"netmask": 32,
"port": 5060,
"protocol": "udp",
"send_options_ping": false,
"use_sips_scheme": false,
"pad_crypto": false
}
],
"phoneNumbers": [],
"outbound_sip_proxy": "<string>",
"updatedBy": "<string>",
"cps": 10,
"isTriggerCarrier": true
}
'import requests
url = "https://api.callers.ai/organization/sip"
payload = {
"name": "<string>",
"register_username": "<string>",
"register_password": "<string>",
"requires_register": False,
"register_sip_realm": "<string>",
"register_from_user": "<string>",
"register_from_domain": "<string>",
"register_public_ip_in_contact": True,
"tech_prefix": "<string>",
"diversion": "<string>",
"e164_leading_plus": False,
"gateways": [
{
"outbound": True,
"inbound": False,
"ipv4": "",
"netmask": 32,
"port": 5060,
"protocol": "udp",
"send_options_ping": False,
"use_sips_scheme": False,
"pad_crypto": False
}
],
"phoneNumbers": [],
"outbound_sip_proxy": "<string>",
"updatedBy": "<string>",
"cps": 10,
"isTriggerCarrier": True
}
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({
name: '<string>',
register_username: '<string>',
register_password: '<string>',
requires_register: false,
register_sip_realm: '<string>',
register_from_user: '<string>',
register_from_domain: '<string>',
register_public_ip_in_contact: true,
tech_prefix: '<string>',
diversion: '<string>',
e164_leading_plus: false,
gateways: [
{
outbound: true,
inbound: false,
ipv4: '',
netmask: 32,
port: 5060,
protocol: 'udp',
send_options_ping: false,
use_sips_scheme: false,
pad_crypto: false
}
],
phoneNumbers: [],
outbound_sip_proxy: '<string>',
updatedBy: '<string>',
cps: 10,
isTriggerCarrier: true
})
};
fetch('https://api.callers.ai/organization/sip', 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.callers.ai/organization/sip",
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([
'name' => '<string>',
'register_username' => '<string>',
'register_password' => '<string>',
'requires_register' => false,
'register_sip_realm' => '<string>',
'register_from_user' => '<string>',
'register_from_domain' => '<string>',
'register_public_ip_in_contact' => true,
'tech_prefix' => '<string>',
'diversion' => '<string>',
'e164_leading_plus' => false,
'gateways' => [
[
'outbound' => true,
'inbound' => false,
'ipv4' => '',
'netmask' => 32,
'port' => 5060,
'protocol' => 'udp',
'send_options_ping' => false,
'use_sips_scheme' => false,
'pad_crypto' => false
]
],
'phoneNumbers' => [
],
'outbound_sip_proxy' => '<string>',
'updatedBy' => '<string>',
'cps' => 10,
'isTriggerCarrier' => true
]),
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.callers.ai/organization/sip"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\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.callers.ai/organization/sip")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callers.ai/organization/sip")
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 \"name\": \"<string>\",\n \"register_username\": \"<string>\",\n \"register_password\": \"<string>\",\n \"requires_register\": false,\n \"register_sip_realm\": \"<string>\",\n \"register_from_user\": \"<string>\",\n \"register_from_domain\": \"<string>\",\n \"register_public_ip_in_contact\": true,\n \"tech_prefix\": \"<string>\",\n \"diversion\": \"<string>\",\n \"e164_leading_plus\": false,\n \"gateways\": [\n {\n \"outbound\": true,\n \"inbound\": false,\n \"ipv4\": \"\",\n \"netmask\": 32,\n \"port\": 5060,\n \"protocol\": \"udp\",\n \"send_options_ping\": false,\n \"use_sips_scheme\": false,\n \"pad_crypto\": false\n }\n ],\n \"phoneNumbers\": [],\n \"outbound_sip_proxy\": \"<string>\",\n \"updatedBy\": \"<string>\",\n \"cps\": 10,\n \"isTriggerCarrier\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": "error",
"message": "<string>",
"data": [
{}
]
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Authorizations
Headers
Optional sub organization ID. Must belong to your main organization API key.
Body
application/json
Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Required range:
0.1 < x < 1000Response
SIP carrier Created successfully.
⌘I