Global Return Code Description for API Integration - Imou Open Platform
Global return code description
When calling the HTTP API interface of the open platform, you may get a correct or incorrect return code. Developers can debug the interface based on the return code information and troubleshoot errors.
| Error code | Error code description | Scene description |
|---|---|---|
| 0 | Successful operation | |
| OP1001 | Operation failed | |
| OP1002 | The parameter is missing, please confirm whether the parameter is missing | In the request body, a required item does not exist in the params |
| OP1003 | The parameter value is illegal (the parameter format is wrong or empty), please correct the parameter value | 1. In the request body, there is a required item that is empty ("" or null); 2. There are regulations stipulated in the participation agreement The parameter type does not match; 3. The format of the passed parameter does not conform to the legal value description |
| OP1004 | Request content is empty | Request content is empty |
| OP1005 | Invalid request URL | Invalid request URL |
| OP1006 | SDK exception | 1. When calling the SDK, the head in the request body is empty; 2. There are fields in the head that are missing; 3. There are fields in the head that are empty |
| OP1007 | Invalid method call | 1. When external interface is called, system.appId is empty ("" or null); 2. When non-user module interface is called, params.token does not exist or params.token is empty ("" Or null) |
| OP1008 | appId is empty | system.appId value does not meet specifications |
| OP1009 | Insufficient permissions to perform this operation | 1. The device is not bound by the current user; 2. When the live interface is called, the appId is not in the whitelist; 3. When the live interface is called, the token is not an administrator token |
| OP1010 | The application is frozen | The current App status is frozen |
| OP1011 | The number of calls to the interface on the day has reached the upper limit | Whether the call of the non-published app exceeds the limit |
| OP1012 | Insufficient authority to call the interface | Insufficient authority to call the interface |
| OP1013 | The number of interface calls exceeds the limit (total number) | For some interfaces with a total number of calls limit, if the developer calls more than the configured number of times limit, this error code will be returned |
| OP1014 | The number of interface calls exceeds the limit (per day) | For some interfaces that have a limit on the total number of calls per day, if the developer calls more than the configured number of times limit, this error code will be returned |
| OP1015 | Insufficient permissions to perform this operation. (The device is not an open platform bound device) | Insufficient permissions to perform this operation. (This device is not an open platform binding device) |
| OP1016 | The requested device-related interface reaches the limit. | The number of device channels that the developer can operate each week cannot exceed the number of device accesses purchased by the current developer |
| OP1019 | No video generated during this time period | No video generated during this time period |
| OP1021 | Failed to obtain the playback address | Failed to obtain the playback address |
| OP1023 | kitToken has expired, please re-acquire | kitToken has expired, please re-acquire |
| OP1026 | Requests are too frequent, please try again later. | When the same user requests the same token-related interface at the same time, this error code will appear in rare cases |
| SN1001 | Signature exception | In the request body, the value of system.sign is inconsistent with the signature value calculated by OpenApi |
| SN1002 | Signature timeout | In the request body, the value of system.time should not deviate from the timestamp of the request by more than 5 minutes |
| SN1003 | Signature parameter error | In the request body, system.time is not a numeric value (including letters or special characters) |
| SN1004 | Illegal appid | Illegal appId |
| SN1005 | Duplicate nonce | Duplicate nonce. The nonce passed in when the developer calls the interface to the open platform cannot be repeated within 5 minutes, otherwise this error code will be returned |
| TK1001 | The user corresponding to this account (phone) has been bound to your application | |
| TK1002 | Token has expired or does not exist, please re-acquire token | Token has expired or does not exist, please re-acquire token |
| TK1003 | Illegal token, please pass in the correct token | Please check if the token and appId correspond. If the tokens of multiple appId accounts are mixed abnormally, this error code will be returned |
| TK1004 | The current user's mobile phone number has not been bound to your application | Please perform "user binding" first to perform user binding operation |
| TK1005 | The number of bound users exceeds the limit | The number of non-published app binding users exceeds the limit |
| TK1006 | The current mobile phone number is not the mobile phone number of the developer account. After the developer creates the application, you can find the administrator account in the open platform website> Development Center> Application Details page. | |
| TK2001 | Invalid csrfToken | |
| DV1001 | The device has been bound to another account | |
| DV1002 | Device does not exist | |
| DV1003 | The device has been bound to the current account | |
| DV1004 | Failed to update channel name | |
| DV1005 | Device verification code error | |
| DV1006 | No need to update the device, the device is already the latest version | |
| DV1007 | Device offline | |
| DV1008 | The number of bound devices exceeds the limit, please unbind other redundant devices first | The number of non-published app bound devices exceeds the limit. |
| DV1009 | The device is busy, please try again later | The device that needs to be operated is processing the previous request |
| DV1010 | The image request is too frequent, please try again later | The image capture interface is called too frequently, and the same device has multiple requests for image capture within 1s |
| DV1011 | The device has not been added, please bind the device first | The device to be operated has not been added by the current account |
| DV1012 | Insufficient permissions, the device is an authorized (or shared) device | |
| DV1013 | The device is bound after 3 days of registration. The client and the device must be in the same local area network. The device can be bound again when the device is powered off and restarted. | |
| DV1014 | Device binding error exceeds 10 consecutive times, limit binding for 30 minutes | |
| DV1015 | Device binding error exceeds 20 consecutive times, limit binding for 24 hours | |
| DV1016 | The device password is incorrect. | |
| DV1018 | The device is registered to the platform and has not been bound for more than three days. It needs to be bound in the local area network or the device is bound after restarting | The device has not been bound for more than three days after being registered on the platform |
| DV1019 | Device capability set does not support this operation | |
| DV1020 | The device channel is offline. | |
| DV1021 | The device is abnormal. | |
| DV1022 | The number of favorite points exceeds the limit | |
| DV1023 | Favorite point already exists | |
| DV1024 | Collection point does not exist | |
| DV1025 | Device SC code or device password error | |
| DV1026 | The device does not support the call of this function | |
| DV1027 | Device security code error | |
| DV1028 | The user has not bound the device or the device channel number does not exist | |
| DV1029 | The device has been bound | |
| DV1030 | Device is sleeping | |
| DV1031 | Low battery refused to upgrade (with battery equipment) | |
| DV1034 | Device not initialized | |
| DV1035 | Device initialization failed | |
| DV1036 | Logout failed, the device has not been offline for 5 minutes | |
| DV1037 | The imei and device id of the NB device do not match | |
| DV1038 | Cannot add temporary key when battery is low | |
| DV1039 | Temporary key generation does not meet the conditions | |
| DV1040 | The device has been failed to bind 20 times. Limit binding for 24 hours | |
| DV1041 | The number of transfer devices exceeds the set maximum value | |
| DV1042 | The device password is incorrect for the limited number of times, and the device is locked | |
| DV1043 | Project attributes are not supported | |
| DV1044 | Device IP is not in the unified LAN | |
| DV1045 | Device conflict | |
| DV1047 | The device has customized encryption | |
| DV1049 | The device has no storage medium | |
| DV1050 | The number of generations of temporary keys exceeds the limit | |
| DV1051 | Face database does not exist | |
| DV1052 | Add more than the upper limit of the face database | |
| DV1053 | Failed to capture the picture, please check the network | When calling the manual capture interface, the device did not return the picture in time due to network reasons. |
| WF1001 | Request timeout | Connection wifi timeout |
| WF1002 | Wrong wifi password | When connecting to wifi, the params.password in the request body is wrong |
| SM1001 | Verification code input error | 1. When binding the user, params.smsCode is filled in incorrectly; 2. When binding the user, the verification code has expired. |
| SM1002 | The verification code has expired, please re-acquire the verification code | |
| SM1003 | Server processing error | |
| SM1004 | Failed to send verification code SMS | |
| SM1005 | The number of times to obtain SMS verification codes on the same day has reached the upper limit | 1. When a non-published app is bound to a user, the number of times to obtain a SMS verification code exceeds the limit; 2. When a published app is bound to a user, the number of times to obtain a SMS verification code exceeds the limit Restrictions; |
| SM1006 | SMS is sent too frequently, please try again later | Get SMS interface calls too frequently |
| SMS01 | The number of SMS sending exceeds the limit | |
| SMS02 | The number of SMS sending exceeds the limit | |
| TH1001 | The current method is wrong, not the transparent transmission interface method | |
| TH1003 | The format of the message callback URL is incorrect | |
| ST1001 | The default cloud storage package of the current device has expired, and the operation failed | When the default cloud storage package is turned on, the default package has expired |
| ST1002 | The current device has no default cloud storage package, the operation failed | |
| ST1003 | The cloud storage package currently in use is not the default cloud storage package, and the operation failed | |
| ST1004 | Cloud storage package is not open | |
| ST1005 | Cloud storage package has expired | |
| ST1006 | Cloud storage package does not exist | |
| ST1007 | The number of calls to activate the cloud storage interface is less than once | |
| ST1008 | The timed recording plan cloud storage package used by the current device is in use and needs to be suspended | |
| ST1009 | The operation failed. The current device still has an unexpired charging cloud storage package policy. | |
| ST1010 | The device does not support the corresponding cloud storage package strategy | |
| RC1001 | Cloud video not found | Query cloud video based on cloud video clip information does not exist |
| LV1001 | The live video already exists | When the bind live address interface is called, the current device and rtsp address source have been bound to the live broadcast address |
| LV1002 | The live video does not exist | |
| LV1004 | The device has customized the encryption key | When the live broadcast plan is turned on, the traffic is insufficient |
| LV1005 | The live broadcast information does not exist. | |
| LV1006 | The operation failed. The same rtsp source address can only be bound once in the same day. | |
| LV1008 | Real-name authentication is required to create a live broadcast. Please go to the open platform website-basic information page to complete the information. If you are an individual user, please upload your ID card. If you are a company customer, please upload your business license and others | |
| LV1020 | Live broadcast has been bound and cannot be deleted | |
| YL1001 | In the timing pull mode, the pull time cannot be within the scheduled time of the timing recording. | |
| YL1002 | The timing plan time parameter overlaps, the overlap time is XX-XX. | |
| YL1003 | The operation failed. A valid cloud storage recording plan exists. Please close the cloud storage recording plan and try again. | |
| YL1004 | The operation failed. There is a valid motion inspection plan. Please close the motion inspection plan and try again. | |
| YL1005 | The operation failed. Please activate the cloud storage strategy package that supports the setting of cloud storage recording plans. | |
| GT1001 | Authorized role already exists | |
| GT1002 | Failed to add character | |
| GT1003 | User authorization already exists | |
| GT1004 | Failed to create user authorization | |
| GT1005 | User authorization does not exist | |
| GT1006 | Character does not exist | |
| GT1007 | The role is the default role | |
| GT1008 | Authorization exceeds limit | |
| GT1009 | Cannot authorize to myself | |
| GT1010 | Failed to obtain authorization list | |
| GT1011 | The parameter passed in the access permission list is incorrect | |
| GP1001 | The device group name already exists | |
| GP1002 | Device group Id does not exist | |
| GP1003 | The device has been added to the group | |
| US1001 | User does not exist | |
| US1002 | This user does not have this authorization relationship | |
| P2P001 | P2P authentication interface, authentication ID has expired | |
| P2P002 | P2P authentication interface, the header field parameter is missing | |
| P2P003 | token expired | |
| P2P004 | No device permission | |
| AD1001 | Unbound general manager | |
| LD1001 | There is no storage medium locally on the device | |
| AP1001 | Accessory does not exist | |
| AP1002 | Accessories offline | |
| FL1001 | Insufficient number of remaining accesses for developers | Developers can log in to the open platform website and click on "purchased resources" to view the remaining number of device channel accesses |
| FL1002 | Developer currently has no available bandwidth | During audio and video preview (real-time preview, video playback), the system detects that the developer has no remaining traffic and has not purchased bandwidth, and an error message will be returned. Developers can log in to the open platform website and click "purchased resources" to view the remaining traffic and available bandwidth. |
| FL1003 | The developer's current bandwidth exceeds the quota limit | During audio and video preview (real-time preview, video playback), the system detects that the developer's bandwidth usage exceeds the limit, and an error message is returned. Developers can log in to the open platform website and click Console-My Resources to view the remaining traffic and available bandwidth. |
| FL1004 | Insufficient developer's remaining traffic | During audio and video preview (real-time preview, video playback), the system detects that the developer has no remaining traffic and has not purchased bandwidth, and an error message will be returned. Developers can log in to the open platform website and click "purchased resources" to view the remaining traffic and available bandwidth |
| FL1005 | There is no available bandwidth and insufficient remaining traffic during the audio and video fetching operation of the developer | During the audio and video preview (real-time preview, video playback), the system detects that the developer has no remaining traffic and has not purchased bandwidth, and an error message is returned . Developers can log in to the open platform website and click "purchased resources" to view the remaining traffic and available bandwidth. |
| PF1001 | repositoryToken does not exist | |
| PF1002 | faceToken does not exist | |
| PF1003 | No face detected | |
| PF1004 | This function is temporarily not supported | |
| PF1005 | Picture size exceeds 2M limit | |
| PF1006 | Type does not match | |
| PF1007 | Failed to obtain feature value, please perform image detection first | |
| UR1000 | User not logged in | |
| UR1001 | Email login is not supported | |
| PH1001 | Mobile phone number modification frequency has reached the upper limit | |
| ST1011 | The number of calls to the interface exceeds the limit, and the same package can only be unbound once within 24 hours | |
| ST1012 | Free cloud storage does not support unbinding | |
| SUB1000 | The current sub-account has no interface access rights | |
| SUB1001 | The current sub-account has no interface access rights | |
| SUB1002 | The current sub-account has no interface access rights | |
| SUB1005 | Sub-account token expired | |
| SUB1006 | No authorization relationship between sub-account and device | |
| SUB1007 | Failed to create sub-account | |
| SUB1008 | There is no binding relationship between the sub-account and the current application |