Last Updated on : 2024-06-24 04:09:47download
```mermaid %%{init: { "sequence": { "wrap": true} } }%% sequenceDiagram actor User as User participant WeChat mini program as WeChat mini program participant Cloud as Cloud participant Universal IR remote control as Universal IR remote control participant IR device as IR device User ->> WeChat mini program: Request device category to be controlled WeChat mini program ->> Cloud: -->> WeChat mini program: Return supported device category User ->> WeChat mini program: Request supported brands WeChat mini program ->> Cloud: -->> WeChat mini program: Return brands supported by specified device category User ->> WeChat mini program: Request index list of IR code libraries supported by specified brands WeChat mini program ->> Cloud: -->WeChat mini program: Return index list of IR code libraries supported by specified brands User ->>WeChat mini program: Choose a set of IR codes to test whether a device can be controlled properly WeChat mini program ->> Cloud: infrared.testStandardCommand Cloud ->> Universal IR remote control: Send IR codes Universal IR remote control ->> IR device: Send IR codes IR device ->> User: Confirm device control result opt Optional action User ->> WeChat mini program: Get non-standard instructions WeChat mini program ->> Cloud: -->> WeChat mini program: Return list of IR keys that match specified index of IR code libraries User ->> WeChat mini program: Test non-standard instructions WeChat mini program ->> Cloud: infrared.testRawCommand Cloud ->> Universal IR remote control: Send IR codes Universal IR remote control ->> IR device: Send IR codes IR device ->> User: Confirm device control result end User ->> WeChat mini program: Confirm available IR code library index and bind remote control WeChat mini program ->> Cloud: -->> WeChat mini program: Return the remote_id of virtual remote control for controllable device User ->> WeChat mini program: Control device with common remote control WeChat mini program ->> Cloud: infrared.standardCommand Cloud ->> Universal IR remote control: Send IR codes Universal IR remote control ->> IR device: Send IR codes User ->> WeChat mini program: Control device with non-standard commands from common remote control WeChat mini program ->> Cloud: infrared.rawCommand Cloud ->> Universal IR remote control: Send IR codes Universal IR remote control ->> IR device: Send IR codes note over User,IR device: Same operation as common remote control note over User,IR device: Select current location User ->> WeChat mini program: Request province list WeChat mini program ->> Cloud: -->> WeChat mini program: Return province list User ->> WeChat mini program: Request city list WeChat mini program ->> Cloud: -->> WeChat mini program: Return city list User ->> WeChat mini program: Get area list WeChat mini program ->> Cloud: -->> WeChat mini program: Return area list note over User,IR device: Select current carrier User ->> WeChat mini program: Request carrier list WeChat mini program ->> Cloud: -->> WeChat mini program: Return carrier list note over User,IR device: Get list of channel tables that match current carrier and area User ->> WeChat mini program: Request list of channel tables that match current carrier ID and area ID WeChat mini program ->> Cloud: -->> WeChat mini program: Return list of channel tables note over User,IR device: Bind channel table with set-top box, also applicable to switching between channel tables User ->> WeChat mini program: Pass in sub-device ID and channel table ID WeChat mini program ->> Cloud: -->> WeChat mini program: Return binding result note over User,IR device: Get channel lists that match remote control User ->> WeChat mini program: Request channel list that matches remote control WeChat mini program ->> Cloud: infrared.boxRemoteChannel.v2.0 Cloud ->> WeChat mini program: Return channel list that matches remote control note over User,IR device: Switch between channels User ->> WeChat mini program: Switch between channels for set-top box WeChat mini program ->> Cloud: infrared.boxRemoteSwitchChannel.v2.0 Cloud ->> WeChat mini program: Switch between channels for set-top box ```
Action | Description |
---|---|
infrared.category | Get the device categories supported by a universal IR remote control. |
infrared.categoryBrand | Get the list of brands supported by a specified device category. |
infrared.categoryBrandRemote | Get the list of default remote control indexes that are supported by the brands dedicated to a specified device category. |
infrared.testStandardCommand | Control a device in the phase of pairing with a remote control. |
infrared.remoteIndexKeys | Get non-standard instructions. |
infrared.testRawCommand | Test sending non-standard instructions in the phase of pairing. |
infrared.addNormalRemote | Add a common remote control. |
infrared.standardCommand | Control a device with standard instructions from a common remote control. |
infrared.rawCommand | Control a device with non-standard instructions from a common remote control. |
infrared.province.v2.0 | Get a list of provinces. |
infrared.city.v2.0 | Get a list of cities. |
infrared.area.v2.0 | Get a list of areas. |
infrared.operatorByArea.v2.0 | Get a list of carriers that belong to a specific area. |
infrared.channelsByOperator.v2.0 | Get a list of channel tables that match the specified carrier and area. |
infrared.selectChannel.v2.0 | Bind a channel table with a set-top box. |
infrared.boxRemoteChannel.v2.0 | Get the list of channels for a set-top box. |
infrared.boxRemoteSwitchChannel.v2.0 | Switch between channels for a set-top box. |
API description
Get the device categories supported by a universal IR remote control. Typical devices include TV sets, set-top boxes, air conditioners, and fans.
API endpoint
action: infrared.category
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
For more information about the method to get a device ID, see Get device list by user ID.
Sample request
{
"action": "infrared.category",
"params": {
"infrared_id": "vdevo157924607038167"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Description of result
Parameter name | Type | Description | |
---|---|---|---|
category_id | String | The device category ID. | |
category_name | String | The name of the device. |
Sample response
{
"success": true,
"t": 1539776581583,
"result": [
{
"category_id": "1",
"category_name": "Set-top box",
},
{
"category_id": "2",
"category_name": "TV set"
},
{
"category_id": "5",
"category_name": "Air conditioner"
}
]
}
API description
Get information about brands that are supported by a device category dedicated to an IR remote control. TV sets and air conditioners are supported.
API endpoint
action: infrared.categoryBrand
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
category_id | String | The device category ID. | Yes |
Sample request
{
"action": "infrared.categoryBrand",
"params": {
"infrared_id": "vdevo157924607038167",
"category_id": "2"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Description of result
Parameter name | Type | Description | |
---|---|---|---|
brand_id | String | The brand ID. | |
brand_name | String | The name of the brand. |
Sample response
{
"success": true,
"result": [
{
"brand_id": "907",
"brand_name": "Denon"
},
{
"brand_id": "3080",
"brand_name": "ENVISION"
},
{
"brand_id": "472",
"brand_name": "Feilu"
},
{
"brand_id": "352",
"brand_name": "Optoma"
},
{
"brand_id": "2427",
"brand_name": "RICHINFO"
},
{
"brand_id": "232",
"brand_name": "SANYO"
},
{
"brand_id": "1216",
"brand_name": "Kaisui"
}
]
}
API description
Get the list of default remote control indexes that are supported by the brands dedicated to a specified device category.
API endpoint
action: infrared.categoryBrandRemote
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
category_id | String | The device category ID. | Yes |
brand_id | String | The brand ID. | Yes |
Sample request
{
"action": "infrared.categoryBrandRemote",
"params": {
"infrared_id": "vdevo157924607038167",
"category_id": "2",
"brand_id": "907"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Description of result
Parameter name | Type | Description |
---|---|---|
remote_index | String | The remote control index. |
Sample response
{
"success": true,
"result": [
{
"remote_index": "1092"
},
{
"remote_index": "1102"
},
{
"remote_index": "1107"
},
{
"remote_index": "1112"
},
{
"remote_index": "1117"
}
]
}
API description
Send an IR instruction and test whether an IR device can be controlled as expected in the stage of pairing with a remote control.
API endpoint
action: infrared.testStandardCommand
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_index | String | The remote control index. | Yes |
category_id | String | The device category ID. | Yes |
key | String | The standard key. | Yes |
Sample request
{
"action": "infrared.testStandardCommand",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_index": "5129",
"category_id": 1,
"key" : "power"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
{
"success": true,
"result": true
}
API description
Get pairing rules that match a remote control ID, and get the key for sending an IR code.
You can make this API request to implement the features that are not covered by standard IR instructions.
API endpoint
action: infrared.remoteIndexKeys
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
category_id | String | The device category ID. | Yes |
brand_id | String | The brand ID. | Yes |
remote_index | String | The remote control index. | Yes |
Sample request
{
"action": "infrared.remoteIndexKeys",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_index": "3054",
"category_id": 2,
"brand_id": 27
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
Sample response on success (common remote control)
{
"success": true,
"result": [
{
"key": "1",
"desc": "Power",
"key_name": "power",
"code":"5jCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "42",
"desc": "OK",
"key_name": "ok",
"code":"54CYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "43",
"desc": "Channel up",
"key_name": "channel_up",
"code":"09CCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
}
]
}
Sample response on success (remote control of air conditioner)
{
"success": true,
"result": [
{
"key": "0",
"desc": null,
"key_name": "M0_T16_S0",
"code":"5jCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "0",
"desc": null,
"key_name": "M0_T16_S1",
"code":"11CCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "0",
"desc": null,
"key_name": "M0_T16_S2",
"code":"90sCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "0",
"desc": null,
"key_name": "M0_T16_S3",
"code":"7dCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
},
{
"key": "0",
"desc": null,
"key_name": "M0_T17_S0",
"code":"6vbCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
}
]
}
Sample response on failure
{
"success": false,
"code": 500,
"msg": "system error,please contact the admin"
}
API description
Test whether a remote control matches a device. Send an IR code by setting the key
in the request parameters. You can get the value of the key
when you make an API request to get the pairing rules. Dedicated instructions, rather than non-standard instructions, support air conditioners.
API endpoint
action: infrared.testRawCommand
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_index | String | The remote control index. | Yes |
category_id | String | The device category ID. | Yes |
raw_key | String | The key of the IR code. You can get the value of the key when you make an API request to get the pairing rules. |
Yes |
Sample request
{
"action": "infrared.testRawCommand",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_index": "5129",
"category_id": 1,
"raw_key" : 1
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
{
"success": true,
"result": true
}
API description
Add a common remote control that is inapplicable to set-top boxes and air conditioners.
API endpoint
action: infrared.addNormalRemote
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
category_id | String | The device category ID. | Yes |
brand_id | String | The brand ID. | Yes |
brand_name | String | The name of the brand. | Yes |
remote_index | String | The remote control index. | Yes |
remote_name | String | The name of the remote control. | Yes |
Sample request
{
"action": "infrared.addNormalRemote",
"params": {
"infrared_id": "vdevo157924607038167",
"category_id": "2",
"category_name": "TV set",
"brand_id": "27",
"brand_name": "TCL",
"remote_index": "10982",
"remote_name" : "Name of remote control"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Description of result
Parameter name | Type | Description | |
---|---|---|---|
remote_id | String | The device ID of the remote control. |
Sample response
{
"success": true,
"result": {
"remote_id": "6cb9e4eaf1e462b3d4ihh7"
}
}
API description
Send an instruction that matches a standard key for an added remote control. For more information about keys
, see Standard Instructions for Infrared Devices. Users can send standard instructions to control air conditioners and control channels of TV sets and set-top boxes.
API endpoint
action: infrared.standardCommand
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_id | String | The remote control ID. | Yes |
key | String | The standard key. | Yes |
Sample request
{
"action": "infrared.standardCommand",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "6c014f07yyyyyy",
"key" : "power"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
{
"success": true,
"result": true
}
API description
Control an associated remote control to send an instruction and send an IR code that matches raw_key
. You can get the value of raw_key
when you make an API request to get the pairing rules. Currently, only TV sets and set-top boxes are supported. Dedicated instructions are used for air conditioners.
API endpoint
action: infrared.rawCommand
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_id | String | The remote control ID. | Yes |
raw_key | String | The standard key. | Yes |
Sample request
{
"action": "infrared.rawCommand",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "6c014f07yyyyyy",
"raw_key" : "43"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
{
"success": true,
"result": true
}
API description
Get a list of provinces.
API endpoint
action: infrared.province.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
Sample request
{
"action": "infrared.province.v2.0",
"params": {
"infrared_id": "vdevo157924607038167"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": [
{
"province_id": 120000,
"province_name": "Tianjin"
},
{
"province_id": 320000,
"province_name": "Jiangsu"
}
]
}
API description
Get a list of cities.
API endpoint
action: infrared.city.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
province_id | String | The province ID. | Yes |
Sample request
{
"action": "infrared.city.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"province_id": "330000"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": [{
"province_id": 330000,
"city_id": 330700,
"city_name": "Jinhua"
},
{
"province_id": 330000,
"city_id": 330800,
"city_name": "Wenzhou"
}
]
}
API description
Get a list of areas.
API endpoint
action: infrared.area.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
province_id | String | The province ID. | Yes |
city_id | String | The city ID. | Yes |
Sample request
{
"action": "infrared.area.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"province_id": "330000",
"city_id": "30500"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": [{
"province_id": 330000,
"city_id": 30500,
"area_id": 330523,
"area_name": "Anji County"
},
{
"province_id": 330000,
"city_id": 30500,
"area_id": 330522,
"area_name": "Changxing County"
}
]
}
API description
Get a list of carriers.
API endpoint
action: infrared.operatorByArea.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
area_id | String | The area ID. | Yes |
Sample request
{
"action": "infrared.operatorByArea.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"area_id": "510114"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": [
{
"operator_id": "1062",
"operator_name": "IPTV of China Telecom, Chengdu Branch",
"country_code": "CN"
}
]
}
API description
Get a list of channel tables that match the specified carrier and area.
API endpoint
action: infrared.channelsByOperator.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
area_id | String | The area ID. | Yes |
sp_id | String | The carrier ID. | Yes |
Sample request
{
"action": "infrared.channelsByOperator.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"area_id": "510114",
"sp_id":"111"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": [
{
"channel_list":[
{
"cid":29,
"name":"CCTV-1 (CCTV General Channel)",
"num":2
},
{
"cid":30,
"name":"CCTV-2 (Finance Channel)",
"num":3
}
],
"channel_type":2,
"custom_channel_name":"Channel table 1",
"id":7035001,
"index":1
},
{
"channel_list":[
{
"cid":7757,
"name":"Channel Guide",
"num":100
},
{
"cid":110247,
"name":"Tianjin TV HD",
"num":101
}
],
"channel_type":2,
"custom_channel_name":"Channel table 2",
"id":598079,
"index":2
}
]
}
API description
Bind a channel table with a set-top box. To implement switching between channel tables, make this API request again.
API endpoint
action: infrared.selectChannel.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_id | String | The sub-device ID. | Yes |
channel_type | Integer | The type of channel table. Currently, only the online channel table is supported, and the respective value is hardcoded to be 2 . |
Yes |
channel_id | Long | The channel table ID. | Yes |
Sample request
{
"action": "infrared.selectChannel.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "d5s65ca55",
"channel_type":2,
"channel_id":165008497
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"success": true,
"result": true
}
API description
Get the list of channels for a remote control.
API endpoint
action: infrared.boxRemoteChannel.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_id | String | The remote control ID. | Yes |
Sample request
{
"action": "infrared.boxRemoteChannel.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "6cbedcyyyyyyy"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | List | The returned result. |
Sample response
{
"result": {
"area_id": 330106,
"channel_table_name": "Channel table",
"channel_vo_list": [
{
"cid": 110190,
"name": "3D Channel",
"num": 0
}
],
"sp_id": 37,
"weather_selected": true
},
"success": true,
"t": 1632733332634
}
API description
Switch between channels for a set-top box.
API endpoint
action: infrared.boxRemoteSwitchChannel.v2.0
Request parameter
Parameter name | Type | Description | Required |
---|---|---|---|
infrared_id | String | The infrared device ID. | Yes |
remote_id | String | The remote control ID. | Yes |
channel_num | String | The remote control ID. | Yes |
Sample request
{
"action": "infrared.boxRemoteSwitchChannel.v2.0",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "6cbedcyyyyyyy",
"channel_num":"1"
}
}
Response parameter
Parameter name | Type | Description |
---|---|---|
code | Integer | The response code. |
success | Boolean | Indicates whether the operation is successful. Valid values:true : success.false : failure. |
msg | String | The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds. |
result | Boolean | The returned result. |
Sample response
{
"success": true,
"t": 1545135036437,
"result": true
}
Is this page helpful?
YesFeedbackIs this page helpful?
YesFeedback