Create new SIP integration
curl --request POST \
--url https://api.cleartalk.ai/sip/attach2 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"trunkName": "Head Office",
"phone_number": "+15550000000",
"directions": [
{
"type": "outbound",
"sip_endpoint": "sip:192.168.1.100",
"options": {
"port": 5060,
"transport": "udp",
"secure_media": false,
"sip_username": "<string>",
"sip_password": "<string>"
}
}
],
"uuid_config_id": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://api.cleartalk.ai/sip/attach2"
payload = {
"trunkName": "Head Office",
"phone_number": "+15550000000",
"directions": [
{
"type": "outbound",
"sip_endpoint": "sip:192.168.1.100",
"options": {
"port": 5060,
"transport": "udp",
"secure_media": False,
"sip_username": "<string>",
"sip_password": "<string>"
}
}
],
"uuid_config_id": "550e8400-e29b-41d4-a716-446655440000"
}
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({
trunkName: 'Head Office',
phone_number: '+15550000000',
directions: [
{
type: 'outbound',
sip_endpoint: 'sip:192.168.1.100',
options: {
port: 5060,
transport: 'udp',
secure_media: false,
sip_username: '<string>',
sip_password: '<string>'
}
}
],
uuid_config_id: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://api.cleartalk.ai/sip/attach2', 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.cleartalk.ai/sip/attach2",
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([
'trunkName' => 'Head Office',
'phone_number' => '+15550000000',
'directions' => [
[
'type' => 'outbound',
'sip_endpoint' => 'sip:192.168.1.100',
'options' => [
'port' => 5060,
'transport' => 'udp',
'secure_media' => false,
'sip_username' => '<string>',
'sip_password' => '<string>'
]
]
],
'uuid_config_id' => '550e8400-e29b-41d4-a716-446655440000'
]),
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.cleartalk.ai/sip/attach2"
payload := strings.NewReader("{\n \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\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.cleartalk.ai/sip/attach2")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/sip/attach2")
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 \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_bodySIP Trunking
Create new SIP integration
Saves the settings to the local database and sends them to cleartalk AI
POST
/
sip
/
attach2
Create new SIP integration
curl --request POST \
--url https://api.cleartalk.ai/sip/attach2 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"trunkName": "Head Office",
"phone_number": "+15550000000",
"directions": [
{
"type": "outbound",
"sip_endpoint": "sip:192.168.1.100",
"options": {
"port": 5060,
"transport": "udp",
"secure_media": false,
"sip_username": "<string>",
"sip_password": "<string>"
}
}
],
"uuid_config_id": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://api.cleartalk.ai/sip/attach2"
payload = {
"trunkName": "Head Office",
"phone_number": "+15550000000",
"directions": [
{
"type": "outbound",
"sip_endpoint": "sip:192.168.1.100",
"options": {
"port": 5060,
"transport": "udp",
"secure_media": False,
"sip_username": "<string>",
"sip_password": "<string>"
}
}
],
"uuid_config_id": "550e8400-e29b-41d4-a716-446655440000"
}
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({
trunkName: 'Head Office',
phone_number: '+15550000000',
directions: [
{
type: 'outbound',
sip_endpoint: 'sip:192.168.1.100',
options: {
port: 5060,
transport: 'udp',
secure_media: false,
sip_username: '<string>',
sip_password: '<string>'
}
}
],
uuid_config_id: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://api.cleartalk.ai/sip/attach2', 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.cleartalk.ai/sip/attach2",
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([
'trunkName' => 'Head Office',
'phone_number' => '+15550000000',
'directions' => [
[
'type' => 'outbound',
'sip_endpoint' => 'sip:192.168.1.100',
'options' => [
'port' => 5060,
'transport' => 'udp',
'secure_media' => false,
'sip_username' => '<string>',
'sip_password' => '<string>'
]
]
],
'uuid_config_id' => '550e8400-e29b-41d4-a716-446655440000'
]),
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.cleartalk.ai/sip/attach2"
payload := strings.NewReader("{\n \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\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.cleartalk.ai/sip/attach2")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/sip/attach2")
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 \"trunkName\": \"Head Office\",\n \"phone_number\": \"+15550000000\",\n \"directions\": [\n {\n \"type\": \"outbound\",\n \"sip_endpoint\": \"sip:192.168.1.100\",\n \"options\": {\n \"port\": 5060,\n \"transport\": \"udp\",\n \"secure_media\": false,\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\"\n }\n }\n ],\n \"uuid_config_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key for authentication
Body
application/json
Internal name to identify the Trunk
Example:
"Head Office"
Phone number assigned by cleartalk AI
Example:
"+15550000000"
Show child attributes
Show child attributes
UUID of the configuration sip local
Example:
"550e8400-e29b-41d4-a716-446655440000"
Response
Integration created successfully.
⌘I
