Overview
The deepcall API is a RESTful API.
It provides you with an easy way to access and submit your deepcall data programmatically. With the help of these APIs you can integrate your CRM or any third-party software with our Contact Centre solution.
It works on REST semantics, uses JSON as an object response and standard HTTP codes to signal operation status.
You can use deepcall API to -
-
Fetch Call Reports
-
Pull Analytical Performance Reports
-
Get Live Data
-
Create and Update endpoints like, agents, groups, contact lists, etc.
-
Generate Calls, etc.
Note: The deepcall API is in Beta. As we update and release newer versions of the API, we reserve the right to remove older APIs and functionality with a deprecation notice.
Authentication
deepcall uses a simple token-based authentication system. To generate your API key, please visit My Profile -> API Token section. Please make sure to keep this API key safe, it carries all the information of your user account and it's underlying data.
All API requests must be authenticated and made over HTTPS.
Common Error Codes
| Code | Message |
|---|---|
| 1000 | Invalid parameters |
| 1001 | Invalid data type |
| 1002 | UserId not provided |
| 1003 | AgentId does not exist |
| 1004 | File not found |
| 1005 | Contact number not valid |
| 1006 | GroupId does not exist |
| 1007 | Cli number not found |
| 1008 | Cli number is not valid |
| 1009 | Something went wrong |
| 1010 | Error in DB Connect |
| 1011 | Invalid credentials |
| 1012 | No data found |
| 1013 | Invalid user id |
| 1014 | Invalid token |
| 1015 | Permission denied |
| 1016 | Agent data not found |
| 1017 | Error getting DB Details |
| 1018 | Invalid panel package id |
| 1019 | Invalid response |
| 1020 | Token not found |
| 1021 | Invalid module |
| 1022 | Field cannot be empty |
| 1023 | Invalid email address |
| 1024 | Invalid character found, only letters, whitespace, and dot(.) are allowed |
| 1025 | Invalid Url |
| 1026 | Invalid number, only integer or float are allowed |
| 1027 | Invalid contact number |
| 1028 | Invalid date format |
| 1029 | Invalid field value |
| 1030 | Invalid or empty array |
| 1031 | Invalid list field value |
| 1032 | Internal server error |
| 1033 | Service unavailable |
| 1034 | field cross maximum limit of 30 characters |
| 1035 | field has invalid character |
| 1036 | field value has invalid character |
| 1037 | Number of characters cross maximum limit of 60 characters |