Error Code and Error Message
| Error Code | Error Message | Description |
|---|---|---|
| -2 | INTERNAL SERVER ERROR | Internal server error. |
| -1 | FAILURE | API request fail. |
| 0 | SUCCESS | API request success. |
| 1 | PARTIAL SUCCESS | API request partially success. |
| 2 | PROCESSING | The request is in progressing. |
| 10001 | INTERFACE NOT EXISTED | The interface does not exist. |
| 10002 | API VERSION OUT OF MAINTENANCE | The API version is out of maintenance. |
| 10003 | API VERSION UNSUPPORTED | The API version is not supported. |
| 10004 | TOKEN EXPIRED | The access token or web session is time out. |
| 10005 | ACCESS DENIED | No access permission. |
| 10009 | OPERATION FAILED | The operation failed, which may be due to a disabled feature or insufficient permissions. |
| 40001 | PARAMETER SYNTAX ERROR | Wrong parameter syntax. |
| 40002 | PARAMETER ERROR | Invalid parameter. Example Scenario: The root directory of organization is inoperable; No data can be deleted; The position can not be changed, etc. |
| 40003 | DUPLICATE KEY VALUE | Duplicated parameter value. |
| 40004 | FILE SIZE EXCEEDED | The size of the uploaded or imported file exceeds the limit. |
| 60001 | DATA NOT FOUND | The data does not exist. |
| 60002 | MAX LIMITATION EXCEEDED | Creating operation fails as the existing quantity has reached the limit. Example Scenario: The number sub-organization has reached the limit. |
| 60101 | ROLE NOT EXISTED | The role does not exist. |
| 70004 | ACCOUNT IP BLOCKED | The IP address has been blocked. |
| 70022 | FILE ALREADY EXISTS | The uploaded certificate already exists or the uploaded certificate's domain name is duplicated. |
| 70023 | CERTIFICATE UPLODE FAILED | The certificate upload failed, possibly due to format errors or an invalid certificate. |
| 70082 | OVERLOAD_TASK_RUNNING | An overload task is running. |
| 70084 | ACTION FORBIDDEN | The action is forbidden. |
| 70087 | IP FORBIDDEN | The request IP is forbidden. |
| 70091 | CONNECTION_RELATION_EXISTED | The item has relation connection with other existing items. Example scenario: When deleting a company contact, this error means that the contact has been selected in a phonebook. |
| 70093 | PHONEBOOK_NOT_EXISTED | The phonebook does not exist. |
| 70106 | RATE_NOT_EXISTED | The rate does not exist. |
| 70120 | ORGANIZATION DISABLED | Operation fails as the organization is disabled. |
| 70123 | API UNAVAILABLE | API feature is unavailable. |
| 70128 | CONTACTS_NOT_EXISTED | The contact does not exist. |
| 70130 | CAHNNEL ID NOT FOUND | The call channel ID does not exist. |
| 70132 | OPERATION NOT SUPPORTED | The channel operation is not supported. |
| 70510 | MAX PARTICIPANTS EXCEEDED | The number of participants in an audio conference has reached the limit. |
| 70516 | WAKEUP CALL ALARM NOT EXISTED | The alarm does not exist. |
| 70524 | CAN'T CHECKOUT WHEN PMS CHECKIN | Check-out operation could not be performed through this interface when the system is integrated with PMS. |
| 70525 | CAN'T OPERATE WITH PMS CONNECT | Operation through this interface is NOT allowed when the system is integrated with PMS. |
| 70537 | RESPONSE_ERRCODE_DEST_NOT_EXISTED | The destination does not exist. |
| 70536 | RESPONSE_ERRCODE_LANGUAGE_NOT_EXISTED | The language does not exist. |
| 70539 | RESPONSE_ERRCODE_IVR_ADVANCED_SETTING_FORBID | Operation through this interface is NOT allowed when the advanced setting of the IVR is enabled. |
| 70542 | PROMPT NOT EXISTED | The system prompt language doesn't exist in the PBX. |
| 70547 | MESSAGE SERVICE UNAVAILABLE | The Message service is not available. |
| 70550 | FILE TYPE NOT SUPPORTED | The file type is not supported. |
| 70584 | DUPLICATE DOMAIN NAME | Duplicate domain name in certificate application. |
| 70621 | RECIPIENT NUMBER CANNOT BE EMPTY | The recipient number cannot be empty. |
| 70623 | SENDING TIME CANNOT BE IN THE PAST | The sending time cannot be earlier than the current time. |
| 70651 | RESPONSE_ERRCODE_REACH_RECORDING_DOWNLOAD_LIMIT | The number of concurrent recording downloads exceeds the limit. |
| 70653 | THE CONVERSATION HAS BEEN ARCHIVED | The message session has been archived. |
| 70654 | THE CONVERSATION HAS NOT BEEN ARCHIVED | The message session is not archived. |
| 70655 | THE CONVERSATION HAS BEEN REMOVED | The message session has been removed. |
| 70656 | API FUNCTION IS NOT ENABLED | The API feature is not enabled. |
| 70657 | THE SESSION HAS EXPIRED AND ONLY TEMPLATE MESSAGES OR MESSAGES WITH TAGS CAN BE SENT | The message session has expired; Only WhatsApp template messages or Facebook messages with tags can be sent. |
| 80010 | NO PERMISSION TO OBTAIN | No permission to obtain the specified resource. |
| 80011 | SESSION ALREADY EXISTS | The message session already exists. |
| 80012 | NO PERMISSION TO CREATE A SESSION | No permission to create a message session. |
| 80013 | INVALID CHANNEL NUMBER | The channel number is invalid. |
| 80014 | SESSION DOES NOT EXIST | The message session does not exists. |
| 80015 | ONLY ONE MESSAGE TYPE IS ALLOWED OR THE MESSAGE FORMAT IS INCORRECT | Only one message type can be sent at a time; The message format is invalid. |
| 80016 | SESSION CLOSED | The message session has been closed. |
| 80017 | THE SESSION CANNOT BE TRANSFERRED TO ITSELF | Session transferring to itself is not allowed. |
| 80018 | INVALID MESSAGE CHANNEL | The message channel is invalid. |
| 80019 | THE SESSION HAS NOT BEEN PICKED UP | The message session has not been picked up. |
| 80050 | THE SESSION CANNOT BE PICKED UP | The message session can not be picked up. |
| 80051 | THE MESSAGE QUEUE DOES NOT EXIST | The message queue does not exists. |
| 80052 | THE MESSAGE QUEUE HAS NO AGENTS | There are no agents in the message queue. |
| 80053 | SYSTEM MESSAGE DELETION IS NOT ALLOWED | System messages cannot be deleted. |