Contact Center AI API List - Kore.ai Docs

Back to Main API List The following tables list the APIs available for Contact Center AI, grouped by modules:

Contact Center AI (CCAI) APIs
Campaign Management APIs
Voice Gateway (VG) APIs

Contact Center AI (CCAI) APIs

Analytics and Reporting APIs

API	Description	Associated App Scope
Get Intent Real-Time Data	To retrieve the most recent conversational data for the given botId. Gets the latest 25 sessions data for the given botId that completed the execution of the flow.	SmartAssist Analytics
Historical Agent Status Summary	To retrieve the status of every agent for each bucket in the given time interval. The status shown can be available, busy, away, etc.	SmartAssist Analytics
Agent Status Details API	To retrieve the status of every agent for each bucket in the given time interval. The status shown can be available, busy, away, etc.	SmartAssist Analytics
Get All Conversations Data - Call Details	To retrieve the raw data for all conversations with the given Account Id.	SmartAssist Analytics
Get All Conversations Data - Call Details (v2)	To retrieve the raw data for all conversations with the given Account Id.	SmartAssist Analytics
Get Conversations Details	This API retrieves detailed information about a specific conversation session. It provides participant details, transfer history, queue activity, conversation status, notes, and dispositions.	SmartAssist Analytics
List of Conversations	To retrieve the list of conversations with the given stream Id.	SmartAssist Analytics
Get a specific Conversation	To retrieve a particular conversation by providing the Conversation Id.	SmartAssist Analytics
Queue Size	To retrieve the queueDetails by giving queueId and filters with the given stream Id.	SmartAssist Analytics

Agent Creation APIs

API	Description	Associated App Scope
Create an Agent	To add an agent with the given Stream Id.	SmartAssist Analytics
List All Agents	To retrieve the list of all agents with the given Stream Id.	SmartAssist Analytics
Get a Specific Agent	To retrieve the details of a particular agent with the given stream Id and agent Id.	SmartAssist Analytics
Update a Specific Agent	To update the details of a particular agent with the given Stream Id and Agent Id.	SmartAssist Analytics
Delete a Specific Agent from a Particular Agent Group	To delete a particular agent with the given Stream Id and Agent Id.	SmartAssist Analytics
Get the Agent ID Using the Custom ID	To get the Agent ID associated with a Custom ID (extension number).	Configuration
Check Agent Availability Status	To check the availability of agents based on specified skill Ids, queue Ids, and agent Ids.	Configuration

Skills APIs

API	Description	Associated App Scope
Create a Skill	To add a skill with the given Stream Id and Skill Group ID.	SmartAssist Analytics
Get All Skills from a Skill Group	To retrieve the list of skills with the given Stream Id and Skill Group Id.	SmartAssist Analytics
Get a Particular Skill	To retrieve the details of a particular skill with the given Stream Id, Skill Group Id, and Skill Id.	SmartAssist Analytics
Update a Particular Skill	To update a particular skill with the given Stream Id, Skill Group Id, and Skill Id.	SmartAssist Analytics
Delete a Skill from a Particular Skill Group	To delete a particular skill with the given Stream Id and Agent Id.	SmartAssist Analytics

Skill Group APIs

API	Description	Associated App Scope
Create a Skill Group	To add a Skill Group with the given Stream Id.	SmartAssist Analytics
Get All Skill Groups	To retrieve the list of skills groups with the given Stream Id.	SmartAssist Analytics
Get a Skill Group	To retrieve the details of a particular skill group with the given Stream Id and Skill Group Id.	SmartAssist Analytics
Update a Skill Group	To update a particular skill group with the given Stream Id and Skill Group Id.	SmartAssist Analytics
Delete a Skill Group	To delete a particular skill group with the given Stream Id and Skill Group Id.	SmartAssist Analytics

Agent Group APIs

API	Description	Associated App Scope
Create an Agent Group	To add an agent group with the given Stream Id.	SmartAssist Analytics
Get All Agent Groups	To retrieve the list of agent groups with the given Stream Id.	Configuration
Get an Agent Group	To retrieve the details of a particular skill with the given Stream Id, Skill Group Id, and Skill Id.	SmartAssist Analytics
Update an Agent Group	To update a particular agent group with the given Stream Id and Agent Group Id.	SmartAssist Analytics
Delete an Agent Group	To delete the particular skill group with the given Stream Id and Skill Group Id.	SmartAssist Analytics

Contacts Public APIs

API	Description	Associated App Scope
Create a Contact by Giving Details	To create a contact with the given Stream Id.	Configuration
Create Bulk Contacts	To create bulk contacts from a CSV file with the given Stream Id.	Configuration
Get All Contacts	To retrieve all contacts created for outbound calling in a given stream ID.	Configuration
Update a Contact	To update a specific contact associated with a stream ID.	Configuration
Update Bulk Contacts	To update multiple contacts simultaneously.	Configuration
Delete a Contact	To delete a specific contact.	Configuration
Delete Bulk Contacts	To delete multiple contacts simultaneously.	Configuration
Custom Speech Service	To create a custom speech service integration.	Configuration

Import/Export Data APIs

API	Description	Associated App Scope
Import/Save Data by Giving Details	To import/save data with the given accountId and orgId.	SmartAssist Import and Export Feature
Import/Save Data by Giving Details (v2)	To import/save data with the given accountId and orgId.	SmartAssist Import and Export Feature
Export Data by Giving Details	To export data with the given accountId and orgId.	SmartAssist Import and Export Feature
Export Data by Giving Details (v2)	To export data with the given accountId and orgId.	SmartAssist Import and Export Feature

Transfer Conversation to a Specific Agent or Queue API

API	Description	Associated App Scope
Transfer Conversation to a Specific Agent	To transfer a conversation to a specific agent using the provided botSessionId and aId. It posts specific messages to the provided callbackUrl to indicate the success or failure of the conversation transfer.	Routing

Queue APIs

API	Description	Associated App Scope
Create a Queue	To create a queue with the given streamId.	Configuration
Get a List of Queues	To get a list of queues with the given streamId.	Configuration
Get a List of Agents or Queues	To get all agents if you have queueIds and all the queues if you have agentIds.	Configuration
Get a Specific Queue	To get a specific queue with the given streamId and queueId.	Configuration
Update a Specific Queue	To update a specific queue with the given streamId and queueId.	Configuration
Delete a Queue	To delete a specific queue with the given streamId and queueId.	Configuration
Update Queue Priority	To update the queue priorities on a scale of 1 to 10.	Configuration

WFM APIs

API	Description	Associated App Scope
Agents API	To get all agent details associated with an accountId.	WFM Integration
Queues API	To get the Queues/Skills associated with an accountId.	WFM Integration
Agent Activity API	To get the agent status in real-time or changes stacked every 30 seconds.	WFM Integration
Contact Volume API	To retrieve call volume details associated with a specified collection point for a given interval, including fields mapped to specific field names relevant to the Workforce Management (WFM) client.	WFM Integration

Hours of Operation API

API	Description	Associated App Scope
Hours of Operation	To get the hours of operation by providing the orgId and queueId.	Configuration

Campaign Management APIs

SMS Campaigns

API	Description	Associated App Scope
Create SMS Campaign (Without SMS Template)	Creates an SMS campaign with a “None” message format.	Campaign Management
Create SMS Campaign (Without SMS Template (v2))	Creates an SMS campaign with a “None” message format. In this version, the DNC (Do Not Call) object is included in the request body as an optional field, allowing users to specify the relevant do-not-call contact list when needed.	Campaign Management
Create SMS Campaign (Using Template)	Creates an SMS campaign using a predefined message template.	Campaign Management
Create SMS Campaign (Using Template (v2))	Creates an SMS campaign using a predefined message template. In this version, the DNC (Do Not Call) object is included in the request body as an optional field, allowing users to specify the relevant do-not-call contact list when needed.	Campaign Management
Create SMS Campaign (Advanced Format)	Creates an SMS campaign with advanced formatting using a specified experience flow and contact list.	Campaign Management
Create SMS Campaign (Advanced Format(v2))	Creates an SMS campaign with advanced formatting using a specified experience flow and contact list. In this version, the DNC (Do Not Call) object is included in the request body as an optional field, allowing users to specify the relevant do-not-call contact list when needed.	Campaign Management
Get SMS Campaign by ID	Retrieves full details of an SMS campaign using the campaign ID.	Campaign Management
Get SMS Campaign by ID (v2)	Retrieves full details of an SMS campaign using the campaign ID.	Campaign Management
Update SMS Campaign	Updates an existing SMS campaign with new format, contact lists, experience flow, or dialing strategy.	Campaign Management
Update SMS Campaign (v2)	Updates an existing SMS campaign with new format, contact lists, experience flow, or dialing strategy.	Campaign Management
Start SMS Campaign	Starts an SMS campaign using stream ID and campaign ID.	Campaign Management
Start SMS Campaign (v2)	Starts an SMS campaign using stream ID and campaign ID.	Campaign Management
Stop SMS Campaign	Stops an active SMS campaign using stream ID and campaign ID.	Campaign Management
Stop SMS Campaign (v2)	Stops an active SMS campaign using stream ID and campaign ID.	Campaign Management
Delete SMS Campaign	Deletes an active SMS campaign using stream ID and campaign ID.	Campaign Management
Delete SMS Campaign (v2)	Deletes an active SMS campaign using stream ID and campaign ID.	Campaign Management
Send Outbound SMS	This API enables sending outbound SMS messages through the platform’s generic SMS channel. The capability can be integrated into applications or services to facilitate SMS communication with customers.	Outbound SMS

Voice Campaigns

API	Description	Associated App Scope
Create Voice Campaign - Agentless Mode	Creates a new outbound voice campaign with agentless dialing.	Campaign Management
Create Voice Campaign - Agentless Mode (v2)	Creates a new outbound voice campaign with agentless dialing. In this version, the DNC (Do Not Call) object is included in the request body as a mandatory field, requiring users to specify the appropriate do-not-call contact list. Additionally, enableMachineDetect now supports three options—no, detect, and disconnect—to control how answering machines or voicemails are handled during outbound calls.	Campaign Management
Create Voice Campaign - Progressive Mode	Creates a voice campaign that routes answered calls to live agents using progressive dialing.	Campaign Management
Create Voice Campaign - Progressive Mode (v2)	Creates a voice campaign that uses progressive dialing to route answered calls to live agents. In API v2, the DNC (Do Not Call) object is a mandatory request body parameter, and the enableMachineDetect parameter has been removed, as it’s no longer supported for progressive campaigns.	Campaign Management
Create Voice Campaign - Preview Mode	Creates a voice campaign that lets agents preview contact info before calling. Routes answered calls to a queue.	Campaign Management
Create Voice Campaign - Preview Mode (v2)	Creates a voice campaign that lets agents preview contact info before calling. Routes answered calls to a queue. In API v2, the DNC (Do Not Call) object is a mandatory request body parameter, and the enableMachineDetect parameter has been removed, as it’s no longer supported for preview campaigns.	Campaign Management
Update Voice Campaign	Updates the configuration of an existing voice campaign, including metadata, strategies, and schedules.	Campaign Management
Update Voice Campaign (v2)	Updates the configuration of an existing voice campaign, including metadata, DNC list, strategies, and schedules.	Campaign Management
Get Voice Campaign by ID	Fetches complete details of a voice campaign using campaign ID.	Campaign Management
Get Voice Campaign by ID (v2)	Fetches the complete details of a voice campaign, including its DNC list, using the campaign ID.	Campaign Management
Start Voice Campaign	Starts an active voice campaign using stream ID and campaign ID.	Campaign Management
Start Voice Campaign (v2)	Starts an active voice campaign using stream ID and campaign ID.	Campaign Management
Stop Voice Campaign	Stops an active voice campaign using stream ID and campaign ID.	Campaign Management
Stop Voice Campaign (v2)	Stops an active voice campaign using stream ID and campaign ID.	Campaign Management
Delete Voice Campaign	Deletes an active voice campaign using stream ID and campaign ID.	Campaign Management
Delete Voice Campaign (v2)	Deletes an active voice campaign using stream ID and campaign ID.	Campaign Management
Create a call back schedule (v2)	Lets third-party tools schedule a call with a contact who requests to be reached at a later date and time.	Campaign Management

Campaign Status

API	Description	Associated App Scope
Get Campaign Status	Retrieves the current status (active, stopped, etc.) of a campaign using its campaign ID.	Campaign Management
Get Campaign Status (v2)	Retrieves the current status (active, stopped, etc.) of a campaign using its campaign ID.	Campaign Management

Campaign Schedule

API	Description	Associated App Scope
Enable Daily Scheduling of Voice or SMS Campaign	To schedule a recurring daily Voice or SMS campaign.	Campaign Management
Enable Weekly Scheduling of Voice or SMS Campaign	To schedule a recurring weekly Voice or SMS campaign.	Campaign Management
Disable a Scheduled Voice or SMS Campaign API	To disable a previously scheduled Voice or SMS campaign.	Campaign Management

Campaign Details

API	Description	Associated App Scope
Get All Campaigns	Retrieves all campaigns associated with a specific account.	Campaign Management
Get All Campaigns (v2)	Retrieves all campaigns associated with a specific account.	Campaign Management

Contact List Management

API	Description	Associated App Scope
Get All Contact Details - Voice Campaigns	Retrieves metadata for all contact lists under a specific account, filtered by type.	Campaign Management
Get All Contact Details - Voice Campaigns (v2)	Retrieves metadata for all contact lists under a specific account, filtered by type.	Campaign Management
Create Contact List	Creates a new contact list for use in passive voice campaigns.	Campaign Management
Create Contact List (v2)	Creates a new contact list for use in passive voice campaigns.	Campaign Management
Update Contact List	Updates the name of a contact list associated with a campaign.	Campaign Management
Update Contact List (v2)	Updates the name of a contact list associated with a campaign.	Campaign Management
Get Contact List Details	Retrieves full details of a specific contact list using its ID.	Campaign Management
Get Contact List Details (v2)	Retrieves full details of a specific contact list using its ID.	Campaign Management
Get All Contact List Details	Retrieves full details of a specific contact list using its ID.	Campaign Management
Get All Contact List Details (v2)	Retrieves full details of a specific contact list using its ID.	Campaign Management
Add Contacts to a Contact List	Adds one or more contacts to an existing contact list.	Campaign Management
Delete Contact List Details	Deletes a contact list associated with a campaign.	Campaign Management
Delete Contact List Details (v2)	Deletes a contact list associated with a campaign.	Campaign Management
Get Contacts of Contact List	Retrieves all contacts of a specific contact list.	Campaign Management
Get Contacts of Contact List (v2)	Retrieves all contacts of a specific contact list.	Campaign Management

Voice Gateway (VG) APIs

Call Recording APIs

API	Description	Associated App Scope
Fetch Call Recording	To retrieve the recording of a specific call using either the user Id or session Id.	SmartAssist Recordings
Fetch Call Recording (v2)	This API facilitates the downloading of voice call recordings. The API provides an S3-hosted URL where the recording can be accessed.	SmartAssist Recordings
Delete Call Recording	This API is used to delete Voice Call Recordings. The response varies based on whether the execution is successful or not.	Delete Recordings

Voicemail Recording API

API	Description	Associated App Scope
Fetch Voicemail Recording	This API facilitates the downloading of voicemail recordings. The API provides an S3-hosted URL where the voicemail recording can be accessed.	SmartAssist Voicemail

Outbound Calling API

API	Description	Associated App Scope
Outbound Calling (VG)- v1	To trigger an outbound call and receive call status notifications.	SmartAssist Dialout
Outbound Calling (VG)-v2	To trigger an outbound call and receive call status notifications. In v2, the system sends Automatic Machine Detection (AMD) configurations on invoking the API, enabling the detection process to start earlier. This improves performance and reduces latency.	SmartAssist Dialout