Initiate VoiceAgent call
curl --request POST \
--url https://api.cloudtalk.io/v1/voice-agent/calls \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"call_number": "+421000000000",
"voice_agent_id": "681b0639876543cfbc3d6b55",
"call_properties": {
"output": {
"variables": {
"external_contact_id": 12345
}
},
"system_prompt": {
"variables": {
"name": "John Doe",
"company": "CloudTalk"
}
}
}
}
'import requests
url = "https://api.cloudtalk.io/v1/voice-agent/calls"
payload = {
"call_number": "+421000000000",
"voice_agent_id": "681b0639876543cfbc3d6b55",
"call_properties": {
"output": { "variables": { "external_contact_id": 12345 } },
"system_prompt": { "variables": {
"name": "John Doe",
"company": "CloudTalk"
} }
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
call_number: '+421000000000',
voice_agent_id: '681b0639876543cfbc3d6b55',
call_properties: {
output: {variables: {external_contact_id: 12345}},
system_prompt: {variables: {name: 'John Doe', company: 'CloudTalk'}}
}
})
};
fetch('https://api.cloudtalk.io/v1/voice-agent/calls', 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.cloudtalk.io/v1/voice-agent/calls",
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([
'call_number' => '+421000000000',
'voice_agent_id' => '681b0639876543cfbc3d6b55',
'call_properties' => [
'output' => [
'variables' => [
'external_contact_id' => 12345
]
],
'system_prompt' => [
'variables' => [
'name' => 'John Doe',
'company' => 'CloudTalk'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.cloudtalk.io/v1/voice-agent/calls"
payload := strings.NewReader("{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/voice-agent/calls")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/voice-agent/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": "Validation error",
"error": "Bad Request",
"correlationId": "YevPQs",
"subErrors": [
"incorrect email"
]
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"statusCode": 404,
"message": "Not Found",
"error": "Not Found",
"correlationId": "YevPQs"
}{
"statusCode": 500,
"message": "Internal Server Error",
"error": "Internal Server Error",
"correlationId": "YevPQs"
}VoiceAgent
Initiate VoiceAgent call
Creates a new VoiceAgent call with specified parameters and properties. Call properties are optional and can be used to configure the call.
POST
/
voice-agent
/
calls
Initiate VoiceAgent call
curl --request POST \
--url https://api.cloudtalk.io/v1/voice-agent/calls \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"call_number": "+421000000000",
"voice_agent_id": "681b0639876543cfbc3d6b55",
"call_properties": {
"output": {
"variables": {
"external_contact_id": 12345
}
},
"system_prompt": {
"variables": {
"name": "John Doe",
"company": "CloudTalk"
}
}
}
}
'import requests
url = "https://api.cloudtalk.io/v1/voice-agent/calls"
payload = {
"call_number": "+421000000000",
"voice_agent_id": "681b0639876543cfbc3d6b55",
"call_properties": {
"output": { "variables": { "external_contact_id": 12345 } },
"system_prompt": { "variables": {
"name": "John Doe",
"company": "CloudTalk"
} }
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
call_number: '+421000000000',
voice_agent_id: '681b0639876543cfbc3d6b55',
call_properties: {
output: {variables: {external_contact_id: 12345}},
system_prompt: {variables: {name: 'John Doe', company: 'CloudTalk'}}
}
})
};
fetch('https://api.cloudtalk.io/v1/voice-agent/calls', 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.cloudtalk.io/v1/voice-agent/calls",
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([
'call_number' => '+421000000000',
'voice_agent_id' => '681b0639876543cfbc3d6b55',
'call_properties' => [
'output' => [
'variables' => [
'external_contact_id' => 12345
]
],
'system_prompt' => [
'variables' => [
'name' => 'John Doe',
'company' => 'CloudTalk'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.cloudtalk.io/v1/voice-agent/calls"
payload := strings.NewReader("{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.cloudtalk.io/v1/voice-agent/calls")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/voice-agent/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"call_number\": \"+421000000000\",\n \"voice_agent_id\": \"681b0639876543cfbc3d6b55\",\n \"call_properties\": {\n \"output\": {\n \"variables\": {\n \"external_contact_id\": 12345\n }\n },\n \"system_prompt\": {\n \"variables\": {\n \"name\": \"John Doe\",\n \"company\": \"CloudTalk\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": "Validation error",
"error": "Bad Request",
"correlationId": "YevPQs",
"subErrors": [
"incorrect email"
]
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"statusCode": 404,
"message": "Not Found",
"error": "Not Found",
"correlationId": "YevPQs"
}{
"statusCode": 500,
"message": "Internal Server Error",
"error": "Internal Server Error",
"correlationId": "YevPQs"
}Authorizations
HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).
Body
application/json
Response
Operation completed successfully. A 204 response has an empty body.
Related topics
Stop outbound VoiceAgent callsCloudTalk REST API: Call Center Automation PlatformCloudTalk REST API v1.7 — Complete Developer Reference⌘I