Make a cleartalk call
curl --request POST \
--url https://api.cleartalk.ai/callback/cleartalk-call \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentId": 123,
"selectedTag": "<string>",
"quantity": 123,
"index": 123,
"numberLimitCallback": 123,
"dispositionCall": [
"<string>"
],
"languageName": "<string>",
"voiceSpeed": "<string>",
"interruptionThreshold": "<string>",
"background_track": "<string>",
"max_duration": "<string>",
"similarity": "<string>",
"stability": "<string>",
"wait_for_greeting": "<string>",
"task": "<string>",
"temperature": "<string>",
"firstSentence": "<string>",
"model": "<string>",
"startTime": "<string>",
"amd": "<string>",
"voiceMailAction": "<string>",
"optimizeFor": "<string>",
"speechFlexibility": "<string>",
"calendarID": "<string>",
"selectedVoice": "<string>",
"transferPhoneNumber": [
{
"transfer_type": "operator",
"transfer_number": "+1234567890"
}
],
"phone": "<string>",
"agentName": "<string>",
"memory_id": "<string>",
"knowbase_id": "<string>",
"isGHL": "<string>",
"listName": "<string>",
"agentPhones": [
"<string>"
]
}
'import requests
url = "https://api.cleartalk.ai/callback/cleartalk-call"
payload = {
"agentId": 123,
"selectedTag": "<string>",
"quantity": 123,
"index": 123,
"numberLimitCallback": 123,
"dispositionCall": ["<string>"],
"languageName": "<string>",
"voiceSpeed": "<string>",
"interruptionThreshold": "<string>",
"background_track": "<string>",
"max_duration": "<string>",
"similarity": "<string>",
"stability": "<string>",
"wait_for_greeting": "<string>",
"task": "<string>",
"temperature": "<string>",
"firstSentence": "<string>",
"model": "<string>",
"startTime": "<string>",
"amd": "<string>",
"voiceMailAction": "<string>",
"optimizeFor": "<string>",
"speechFlexibility": "<string>",
"calendarID": "<string>",
"selectedVoice": "<string>",
"transferPhoneNumber": [
{
"transfer_type": "operator",
"transfer_number": "+1234567890"
}
],
"phone": "<string>",
"agentName": "<string>",
"memory_id": "<string>",
"knowbase_id": "<string>",
"isGHL": "<string>",
"listName": "<string>",
"agentPhones": ["<string>"]
}
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({
agentId: 123,
selectedTag: '<string>',
quantity: 123,
index: 123,
numberLimitCallback: 123,
dispositionCall: ['<string>'],
languageName: '<string>',
voiceSpeed: '<string>',
interruptionThreshold: '<string>',
background_track: '<string>',
max_duration: '<string>',
similarity: '<string>',
stability: '<string>',
wait_for_greeting: '<string>',
task: '<string>',
temperature: '<string>',
firstSentence: '<string>',
model: '<string>',
startTime: '<string>',
amd: '<string>',
voiceMailAction: '<string>',
optimizeFor: '<string>',
speechFlexibility: '<string>',
calendarID: '<string>',
selectedVoice: '<string>',
transferPhoneNumber: [{transfer_type: 'operator', transfer_number: '+1234567890'}],
phone: '<string>',
agentName: '<string>',
memory_id: '<string>',
knowbase_id: '<string>',
isGHL: '<string>',
listName: '<string>',
agentPhones: ['<string>']
})
};
fetch('https://api.cleartalk.ai/callback/cleartalk-call', 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/callback/cleartalk-call",
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([
'agentId' => 123,
'selectedTag' => '<string>',
'quantity' => 123,
'index' => 123,
'numberLimitCallback' => 123,
'dispositionCall' => [
'<string>'
],
'languageName' => '<string>',
'voiceSpeed' => '<string>',
'interruptionThreshold' => '<string>',
'background_track' => '<string>',
'max_duration' => '<string>',
'similarity' => '<string>',
'stability' => '<string>',
'wait_for_greeting' => '<string>',
'task' => '<string>',
'temperature' => '<string>',
'firstSentence' => '<string>',
'model' => '<string>',
'startTime' => '<string>',
'amd' => '<string>',
'voiceMailAction' => '<string>',
'optimizeFor' => '<string>',
'speechFlexibility' => '<string>',
'calendarID' => '<string>',
'selectedVoice' => '<string>',
'transferPhoneNumber' => [
[
'transfer_type' => 'operator',
'transfer_number' => '+1234567890'
]
],
'phone' => '<string>',
'agentName' => '<string>',
'memory_id' => '<string>',
'knowbase_id' => '<string>',
'isGHL' => '<string>',
'listName' => '<string>',
'agentPhones' => [
'<string>'
]
]),
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/callback/cleartalk-call"
payload := strings.NewReader("{\n \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\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/callback/cleartalk-call")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/callback/cleartalk-call")
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 \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyCallback
Make a cleartalk call
POST
/
callback
/
cleartalk-call
Make a cleartalk call
curl --request POST \
--url https://api.cleartalk.ai/callback/cleartalk-call \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentId": 123,
"selectedTag": "<string>",
"quantity": 123,
"index": 123,
"numberLimitCallback": 123,
"dispositionCall": [
"<string>"
],
"languageName": "<string>",
"voiceSpeed": "<string>",
"interruptionThreshold": "<string>",
"background_track": "<string>",
"max_duration": "<string>",
"similarity": "<string>",
"stability": "<string>",
"wait_for_greeting": "<string>",
"task": "<string>",
"temperature": "<string>",
"firstSentence": "<string>",
"model": "<string>",
"startTime": "<string>",
"amd": "<string>",
"voiceMailAction": "<string>",
"optimizeFor": "<string>",
"speechFlexibility": "<string>",
"calendarID": "<string>",
"selectedVoice": "<string>",
"transferPhoneNumber": [
{
"transfer_type": "operator",
"transfer_number": "+1234567890"
}
],
"phone": "<string>",
"agentName": "<string>",
"memory_id": "<string>",
"knowbase_id": "<string>",
"isGHL": "<string>",
"listName": "<string>",
"agentPhones": [
"<string>"
]
}
'import requests
url = "https://api.cleartalk.ai/callback/cleartalk-call"
payload = {
"agentId": 123,
"selectedTag": "<string>",
"quantity": 123,
"index": 123,
"numberLimitCallback": 123,
"dispositionCall": ["<string>"],
"languageName": "<string>",
"voiceSpeed": "<string>",
"interruptionThreshold": "<string>",
"background_track": "<string>",
"max_duration": "<string>",
"similarity": "<string>",
"stability": "<string>",
"wait_for_greeting": "<string>",
"task": "<string>",
"temperature": "<string>",
"firstSentence": "<string>",
"model": "<string>",
"startTime": "<string>",
"amd": "<string>",
"voiceMailAction": "<string>",
"optimizeFor": "<string>",
"speechFlexibility": "<string>",
"calendarID": "<string>",
"selectedVoice": "<string>",
"transferPhoneNumber": [
{
"transfer_type": "operator",
"transfer_number": "+1234567890"
}
],
"phone": "<string>",
"agentName": "<string>",
"memory_id": "<string>",
"knowbase_id": "<string>",
"isGHL": "<string>",
"listName": "<string>",
"agentPhones": ["<string>"]
}
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({
agentId: 123,
selectedTag: '<string>',
quantity: 123,
index: 123,
numberLimitCallback: 123,
dispositionCall: ['<string>'],
languageName: '<string>',
voiceSpeed: '<string>',
interruptionThreshold: '<string>',
background_track: '<string>',
max_duration: '<string>',
similarity: '<string>',
stability: '<string>',
wait_for_greeting: '<string>',
task: '<string>',
temperature: '<string>',
firstSentence: '<string>',
model: '<string>',
startTime: '<string>',
amd: '<string>',
voiceMailAction: '<string>',
optimizeFor: '<string>',
speechFlexibility: '<string>',
calendarID: '<string>',
selectedVoice: '<string>',
transferPhoneNumber: [{transfer_type: 'operator', transfer_number: '+1234567890'}],
phone: '<string>',
agentName: '<string>',
memory_id: '<string>',
knowbase_id: '<string>',
isGHL: '<string>',
listName: '<string>',
agentPhones: ['<string>']
})
};
fetch('https://api.cleartalk.ai/callback/cleartalk-call', 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/callback/cleartalk-call",
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([
'agentId' => 123,
'selectedTag' => '<string>',
'quantity' => 123,
'index' => 123,
'numberLimitCallback' => 123,
'dispositionCall' => [
'<string>'
],
'languageName' => '<string>',
'voiceSpeed' => '<string>',
'interruptionThreshold' => '<string>',
'background_track' => '<string>',
'max_duration' => '<string>',
'similarity' => '<string>',
'stability' => '<string>',
'wait_for_greeting' => '<string>',
'task' => '<string>',
'temperature' => '<string>',
'firstSentence' => '<string>',
'model' => '<string>',
'startTime' => '<string>',
'amd' => '<string>',
'voiceMailAction' => '<string>',
'optimizeFor' => '<string>',
'speechFlexibility' => '<string>',
'calendarID' => '<string>',
'selectedVoice' => '<string>',
'transferPhoneNumber' => [
[
'transfer_type' => 'operator',
'transfer_number' => '+1234567890'
]
],
'phone' => '<string>',
'agentName' => '<string>',
'memory_id' => '<string>',
'knowbase_id' => '<string>',
'isGHL' => '<string>',
'listName' => '<string>',
'agentPhones' => [
'<string>'
]
]),
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/callback/cleartalk-call"
payload := strings.NewReader("{\n \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\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/callback/cleartalk-call")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/callback/cleartalk-call")
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 \"agentId\": 123,\n \"selectedTag\": \"<string>\",\n \"quantity\": 123,\n \"index\": 123,\n \"numberLimitCallback\": 123,\n \"dispositionCall\": [\n \"<string>\"\n ],\n \"languageName\": \"<string>\",\n \"voiceSpeed\": \"<string>\",\n \"interruptionThreshold\": \"<string>\",\n \"background_track\": \"<string>\",\n \"max_duration\": \"<string>\",\n \"similarity\": \"<string>\",\n \"stability\": \"<string>\",\n \"wait_for_greeting\": \"<string>\",\n \"task\": \"<string>\",\n \"temperature\": \"<string>\",\n \"firstSentence\": \"<string>\",\n \"model\": \"<string>\",\n \"startTime\": \"<string>\",\n \"amd\": \"<string>\",\n \"voiceMailAction\": \"<string>\",\n \"optimizeFor\": \"<string>\",\n \"speechFlexibility\": \"<string>\",\n \"calendarID\": \"<string>\",\n \"selectedVoice\": \"<string>\",\n \"transferPhoneNumber\": [\n {\n \"transfer_type\": \"operator\",\n \"transfer_number\": \"+1234567890\"\n }\n ],\n \"phone\": \"<string>\",\n \"agentName\": \"<string>\",\n \"memory_id\": \"<string>\",\n \"knowbase_id\": \"<string>\",\n \"isGHL\": \"<string>\",\n \"listName\": \"<string>\",\n \"agentPhones\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key for authentication
Body
application/json
Show child attributes
Show child attributes
Response
Returns call response
⌘I
