The UltronSMART Cloud API uses two categories of result codes to indicate the status of different operations:
SkuResult Codes
Used for product catalog, SKU database, and metadata operations.
| Code | Name | Description |
|---|---|---|
| 0 | Success | Operation completed successfully |
| 50 | PartialSuccess | Operation partially completed |
| 101 | Denied | Access denied |
| 102 | Disabled | Feature or service disabled |
| 103 | NotSupported | Operation not supported |
| 104 | IntentFailed | Intent processing failed |
| 105 | NotSupportedDevice | Device not supported |
| 201 | Invalid | Invalid input data |
| 202 | InvalidId | Invalid ID format |
| 203 | InvalidSN | Invalid serial number |
| 204 | InvalidName | Invalid name format |
| 205 | InvalidKey | Invalid key format |
| 206 | InvalidVersion | Invalid version |
| 207 | InvalidLang | Invalid language code |
| 208 | InvalidCmd | Invalid command |
| 209 | InvalidModel | Invalid model |
| 210 | InvalidConfig | Invalid configuration |
| 211 | InvalidConnType | Invalid connection type |
| 212 | InvalidMAC | Invalid MAC address |
| 213 | InvalidSensorType | Invalid sensor type |
| 214 | InvalidOui | Invalid OUI |
| 215 | InvalidTitle | Invalid title |
| 216 | InvalidBody | Invalid body content |
| 217 | InvalidSerial | Invalid serial format |
| 218 | InvalidTimezone | Invalid timezone |
| 219 | InvalidPSK | Invalid PSK |
| 220 | InvalidSSID | Invalid SSID |
| 221 | InvalidRange | Invalid range |
| 222 | InvalidUid | Invalid user ID |
| 223 | ImageNotSupported | Image format not supported |
| 224 | InvalidMatterQRCode | Invalid Matter QR code |
| 225 | InvalidMatterDevice | Invalid Matter device |
| 226 | UncertifiedMatterDevice | Uncertified Matter device |
| 227 | InvalidPhoneNumber | Invalid phone number |
| 228 | InvalidContactEmail | Invalid contact email |
| 229 | InvalidNullValue | Invalid null value |
| 277 | GroupTicketNotSupportedQRCode | Group ticket QR code not supported |
| 278 | SubscriptionLastBillingCyle | Subscription last billing cycle |
| 301 | NotFound | Resource not found |
| 302 | AlreadyExisted | Resource already exists |
| 303 | NonEmpty | Resource is not empty |
| 318 | ActiveSubscriptionExists | Active subscription already exists |
| 321 | Timeout | Operation timeout |
| 322 | OutOfProductQuantity | Out of product quantity |
| 323 | SubscriptionInactive | Subscription inactive |
| 324 | ZohoInternalError | Zoho internal error |
| 325 | ZohoMultipleUserError | Zoho multiple user error |
| 500 | ServerError | Server error |
| 501 | DataError | Data error |
| 502 | WriteError | Write operation error |
CmdResult Codes
Used for device command execution and control operations.
| Code | Name | Description |
|---|---|---|
| 0 | Success | Command executed successfully |
| 100 | DeviceNotFound | Device not found |
| 101 | DeviceNotBound | Device not bound to user |
| 102 | DeviceNotActivated | Device not activated |
| 103 | AccessDenied | Access denied |
| 104 | NotSupported | Command not supported |
| 105 | InvalidParams | Invalid parameters |
| 106 | DeviceOffline | Device is offline |
| 107 | NotAsyncCmd | Not an async command |
| 108 | AsyncEnqueueFailed | Async command enqueue failed |
| 110 | TaskInvalid | Task invalid |
| 111 | TaskEnqueueFailed | Task enqueue failed |
| 112 | QuotaExceeded | Quota exceeded |
| 113 | QuotaExceededActionDisabled | Quota exceeded, action disabled |
| 200 | GroupNotFound | Group not found |
| 201 | GroupDenied | Group access denied |
| 202 | GroupFailed | Group operation failed |
| 210 | GroupMergeFailed | Group merge failed |
| 211 | GroupMergeSceneFailed | Group merge scene failed |
| 212 | GroupMergeAutomationFailed | Group merge automation failed |
| 280 | SignInNotFound | Sign in not found |
| 281 | SignInDenied | Sign in denied |
| 300 | ServerError | Server error |
| 400 | TwoFactorAckChallenge | Two-factor acknowledgment challenge |
| 401 | TwoFactorPinChallenge | Two-factor PIN challenge |
| 402 | PinIncorrect | PIN incorrect |
| 403 | FailedPinNeeded | Failed, PIN needed |
| 404 | AsyncTwoFactor | Async two-factor |
Usage Examples
Check the result code in API responses to determine operation status:
Success Response:
{
"result": 0,
"data": { ... }
}{
"error": 0,
"data": { ... }
}{
"data": { ... } // error or result field is omitted when = 0(SUCEESS)
}Error Response:
{
"error": <Non-Zero-Value>,
"data": { ... }
}{
"result": <Non-Zero-Value>
"data": { ... }
}