calls
Transfer Call
Transfer a call to another number or SIP endpoint.
Supports two transfer types:
- cold: Direct transfer, agent disconnects immediately
- warm: Agent provides context before connecting (requires additional orchestration)
The transfer_to parameter must be in one of these formats:
- tel:+15105550100 (phone number)
- sip:user@domain.com (SIP endpoint)
- sip:+15105550100@sip.telnyx.com (phone via SIP URI)
POST
/
calls
/
{call_id}
/
transfer
Transfer Call
curl --request POST \
--url https://api.example.com/calls/{call_id}/transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transfer_to": "<string>",
"transfer_type": "cold",
"play_dialtone": false
}
'import requests
url = "https://api.example.com/calls/{call_id}/transfer"
payload = {
"transfer_to": "<string>",
"transfer_type": "cold",
"play_dialtone": False
}
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({transfer_to: '<string>', transfer_type: 'cold', play_dialtone: false})
};
fetch('https://api.example.com/calls/{call_id}/transfer', 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/calls/{call_id}/transfer",
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([
'transfer_to' => '<string>',
'transfer_type' => 'cold',
'play_dialtone' => false
]),
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/calls/{call_id}/transfer"
payload := strings.NewReader("{\n \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\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/calls/{call_id}/transfer")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/calls/{call_id}/transfer")
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 \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\n}"
response = http.request(request)
puts response.read_body{
"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.
Path Parameters
Body
application/json
Request to transfer a call.
Destination: tel:+15105550100 or sip:user@domain.com
Transfer type: cold or warm
Pattern:
^(cold|warm)$Play dial tone during transfer
Response
Successful Response
⌘I
Transfer Call
curl --request POST \
--url https://api.example.com/calls/{call_id}/transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transfer_to": "<string>",
"transfer_type": "cold",
"play_dialtone": false
}
'import requests
url = "https://api.example.com/calls/{call_id}/transfer"
payload = {
"transfer_to": "<string>",
"transfer_type": "cold",
"play_dialtone": False
}
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({transfer_to: '<string>', transfer_type: 'cold', play_dialtone: false})
};
fetch('https://api.example.com/calls/{call_id}/transfer', 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/calls/{call_id}/transfer",
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([
'transfer_to' => '<string>',
'transfer_type' => 'cold',
'play_dialtone' => false
]),
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/calls/{call_id}/transfer"
payload := strings.NewReader("{\n \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\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/calls/{call_id}/transfer")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/calls/{call_id}/transfer")
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 \"transfer_to\": \"<string>\",\n \"transfer_type\": \"cold\",\n \"play_dialtone\": false\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}