> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudTalk

> How to set up the CloudTalk connector, plus the actions that are available.

![CloudTalk](https://stackone-logos.com/api/cloudtalk/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/cloudtalk/changelog.md)

[101 actions](#actions) · 1 auth method

Telephony
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/cloudtalk/guides/connector-profile/api-key.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/cloudtalk/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

101 actions

ActionDescription

List Activities`cloudtalk_list_activities`

List activities attached to contacts.

Create Activity`cloudtalk_create_activity`

Add an activity to an existing contact.

Update Activity`cloudtalk_update_activity`

Updates the activity identified by `activityId`.

Delete Activity`cloudtalk_delete_activity`

Deletes the activity identified by `activityId`.

List Agents`cloudtalk_list_agents`

List the agents (users) of a CloudTalk company account.

Get Agent`cloudtalk_get_agent`

Get a single CloudTalk agent by ID.

Create Agent`cloudtalk_create_agent`

Creates an agent.

Update Agent`cloudtalk_update_agent`

Updates the agent identified by `agentId`.

Delete Agent`cloudtalk_delete_agent`

Deletes the agent identified by `agentId`.

List Blacklist`cloudtalk_list_blacklist`

List blacklisted phone numbers.

Create Blacklist Number`cloudtalk_create_blacklist_number`

Add a phone number to the blacklist.

Update Blacklist Number`cloudtalk_update_blacklist_number`

Update a blacklisted phone number.

Delete Blacklist Number`cloudtalk_delete_blacklist_number`

Remove a phone number from the blacklist.

List Calls`cloudtalk_list_calls`

Returns call history.

Get Call`cloudtalk_get_call`

Get the full analytics record of one call, including timings, call-flow steps, agents, contacts and tags.

Download Call Recording`cloudtalk_download_call_recording`

Download the WAV recording of a call as base64.

Delete Call Recording`cloudtalk_delete_call_recording`

Permanently delete the recording of a call.

Create Call`cloudtalk_create_call`

Place an outbound call from an agent to a phone number.

Create CueCard`cloudtalk_create_cuecard`

Push a CueCard with guidance to the agent handling a live call.

List Campaigns`cloudtalk_list_campaigns`

Returns the account's campaigns.

Create Campaign`cloudtalk_create_campaign`

Creates a campaign.

Update Campaign`cloudtalk_update_campaign`

Update a core call campaign.

Delete Campaign`cloudtalk_delete_campaign`

Deletes the campaign identified by `id`.

List Contacts`cloudtalk_list_contacts`

Returns contacts together with their phone numbers, email addresses and custom attributes.

Get Contact`cloudtalk_get_contact`

Returns one contact in full — the contact record plus its phone numbers, email addresses, tags, custom attributes and ex...

Create Contact`cloudtalk_create_contact`

Creates a contact.

Update Contact`cloudtalk_update_contact`

Update an existing contact; only the fields you send are changed.

Delete Contact`cloudtalk_delete_contact`

Deletes the contact identified by `contactId`.

List Contact Attributes`cloudtalk_list_contact_attributes`

List the custom attributes that can be set on contacts.

Assign Contact Tags`cloudtalk_assign_contact_tags`

Assign contact tags to a contact.

Unassign Contact Tags`cloudtalk_unassign_contact_tags`

Unassign contact tags from a contact.

Bulk Contact Actions`cloudtalk_bulk_contact_actions`

Run up to 10 contact and activity create, update or delete commands in one request.

Get Call Summary`cloudtalk_get_call_summary`

Returns the AI-generated summary of a completed call.

Get Call Overall Sentiment`cloudtalk_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`cloudtalk_get_call_talk_listen_ratio`

Get how long each participant spoke during a completed call.

List Call Topics`cloudtalk_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`cloudtalk_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`cloudtalk_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`cloudtalk_get_call_details_link`

Returns a link to the call's detail page in CloudTalk analytics.

List Countries`cloudtalk_list_countries`

Returns every country CloudTalk recognises, with the `country_id` values used by the contact endpoints.

List Dialer Campaigns`cloudtalk_list_dialer_campaigns`

Returns the company's campaigns newest first, cursor-paginated.

Get Dialer Campaign`cloudtalk_get_dialer_campaign`

Returns a single campaign with its full configuration.

Create Dialer Campaign`cloudtalk_create_dialer_campaign`

Create a dialer campaign in the initializing state.

Update Dialer Campaign`cloudtalk_update_dialer_campaign`

Partially updates the campaign's configuration and/or moves it through its lifecycle.

Delete Dialer Campaign`cloudtalk_delete_dialer_campaign`

Soft-delete a dialer campaign by setting its status to deleted.

Get Dialer Campaign Associations`cloudtalk_get_dialer_campaign_associations`

Returns the campaign's associations grouped by kind.

Replace Dialer Campaign Associations`cloudtalk_replace_dialer_campaign_associations`

Replace the target tags, queue groups and agents of a dialer campaign in one call.

Get Dialer Campaign Disposition Buttons`cloudtalk_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`cloudtalk_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`cloudtalk_list_dialer_disposition_tags`

Lists the call tags the company can wire onto a campaign's disposition buttons.

Get Dialer Campaign Statistics`cloudtalk_get_dialer_campaign_statistics`

Get aggregated performance statistics for a dialer campaign, all-time or for a date range.

List Dialer Campaign Contacts`cloudtalk_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`cloudtalk_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`cloudtalk_get_dialer_campaign_contact`

Returns one campaign membership row, enriched with the contact's current tag names from Contacts.

Create Dialer Campaign Export`cloudtalk_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`cloudtalk_get_dialer_export`

Polls an export job by its id.

Get Dialer Export Download Link`cloudtalk_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`cloudtalk_list_dialer_scripts`

Returns the company's call scripts newest first, cursor-paginated.

Get Dialer Script`cloudtalk_get_dialer_script`

Returns one script by id, archived or not.

Create Dialer Script`cloudtalk_create_dialer_script`

Creates a call script agents read while dialing.

Update Dialer Script`cloudtalk_update_dialer_script`

Partial update — omitted fields stay untouched; `updated_at` is always bumped.

Archive Dialer Script`cloudtalk_archive_dialer_script`

Archives the script — a soft delete, never a hard one.

List Dialer Surveys`cloudtalk_list_dialer_surveys`

Returns the company's surveys newest first, cursor-paginated.

Get Dialer Survey`cloudtalk_get_dialer_survey`

Returns one survey by id with its full ordered question set, archived or not.

Create Dialer Survey`cloudtalk_create_dialer_survey`

Creates a survey agents fill after a call.

Update Dialer Survey`cloudtalk_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`cloudtalk_replace_dialer_survey_questions`

Atomically replaces the survey's entire question set — this is a replace, not a merge.

List Groups`cloudtalk_list_groups`

List the agent groups of a CloudTalk company account.

Add Agent To Group`cloudtalk_add_agent_to_group`

Adds an agent to a group.

Remove Agent From Group`cloudtalk_remove_agent_from_group`

Removes one agent from one group.

Get Realtime Group Statistics`cloudtalk_get_realtime_group_statistics`

Get today's live call and waiting-time statistics for every agent group.

Get Unified Credentials`cloudtalk_unified_get_me`

Get the current CloudTalk connection's unified credentials and identity.

List Unified Groups`cloudtalk_unified_list_groups`

List unified groups in a CloudTalk company account.

Get Unified Group`cloudtalk_unified_get_group`

Get a unified CloudTalk group by ID.

List Unified Users`cloudtalk_unified_list_users`

List unified users in a CloudTalk company account.

Get Unified User`cloudtalk_unified_get_user`

Get a unified CloudTalk user by ID.

List Knowledge Bases`cloudtalk_list_knowledge_bases`

Returns one page of the company's knowledge bases.

Create Knowledge Base`cloudtalk_create_knowledge_base`

Creates a knowledge base from an address or from inline text.

Upload Knowledge Base File`cloudtalk_upload_knowledge_base_file`

Creates a knowledge base from one uploaded file.

Delete Knowledge Base`cloudtalk_delete_knowledge_base`

Deletes the knowledge base.

List Notes`cloudtalk_list_notes`

List notes attached to contacts.

Create Note`cloudtalk_create_note`

Add a note to an existing contact.

Update Note`cloudtalk_update_note`

Updates the note identified by `noteId`.

Delete Note`cloudtalk_delete_note`

Deletes the note identified by `noteId`.

List Numbers`cloudtalk_list_numbers`

Returns the phone numbers assigned to the account.

Update Number`cloudtalk_update_number`

Updates the number identified by `id`.

Unregister Number`cloudtalk_unregister_number`

Clear the routing settings of a phone number and mark it as free.

Send SMS`cloudtalk_send_sms`

Send one SMS or MMS message from a CloudTalk number to one recipient.

List Tags`cloudtalk_list_tags`

Returns the contact tags defined in the account.

Create Tag`cloudtalk_create_tag`

Creates a contact tag with the given `name`.

Update Tag`cloudtalk_update_tag`

Renames the contact tag identified by `id`.

Delete Tag`cloudtalk_delete_tag`

Deletes the contact tag identified by `id`.

List Voice Agents`cloudtalk_list_voice_agents`

Returns one page of the company's voice agents.

Get Voice Agent`cloudtalk_get_voice_agent`

Returns one voice agent of the company.

Create Voice Agent`cloudtalk_create_voice_agent`

Creates a voice agent from the attributes object.

Replace Voice Agent`cloudtalk_replace_voice_agent`

Replaces the voice agent with the attributes object.

Delete Voice Agent`cloudtalk_delete_voice_agent`

Deletes the voice agent.

Attach Voice Agent Knowledge Base`cloudtalk_attach_voice_agent_knowledge_base`

Links the knowledge base to the agent.

Detach Voice Agent Knowledge Base`cloudtalk_detach_voice_agent_knowledge_base`

Unlinks the knowledge base from the agent; the knowledge base itself is kept.

Create Voice Agent Call`cloudtalk_create_voice_agent_call`

Creates a new VoiceAgent call with specified parameters and properties.

Stop Voice Agent Outbound Calls`cloudtalk_stop_voice_agent_outbound_calls`

Emergency stop for outbound VoiceAgent dialing.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.