Common API - Global error and status codes
Global error and status codes
Interface exception error
Description: ret is not 200, msg is abnormal error message.
{
"ret":400, // status code
"data":[],
"msg":"Illegal request: invalid parameter"
}
ret |
msg |
illustrate |
400 |
illegal request |
Generally, the parameters are invalid |
500 |
|
Server Error |
600 |
|
The token is invalid, please log in again to verify |
601 |
appid is not authorized |
Please check the appid or contact Yunhu Technology for authorization |
602 |
|
appid authorization has expired |
603 |
|
Module not licensed |
604 |
IP is not authorized |
Please contact the manufacturer to authorize access |
二、The interface request is normal, but the internal processing error
Description: ret is 200. In the data structure, the status is 1, desc is the Chinese description of the failure, and errors is the detailed error information. For the code code, please refer to the corresponding description. msg is empty.
{
"ret": 200,
"data": {
"status": 1,
"desc": "xxxfail",
"errors": {
"code": "1003",
"codemsg": "Authorization failed"
},
"reqtime": 1507529858,
"rsptime": 1507529858
},
"msg": ""
}
code |
codemsg |
illustrate |
1001 |
Server connection failed |
Usually due to network |
1002 |
Abnormal operation |
Generally, it is a check exception, etc. |
1003 |
operation failed |
Generally, authorization failure, logout failure, command sending failure, server connection exception, etc. |
1010 |
Extension exception |
It may be a newly added extension, you need to log in again to get a new token |
1011 |
illegal extension |
not owned by the company |
1012 |
extension does not exist |
Extension Number Status |
1013 |
extension disabled |
Extension Number Status |
1014 |
extension not registered |
Extension Number Status |
1015 |
The extension is not in a call |
Extension Number Status |
1016 |
extension enabled |
Extension Number Status |
1017 |
extension is registered |
Extension Number Status |
1018 |
Number is enabled |
Caller ID status |
1019 |
number disabled |
Caller ID status |
1020 |
number does not exist |
Caller ID status |
1021 |
illegal number |
not owned by the company |
1024 |
task does not exist |
Predictive task interface return status |
1025 |
has not started |
Predictive task interface return status |
1026 |
in progress |
Predictive task interface return status |
1027 |
pause |
Predictive task interface return status |
1028 |
over |
Predictive task interface return status |
1201 |
idle |
Extension is legal, enabled and registered |
1202 |
ringing |
extension return |
1203 |
off-hook |
extension return |
1204 |
calling |
extension return |
1205 |
User rejects |
Called party rejects |
1210 |
Queue exception |
return in predictive outbound |
1211 |
illegal queue |
Does not exist or is not owned by the company |
1212 |
did not answer |
Assigned unanswered |
1213 |
Waiting |
Waiting for assignment (idle) |
1214 |
receiving |
Status of extensions in queue |
1215 |
answered |
Status of extensions in the queue |
1216 |
Reject |
Status of extensions in the queue |
1217 |
pause |
show busy |
1218 |
checked in |
The extension is already checked into the queue |
10001 |
hang up normally |
call state |
10002 |
call cancel |
call state |
10003 |
refuse to answer |
call state |
10004 |
Outbound channel line failure |
Usually due to wiring |
10005 |
User timed out |
call state |
10006 |
User is busy |
call state |
10040 |
caller hang up |
call state |
10041 |
Called hang up |
call state |