CloudTalk REST API: Call Center Automation Platform

CloudTalk is a cloud-based call center and business calling platform built for modern revenue and support teams. Its REST API v1.7 gives you programmatic control over the full platform — automating outbound calling, syncing contacts, managing agents and numbers, running SMS campaigns, and surfacing AI-powered conversation intelligence from every call. If your team needs to integrate CloudTalk with a CRM, build internal tooling, or automate workflows that span your entire communication stack, the API is your starting point.

What the API Enables

The CloudTalk REST API is organized around the core resources your call center relies on. You can interact with each resource through a consistent set of HTTP endpoints:

Calls

List call history, retrieve individual call records, initiate outbound calls, and download call recordings.

Contacts

Create, update, and delete contacts. Manage tags, notes, activities, and custom attributes tied to each record.

Agents

Query agent profiles, availability status, and the numbers each agent is associated with.

Numbers

List and manage the phone numbers provisioned in your CloudTalk account.

SMS & WhatsApp

Send outbound SMS and WhatsApp messages programmatically from your CloudTalk numbers.

Campaigns

Create and manage the core API’s outbound calling campaigns. For the newer sales-dialer partner API, see Dialer below.

Conversation Intelligence

Access AI-generated transcriptions, sentiment scores, smart notes, call topics, and talk-listen ratios.

VoiceAgent

Initiate AI-powered voice agent calls by specifying a configured VoiceAgent ID and a target number.

Dialer

Sales-dialer partner API — campaigns, campaign contacts, call scripts, surveys, disposition buttons, statistics, and exports. Separate base URL and response shape; same Basic-auth credentials. Newly released — Dashboard visibility depends on your account’s rollout stage.

CueCard

Push real-time guidance cards to an agent during a live call.

Base URLs

CloudTalk serves its API from four hosts, and the one you use depends on the resource group you are targeting. Always use HTTPS — requests over plain HTTP are rejected.

Resource Group	Base URL
Core API (calls, contacts, agents, numbers, SMS, campaigns, etc.)	`https://my.cloudtalk.io/api/`
Call Flow Analytics	`https://analytics-api.cloudtalk.io/api/`
AI & Conversation Intelligence / VoiceAgent	`https://api.cloudtalk.io/v1/`
CueCard	`https://platform-api.cloudtalk.io/api/`
Dialer partner API	`https://api.cloudtalk.io/v1/`

Most everyday integrations use the core API at https://my.cloudtalk.io/api/. The analytics, AI, and CueCard base URLs apply only to their respective resource groups — check each endpoint’s reference page to confirm which base URL to use.

Request Format

Protocol and Encoding

All API communication happens exclusively over HTTPS. Structured payloads are JSON encoded as UTF-8 per RFC 8259 — XML is not supported. A small number of endpoints return binary content instead of JSON. Download a call recording, for example, responds with audio/x-wav. Always follow the media type documented on the endpoint’s own reference page.

HTTP Methods

The core API does not use POST and PUT the way most REST APIs do. On my.cloudtalk.io/api, PUT creates and POST updates — the reverse of the usual convention.

Method	Semantics on the core API (`my.cloudtalk.io/api`)
`GET`	Read a resource or list a collection. Never modifies data.
`PUT`	Create a resource — e.g. `PUT /contacts/add.json`
`POST`	Update an existing resource — e.g. `POST /contacts/edit/{contactId}.json`
`DELETE`	Delete a resource

Three core endpoints are actions rather than updates and use POST for that: Make a call, Send sms and Contact actions. PATCH is not used by the core API.

Newer surfaces use conventional REST

The Dialer, VoiceAgent, Conversation Intelligence and CueCard endpoints are newer services and use the conventional mapping where they expose the method at all. Most of them expose only a slice of it: Conversation Intelligence is read-only, and VoiceAgent and CueCard are POST-only. Dialer is the only surface with PATCH, PUT or DELETE operations.

Method	Semantics	Where it appears
`GET`	Retrieve a resource or a list of resources	Conversation Intelligence, Dialer
`POST`	Create a resource or trigger an action	VoiceAgent, CueCard, Dialer
`PATCH`	Partially update an existing resource	Dialer only — campaigns, scripts, surveys
`PUT`	Replace a sub-collection wholesale	Dialer only — associations, disposition buttons, survey questions
`DELETE`	Delete a resource	Dialer only — campaigns, scripts

Required Headers

For GET and HEAD requests, include an Accept header. On the core API a request without Accept: application/json may be rejected with a 404 or 406:

Accept: application/json

For endpoints that return binary content — call recordings, for instance — send the media type that endpoint documents instead. For POST and PUT requests, include a Content-Type header to declare the format of your request body:

Content-Type: application/json

Timestamps

All date and time values are UTC, but the wire representation varies by endpoint, so take the exact form from the endpoint’s own reference page. Both of these appear in the API:

2018-01-10 12:34:56        space-separated — envelope examples, and the
                           date_from / date_to filters on call history
2017-10-04T06:33:37.000Z   RFC 3339 with milliseconds — call record
                           timestamps such as started_at and ended_at

Always treat parsed values as UTC so you do not introduce off-by-one-hour bugs around daylight saving transitions.

API Resources at a Glance

The following table summarizes the top-level resources available in CloudTalk API v1.7:

Resource	Description
Calls	Call records, recordings, outbound call initiation
Contacts	Contact profiles, tags, notes, activities, custom attributes
Numbers	Phone numbers provisioned in your account
Agents	Agent profiles and availability
SMS	Outbound SMS messages
Tags	Labels applied to calls and contacts
Campaigns	Outbound call campaigns on the core API
Bulks	A batch of up to 10 contact add/edit/delete actions in one request
CueCard	Scripted prompts displayed to agents during calls
Groups	Agent groups and queues
Utilities	Supporting data — the countries list and the inbound call blacklist
Conversation Intelligence	AI transcriptions, sentiment, smart notes, topics
VoiceAgent	AI-driven automated voice calls
Dialer	Sales-dialer partner API — campaigns, scripts, surveys, exports. Separate base URL and response shape

Next Steps

You now have a clear picture of what the API offers and how it’s structured. The next step is setting up authentication so you can start making live requests.

Authentication

Generate your API keys and authenticate every request with HTTP Basic Auth.

Quickstart

Make your first API call — list calls and trigger an outbound call in minutes.

API Reference

Browse the full endpoint library with parameters, response schemas, and a live playground.

Getting Started

API Concepts

Changelog

CloudTalk REST API: Call Center Automation Platform

What the API Enables

Calls

Contacts

Agents

Numbers

SMS & WhatsApp

Campaigns

Conversation Intelligence

VoiceAgent

Dialer

CueCard

Base URLs

Request Format

Protocol and Encoding

HTTP Methods

Newer surfaces use conventional REST

Required Headers

Timestamps

API Resources at a Glance

Next Steps

Authentication

Quickstart

API Reference

​What the API Enables

Calls

Contacts

Agents

Numbers

SMS & WhatsApp

Campaigns

Conversation Intelligence

VoiceAgent

Dialer

CueCard

​Base URLs

​Request Format

​Protocol and Encoding

​HTTP Methods

​Newer surfaces use conventional REST

​Required Headers

​Timestamps

​API Resources at a Glance

​Next Steps

Authentication

Quickstart

API Reference

What the API Enables

Base URLs

Request Format

Protocol and Encoding

HTTP Methods

Newer surfaces use conventional REST

Required Headers

Timestamps

API Resources at a Glance

Next Steps