Operations 4
Documentation
Documentation
https://developers.cloudtalk.io/
Authentication
https://artifacts.apis.io/cloudtalk/authentication/cloudtalk-authentication.yml
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudtalk:cloudtalk-agents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: CloudTalk Agents API
description: '# Introduction
Welcome to CloudTalk API reference! Many of these businesses use the CloudTalk API to automate and enhance their customer support with CloudTalk Support. With CloudTalk we are re-building telco industry from the ground and taking it to the next level with first-class customer support system. Please find below the full documenation to CloudTalk. # API Overview
The API is organized around the following resources:
API Area | Description
----------------|-------------
Calls | Browse your call history, download recordings and access all your calls data. Contacts | Create and update Contacts. Use filters to get lists of Contacts, or access their profiles individually. Numbers | Automate Numbers modifications. List all your numbers. Agents | Create or update your Agents, access their settings. Conversation Intelligence | Get Conversation Intelligence data about your calls. VoiceAgent | Initiate VoiceAgent calls
JSON is returned in all responses. XML is not supported. The API also uses common approaches for the following:
Function | Description
----------------|-------------
Data | API data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects. Errors | 4xx and 5xx responses returning JSON with error codes
Rate Limiting | Controls how many requests can be made in a time window
HTTP | Methods are used in accordance with HTTP (GET POST and DELETE are the primary methods used) and resources are identified using URIs. All API requests are sent over HTTPS. ## Authentication
This is an HTTPS-only API. Authentication is based on API Access Key ID and Access Key Secret. The API Access Key ID and Access Key Secret is passed via HTTP Basic Authentication. Basic Auth credentials are used to determine on which project should this request be executed on. List of all Basic Auth credentials for the project can be found by Administrators in the CloudTalk Dashboard under Account → Settings → API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys). To try the API via curl on the command-line, the general form used would be:
```
curl -u ACCESS_KEY_ID:ACCESS_KEY_SECRET API_URL
```
For instance, you would execute:
```
curl -u ABCDEFGHIJTESTKEY1:X05Dg4c331c3h61An https://my.cloudtalk.io/api/calls/index.json
```
## Usage
The API may rate limit submission of requests for your application. Such limits are managed as an allowed number of operations per time window, where an operation might be read or an update. In that case a **''429 Too Many Requests''** response code will be returned along with the following headers -
Header name | Description
----------------|-------------
X-CloudTalkAPI-Limit | Maximum number of API requests allowed in the current time window. X-CloudTalkAPI-Remaining | Number of API requests left in the current window. X-CloudTalkAPI-ResetTime | Time when rate limit window will be reset as a Unix timestamp. Note that the default rate limit is **60 operations per minute per company**. If you need to make more requests, please contact our support with detailed explanation of your use case. ## Response Envelopes
**Note:** Conversation Intelligence doesn''t follow envelopes. The API returns one of three envelopes depending upon the request issued:
1. Single Item Envelope
2. Collections Envelope
3. Error Envelope
### Single Item Envelope
All dates/times are returned in ISO8601 format and in UTC timezone. ```
Status: 200 OK
{
"responseData": {
"id": 123,
... "created": "2018-01-10 12:34:56"
}
}
```
### Collections Envelope
All dates/times are returned in ISO8601 format and in UTC timezone. ```
Status: 200 OK
{
"responseData": {
"itemsCount": 65,
"pageCount": 3,
"pageNumber": 1,
"limit": 30,
"data": [
{
"id": 123,
... "created": "2018-01-10 12:34:56"
},
{
"id": 456,
... "created": "2017-10-19 09:21:29"
},
...'
contact:
name: CloudTalk API Support
url: https://www.cloudtalk.io/contact
version: '1.7'
x-logo:
url: https://my.cloudtalk.io/img/logo-cloudtalk-color.png
servers:
- url: https://my.cloudtalk.io/api
security:
- basicAuth: []
tags:
- name: Agents
description: All data you can get about your agents.
paths:
/agents/index.json:
get:
tags:
- Agents
summary: List agents
description: Returns agents of the company. `availability_status` reflects the agent's current state; when the agent state source is temporarily unavailable it is returned as "unknown" and the listing still succeeds.
parameters:
- name: id
in: query
description: Filter by agent ID
schema:
type: integer
- name: limit
in: query
description: Max. number of items in response data.
schema:
maximum: 1000
minimum: 1
type: integer
- name: page
in: query
description: Number of page to return.
schema:
minimum: 1
type: integer
- name: associated_number
in: query
description: Filters agents by their assigned number. Please enter a valid number in e164 format
schema:
type: string
responses:
'200':
description: Agents data
content:
application/json:
schema:
type: object
properties:
responseData:
type: object
properties:
itemsCount:
type: integer
description: number of resources in the response
format: int64
pageCount:
type: integer
description: number of pages found
format: int64
pageNumber:
type: integer
description: current page in the response
format: int64
limit:
type: integer
description: number of objects sent per page
format: int64
data:
type: array
items:
type: object
properties:
Agent:
$ref: '#/components/schemas/Agent'
required:
- responseData
example:
responseData:
itemsCount: 3
pageCount: 1
pageNumber: 1
limit: 3
data:
- Agent:
id: '99'
name: '123456'
firstname: John
lastname: Doe
email: joh.doe@phoonio.com
is_daily_limit_ok: true
status_outbound: true
availability_status: online
extension: '1001'
call_number_id: 36
default_number: '+421123456789'
associated_numbers:
- '+421123456789'
- '+421987654321'
operationId: getAgentsIndexJson
x-operation-id-source: derived
/agents/add.json:
put:
tags:
- Agents
summary: Add an agent
description: 'Creates an agent. `firstname`, `lastname`, `email` and `pass` are required. The optional fields allow outbound calling (`status_outbound`), cap daily call spend in EUR (`daily_price_limit`, 1–200), assign a four-digit `extension` that must be unique across the company (1000–9999), and set a default outbound number (`call_number_id`). Returns `201` with the new agent''s ID; `403` means the account has reached its maximum number of agents.
Note the core API creates with `PUT`, not `POST`.'
requestBody:
content:
application/json:
schema:
required:
- email
- firstname
- lastname
- pass
type: object
properties:
firstname:
type: string
description: First name
lastname:
type: string
description: Last name
email:
type: string
description: Email
format: email
pass:
type: string
description: Password
status_outbound:
type: boolean
description: Does agent have outbound calls allowed?
daily_price_limit:
maximum: 200
minimum: 1
type: integer
description: Daily price limit for all calls in EUR. Usually allowed values are from 1 to 200 EUR. Leave empty for using default value.
extension:
maximum: 9999
minimum: 1000
type: integer
description: Extension of an agent. Extension must be four digits long and be unique across whole company.
call_number_id:
minimum: 1
type: integer
description: Default outbound number ID
required: true
responses:
'201':
description: No error
content:
application/json:
schema:
type: object
properties:
responseData:
type: object
properties:
status:
type: integer
description: Status code
data:
type: object
properties:
id:
type: integer
description: Agent ID
required:
- responseData
example:
responseData:
status: 201
data:
id: '12345'
'403':
description: Max. number of agents reached
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
example:
responseData:
status: 403
message: Max. number of agents reached.
'406':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInvalidData'
example:
responseData:
status: 406
message: Invalid input data.
data:
email:
- Please supply a valid email address.
'500':
description: Something went wrong
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
example:
responseData:
status: 500
message: Something went wrong.
x-codegen-request-body-name: body
operationId: putAgentsAddJson
x-operation-id-source: derived
/agents/edit/{agentId}.json:
post:
tags:
- Agents
summary: Edit an agent
description: 'Updates the agent identified by `agentId`. `firstname`, `lastname` and `email` must be sent on every request, even when unchanged. The agent''s password cannot be changed here. Returns `404` if no agent has that ID.
Note the core API updates with `POST`, not `PUT`.'
parameters:
- name: agentId
in: path
description: Agent ID to edit
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
required:
- email
- firstname
- lastname
type: object
properties:
firstname:
type: string
description: First name
lastname:
type: string
description: Last name
email:
type: string
description: Email
format: email
status_outbound:
type: boolean
description: Does agent have outbound calls allowed?
daily_price_limit:
maximum: 200
minimum: 1
type: integer
description: Daily price limit for all calls in EUR. Usually allowed values are from 1 to 200 EUR. Leave empty for using default value.
call_number_id:
minimum: 1
type: integer
description: Default outbound number ID
required: true
responses:
'200':
description: No error
content:
application/json:
schema:
type: object
properties:
responseData:
type: object
properties:
status:
type: integer
description: Status code
required:
- responseData
example:
responseData:
status: 200
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
example:
responseData:
status: 404
message: Not found.
'406':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInvalidData'
example:
responseData:
status: 406
message: Invalid input data.
data:
email:
- Please supply a valid email address.
'500':
description: Something went wrong
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
example:
responseData:
status: 500
message: Something went wrong.
x-codegen-request-body-name: body
operationId: postAgentsEdit{agentId}Json
x-operation-id-source: derived
/agents/delete/{agentId}.json:
delete:
tags:
- Agents
summary: Delete an agent
description: Deletes the agent identified by `agentId`. Returns `404` if no agent has that ID.
parameters:
- name: agentId
in: path
description: Agent ID to delete
required: true
schema:
type: integer
responses:
'200':
description: No error
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessGeneralData'
example:
responseData:
status: 200
'404':
description: Agent not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
example:
responseData:
status: 404
message: Not found.
operationId: deleteAgentsDelete{agentId}Json
x-operation-id-source: derived
components:
schemas:
ErrorInvalidData:
type: object
description: Validation-error envelope returned by the core API on `my.cloudtalk.io/api`. The payload is always wrapped in `responseData`.
properties:
responseData:
type: object
properties:
status:
type: integer
description: HTTP status code
message:
type: string
description: The error message
data:
type: object
properties: {}
description: Field-level detail explaining the error
required:
- status
- message
required:
- responseData
SuccessGeneralData:
type: object
description: Success envelope returned by the core API on `my.cloudtalk.io/api`. The payload is always wrapped in `responseData`.
properties:
responseData:
type: object
properties:
status:
type: integer
description: Status code
required:
- responseData
Agent:
type: object
properties:
id:
type: integer
description: Agent ID
name:
type: string
description: Agent\'s Voice ID
firstname:
type: string
description: First name
lastname:
type: string
description: Last name
email:
type: string
description: Email
format: email
pass:
type: string
description: Password
daily_price_limit:
maximum: 200
minimum: 1
type: integer
description: Daily price limit for all calls in EUR. Usually allowed values are from 1 to 200 EUR. Leave empty for using default value.
is_daily_limit_ok:
type: boolean
description: Is daily price limit OK? If not, agent cannot make new calls
status_outbound:
type: boolean
description: Does agent have outbound calls allowed?
availability_status:
type: string
description: Current availability status of the agent; "unknown" is returned when the agent state source is temporarily unavailable
enum:
- online
- offline
- paused
- calling
- unknown
extension:
maximum: 9999
minimum: 1000
type: integer
description: Extension of an agent. Extension must be four digits long and be unique across whole company.
call_number_id:
minimum: 1
type: integer
description: Default outbound number ID
default_number:
type: string
description: Default outbound number in E164 format
associated_numbers:
type: array
description: array of e164 numbers that the agent has assigned
items:
type: string
description: Agent data
ErrorData:
type: object
description: Error envelope returned by the core API on `my.cloudtalk.io/api`. The payload is always wrapped in `responseData`.
properties:
responseData:
type: object
properties:
status:
type: integer
description: HTTP status code
message:
type: string
description: The error message
required:
- status
- message
required:
- responseData
securitySchemes:
basicAuth:
type: http
scheme: basic
description: 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).
x-provenance:
method: harvested
publisher: CloudTalk
source: https://help.cloudtalk.io/api-reference/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)