curl --request POST \
--url https://platform-api.cloudtalk.io/api/cuecards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"call_uuid": "<string>",
"type": "<string>",
"title": "<string>",
"content": "<string>",
"subtitle": "<string>",
"icon_url": "<string>"
}
'import requests
url = "https://platform-api.cloudtalk.io/api/cuecards"
payload = {
"call_uuid": "<string>",
"type": "<string>",
"title": "<string>",
"content": "<string>",
"subtitle": "<string>",
"icon_url": "<string>"
}
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_uuid: '<string>',
type: '<string>',
title: '<string>',
content: '<string>',
subtitle: '<string>',
icon_url: '<string>'
})
};
fetch('https://platform-api.cloudtalk.io/api/cuecards', 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://platform-api.cloudtalk.io/api/cuecards",
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_uuid' => '<string>',
'type' => '<string>',
'title' => '<string>',
'content' => '<string>',
'subtitle' => '<string>',
'icon_url' => '<string>'
]),
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://platform-api.cloudtalk.io/api/cuecards"
payload := strings.NewReader("{\n \"call_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\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://platform-api.cloudtalk.io/api/cuecards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"call_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.cloudtalk.io/api/cuecards")
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_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": false,
"errors": [
"field validation for 'CallUUID' failed (required)"
]
}{
"success": false,
"errors": [
"no such active call - call_uuid: aa-bb-cc"
]
}{
"success": false,
"errors": [
"error processing cue card"
]
}Create CueCard
Pushes a CueCard to the agent currently handling a live call, so guidance appears in their CloudTalk interface while the conversation is still in progress. call_uuid identifies the live call; type, title and content are also required, and subtitle and icon_url are optional.
CueCard is served by platform-api.cloudtalk.io, not the main API host. A 424 means no active call matched call_uuid — a card can only be delivered while the call is running.
curl --request POST \
--url https://platform-api.cloudtalk.io/api/cuecards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"call_uuid": "<string>",
"type": "<string>",
"title": "<string>",
"content": "<string>",
"subtitle": "<string>",
"icon_url": "<string>"
}
'import requests
url = "https://platform-api.cloudtalk.io/api/cuecards"
payload = {
"call_uuid": "<string>",
"type": "<string>",
"title": "<string>",
"content": "<string>",
"subtitle": "<string>",
"icon_url": "<string>"
}
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_uuid: '<string>',
type: '<string>',
title: '<string>',
content: '<string>',
subtitle: '<string>',
icon_url: '<string>'
})
};
fetch('https://platform-api.cloudtalk.io/api/cuecards', 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://platform-api.cloudtalk.io/api/cuecards",
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_uuid' => '<string>',
'type' => '<string>',
'title' => '<string>',
'content' => '<string>',
'subtitle' => '<string>',
'icon_url' => '<string>'
]),
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://platform-api.cloudtalk.io/api/cuecards"
payload := strings.NewReader("{\n \"call_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\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://platform-api.cloudtalk.io/api/cuecards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"call_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.cloudtalk.io/api/cuecards")
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_uuid\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"icon_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": false,
"errors": [
"field validation for 'CallUUID' failed (required)"
]
}{
"success": false,
"errors": [
"no such active call - call_uuid: aa-bb-cc"
]
}{
"success": false,
"errors": [
"error processing cue card"
]
}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
Cue Card request definition
Response
CueCard request processed correctly