Table of Contents
Drive better business decisions and transform your growth with the industry’s most powerful conversation analytics platform.
API Overview
API Request Limits
Free Plan
100 API calls per day
Standard Plan
1,000 API calls per day
Premium Plan
5,000 API calls per day
Enterprise Plan
10,000 API calls per day
SDKs
APIs
Method: GET
Description: Get a list of conversations..
Endpoint: /conversations
Parameters: page_size, page_token, order, filter, multi-channel_filter, channel_filter, application_filter, enterprise_filter, query, access_token,
Method: GET
Description: Get a list of messages..
Endpoint: /messages
Parameters: page_size, page_token, order, filter, query, access_token,
Method: GET
Description: Get a list of sessions..
Endpoint: /sessions
Parameters: page_size, page_token, order, filter, multi-channel_filter, channel_filter, application_filter, enterprise_filter, query, access_token,
Method: GET
Description: Get a list of configurations..
Endpoint: /configuration
Parameters: page_size, page_token, order, filter, access_token,
Method: GET
Description: Get a session by id..
Endpoint: /sessions/{session_id}
Parameters: access_token,
Method: GET
Description: Get a message by id..
Endpoint: /messages/{message_id}
Parameters: access_token,
Method: GET
Description: Get a conversation by id..
Endpoint: /conversations/{conversation_id}
Parameters: access_token,
Method: GET
Description: Get a configuration by id..
Endpoint: /configuration/{configuration_id}
Parameters: access_token,
Method: GET
Description: Get a list of channels..
Endpoint: /channels
Parameters: page_size, page_token, order, filter, access_token,
Method: GET
Description: Get a list of enterprises..
Endpoint: /enterprises
Parameters: page_size, page_token, order, filter, access_token,
Method: GET
Description: Get user detail..
Endpoint: /user
Parameters: access_token,
Method: GET
Description: Get a channel by id..
Endpoint: /channels/{channel_id}
Parameters: access_token,
Method: GET
Description: Get an enterprise by id..
Endpoint: /enterprises/{enterprise_id}
Parameters: access_token,
Method: GET
Description: Get a list of users..
Endpoint: /users
Parameters: page_size, page_token, order, filter, access_token,
Method: PUT
Description: Update user detail..
Endpoint: /user
Parameters: access_token,
Method: GET
Description: Get a user by id..
Endpoint: /users/{user_id}
Parameters: access_token,
Method: GET
Description: Get a list of applications..
Endpoint: /applications
Parameters: page_size, page_token, order, filter, access_token,
Method: PUT
Description: Update a configuration..
Endpoint: /configuration/{configuration_id}
Parameters: access_token,
Method: GET
Description: Get an application by id..
Endpoint: /applications/{application_id}
Parameters: access_token,
FAQ
What authentication method is used by the CallMiner APIs?
The CallMiner APIs use OAuth 2.0 for authentication, providing a secure and standardized way for developers to access the API.
Are there any rate limits imposed on API requests?
Yes, rate limits are in place to prevent excessive usage and ensure the stability of the API platform. Developers should be mindful of these limits and implement appropriate usage patterns.
Can I create a sandbox account for testing purposes?
Yes, CallMiner offers sandbox accounts that provide a dedicated environment for developers to test and explore the APIs without affecting live data.
How do I obtain a developer account to access the CallMiner APIs?
To obtain a developer account, visit the CallMiner Partner Portal (https://partner.callminer.com) and follow the registration process for developers.
What resources are available for learning about the CallMiner APIs?
CallMiner provides comprehensive documentation (https://developer.callminer.com/docs), code samples, and a dedicated support forum for developers to access resources and connect with the CallMiner API team.