Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
API Key · Connector Profile
Uses a CloudTalk API key pair (Access Key ID and Secret) created by an administrator. The key belongs to the company acc…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
API Key · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
101 actions
Action
Description
List Activities
List activities attached to contacts.
Create Activity
Add an activity to an existing contact.
Update Activity
Updates the activity identified by
activityId.Delete Activity
Deletes the activity identified by
activityId.List Agents
List the agents (users) of a CloudTalk company account.
Get Agent
Get a single CloudTalk agent by ID.
Create Agent
Creates an agent.
Update Agent
Updates the agent identified by
agentId.Delete Agent
Deletes the agent identified by
agentId.List Blacklist
List blacklisted phone numbers.
Create Blacklist Number
Add a phone number to the blacklist.
Update Blacklist Number
Update a blacklisted phone number.
Delete Blacklist Number
Remove a phone number from the blacklist.
List Calls
Returns call history.
Get Call
Get the full analytics record of one call, including timings, call-flow steps, agents, contacts and tags.
Download Call Recording
Download the WAV recording of a call as base64.
Delete Call Recording
Permanently delete the recording of a call.
Create Call
Place an outbound call from an agent to a phone number.
Create CueCard
Push a CueCard with guidance to the agent handling a live call.
List Campaigns
Returns the account’s campaigns.
Create Campaign
Creates a campaign.
Update Campaign
Update a core call campaign.
Delete Campaign
Deletes the campaign identified by
id.List Contacts
Returns contacts together with their phone numbers, email addresses and custom attributes.
Get Contact
Returns one contact in full — the contact record plus its phone numbers, email addresses, tags, custom attributes and ex…
Create Contact
Creates a contact.
Update Contact
Update an existing contact; only the fields you send are changed.
Delete Contact
Deletes the contact identified by
contactId.List Contact Attributes
List the custom attributes that can be set on contacts.
Assign Contact Tags
Assign contact tags to a contact.
Unassign Contact Tags
Unassign contact tags from a contact.
Bulk Contact Actions
Run up to 10 contact and activity create, update or delete commands in one request.
Get Call Summary
Returns the AI-generated summary of a completed call.
Get Call Overall Sentiment
Returns the sentiment scored across a completed call as a whole — one of
very negative, negative, neutral, `positi…Get Call Talk-Listen Ratio
Get how long each participant spoke during a completed call.
List Call Topics
Returns the topics detected in a completed call, each with a weight and the transcript spans it was drawn from.
Get Call Transcription
Returns the transcript of a completed call as time-stamped segments, each attributed to a caller, together with the dete…
Get Call Smart Notes
Returns the structured notes generated for a completed call — call details, action items, decisions made, open questions…
Get Call Details Link
Returns a link to the call’s detail page in CloudTalk analytics.
List Countries
Returns every country CloudTalk recognises, with the
country_id values used by the contact endpoints.List Dialer Campaigns
Returns the company’s campaigns newest first, cursor-paginated.
Get Dialer Campaign
Returns a single campaign with its full configuration.
Create Dialer Campaign
Create a dialer campaign in the initializing state.
Update Dialer Campaign
Partially updates the campaign’s configuration and/or moves it through its lifecycle.
Delete Dialer Campaign
Soft-delete a dialer campaign by setting its status to deleted.
Get Dialer Campaign Associations
Returns the campaign’s associations grouped by kind.
Replace Dialer Campaign Associations
Replace the target tags, queue groups and agents of a dialer campaign in one call.
Get Dialer Campaign Disposition Buttons
Returns the campaign’s disposition buttons as a plain array ordered by
display_order, with each button’s name, colour…Replace Dialer Campaign Disposition Buttons
Replaces the campaign’s whole disposition-button set — the buttons an agent picks from to close a call.
List Dialer Disposition Tags
Lists the call tags the company can wire onto a campaign’s disposition buttons.
Get Dialer Campaign Statistics
Get aggregated performance statistics for a dialer campaign, all-time or for a date range.
List Dialer Campaign Contacts
Returns the campaign’s members ordered by dialing eligibility (
next_eligible_at, then id), cursor-paginated.List Dialer Campaign Next Contacts
Returns, in order, the contacts the allocator would serve next — a read-only, NON-BINDING snapshot.
Get Dialer Campaign Contact
Returns one campaign membership row, enriched with the contact’s current tag names from Contacts.
Create Dialer Campaign Export
Queues an asynchronous export of the campaign’s call history or survey responses as CSV or XLSX and returns immediately…
Get Dialer Export
Polls an export job by its id.
Get Dialer Export Download Link
Mints a fresh pre-signed S3 link for a completed export job and returns it in a JSON body together with the instant it e…
List Dialer Scripts
Returns the company’s call scripts newest first, cursor-paginated.
Get Dialer Script
Returns one script by id, archived or not.
Create Dialer Script
Creates a call script agents read while dialing.
Update Dialer Script
Partial update — omitted fields stay untouched;
updated_at is always bumped.Archive Dialer Script
Archives the script — a soft delete, never a hard one.
List Dialer Surveys
Returns the company’s surveys newest first, cursor-paginated.
Get Dialer Survey
Returns one survey by id with its full ordered question set, archived or not.
Create Dialer Survey
Creates a survey agents fill after a call.
Update Dialer Survey
Updates the survey’s
name and/or is_archived flag — nothing else is patchable here; questions change only through th…Replace Dialer Survey Questions
Atomically replaces the survey’s entire question set — this is a replace, not a merge.
List Groups
List the agent groups of a CloudTalk company account.
Add Agent To Group
Adds an agent to a group.
Remove Agent From Group
Removes one agent from one group.
Get Realtime Group Statistics
Get today’s live call and waiting-time statistics for every agent group.
Get Unified Credentials
Get the current CloudTalk connection’s unified credentials and identity.
List Unified Groups
List unified groups in a CloudTalk company account.
Get Unified Group
Get a unified CloudTalk group by ID.
List Unified Users
List unified users in a CloudTalk company account.
Get Unified User
Get a unified CloudTalk user by ID.
List Knowledge Bases
Returns one page of the company’s knowledge bases.
Create Knowledge Base
Creates a knowledge base from an address or from inline text.
Upload Knowledge Base File
Creates a knowledge base from one uploaded file.
Delete Knowledge Base
Deletes the knowledge base.
List Notes
List notes attached to contacts.
Create Note
Add a note to an existing contact.
Update Note
Updates the note identified by
noteId.Delete Note
Deletes the note identified by
noteId.List Numbers
Returns the phone numbers assigned to the account.
Update Number
Updates the number identified by
id.Unregister Number
Clear the routing settings of a phone number and mark it as free.
Send SMS
Send one SMS or MMS message from a CloudTalk number to one recipient.
List Tags
Returns the contact tags defined in the account.
Create Tag
Creates a contact tag with the given
name.Update Tag
Renames the contact tag identified by
id.Delete Tag
Deletes the contact tag identified by
id.List Voice Agents
Returns one page of the company’s voice agents.
Get Voice Agent
Returns one voice agent of the company.
Create Voice Agent
Creates a voice agent from the attributes object.
Replace Voice Agent
Replaces the voice agent with the attributes object.
Delete Voice Agent
Deletes the voice agent.
Attach Voice Agent Knowledge Base
Links the knowledge base to the agent.
Detach Voice Agent Knowledge Base
Unlinks the knowledge base from the agent; the knowledge base itself is kept.
Create Voice Agent Call
Creates a new VoiceAgent call with specified parameters and properties.
Stop Voice Agent Outbound Calls
Emergency stop for outbound VoiceAgent dialing.