transfer-targets
Create Transfer Target
POST
/
transfer-targets
Create Transfer Target
curl --request POST \
--url https://api.example.com/transfer-targets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": "<string>",
"mode": "warm",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": [
"<string>"
],
"enabled": true
}
'import requests
url = "https://api.example.com/transfer-targets"
payload = {
"name": "<string>",
"target": "<string>",
"mode": "warm",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": ["<string>"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: '<string>',
mode: 'warm',
sip_trunk_id: '<string>',
sip_headers: {},
briefing_prompt: '<string>',
transfer_announcement: '<string>',
tags: ['<string>'],
enabled: true
})
};
fetch('https://api.example.com/transfer-targets', 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.example.com/transfer-targets",
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>',
'target' => '<string>',
'mode' => 'warm',
'sip_trunk_id' => '<string>',
'sip_headers' => [
],
'briefing_prompt' => '<string>',
'transfer_announcement' => '<string>',
'tags' => [
'<string>'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/transfer-targets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/transfer-targets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/transfer-targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_id": "<string>",
"name": "<string>",
"target": "<string>",
"mode": "<string>",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": [
"<string>"
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Friendly name (e.g. 'Billing').
Required string length:
1 - 160E.164 number, sip: URI, or LiveKit identity.
Required string length:
3 - 255warm | cold
Show child attributes
Show child attributes
Response
Successful Response
⌘I
Create Transfer Target
curl --request POST \
--url https://api.example.com/transfer-targets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": "<string>",
"mode": "warm",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": [
"<string>"
],
"enabled": true
}
'import requests
url = "https://api.example.com/transfer-targets"
payload = {
"name": "<string>",
"target": "<string>",
"mode": "warm",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": ["<string>"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: '<string>',
mode: 'warm',
sip_trunk_id: '<string>',
sip_headers: {},
briefing_prompt: '<string>',
transfer_announcement: '<string>',
tags: ['<string>'],
enabled: true
})
};
fetch('https://api.example.com/transfer-targets', 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.example.com/transfer-targets",
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>',
'target' => '<string>',
'mode' => 'warm',
'sip_trunk_id' => '<string>',
'sip_headers' => [
],
'briefing_prompt' => '<string>',
'transfer_announcement' => '<string>',
'tags' => [
'<string>'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/transfer-targets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/transfer-targets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/transfer-targets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": \"<string>\",\n \"mode\": \"warm\",\n \"sip_trunk_id\": \"<string>\",\n \"sip_headers\": {},\n \"briefing_prompt\": \"<string>\",\n \"transfer_announcement\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"owner_id": "<string>",
"name": "<string>",
"target": "<string>",
"mode": "<string>",
"sip_trunk_id": "<string>",
"sip_headers": {},
"briefing_prompt": "<string>",
"transfer_announcement": "<string>",
"tags": [
"<string>"
],
"enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}