1.Manage.addYoLinkDevice
Add YoLink device by sn code
BDDP
| Param | Value | Desc |
|---|
| method | Manage.addYoLinkDevice | Add YoLink Device and Get Net Token |
| time | 1603248494437 | currnet timestamp |
| params.sn | <String,Necessary> | Device's SN Code,get it from QR-Code on the device |
BUDP
| Param | Value | Desc |
|---|
| data.deviceId | <String,Necessary> | The DeviceId; |
| data.deviceUUID | <String,Necessary> | The device's UUID; |
| data.token | <String,Necessary> | Hub's net token; It's necessary when you send message to this device; |
| data.name | <String,Necessary> | Device's product name; |
| data.type | <String,Necessary> | Device's type name; like 'Hub', Could Call <Hub.*> with this device. |
| data.modelName | <String,Necessary> | Device's model name; like 'YS7103-UC'. |
2.Manage.delYoLinkDevice
Delete YoLink device by deviceId
BDDP
| Param | Value | Desc |
|---|
| method | Manage.delYoLinkDevice | Delete YoLink device and revoke Net Token for this device |
| params.deviceId | <String,Necessary> | DeviceId/DeviceEUI of the device |
BUDP
| Param | Value | Desc |
|---|
| data.success | <Boolean,Necessary> | Indicates whether the operation was successful or not |
3.Manage.setCallbackURL
Set Callback_URL <Just work at Staging Env>
BDDP
| Param | Value | Desc |
|---|
| method | Manage.setCallbackURL | Set Callback URL(For Http Callback) |
| params.url | <String,Optional> | Set Staging Env's report callback_url; If null, use current url; |
BUDP
| Param | Value | Desc |
|---|
| data.id | <String,Necessary> | The CSID |
| data.url | <String,Necessary> | Current Callback URL. UpLink will report to MQTT Channel if it's "MQTT" |
| data.name | <String,Necessary> | The CS Name |
4.Manage.syncAccountDevice
Sync YoSmart Account's Device List
BDDP
| Param | Value | Desc |
|---|
| method | Manage.syncAccountDevice | Get YoSmart Account's Device List |
| params.accessToken | <String,Necessary> | Your YoSmart Account access token, get it from OAuth2.0 API with your yosmart account |
BUDP
| Param | Value | Desc |
|---|
| data.list[*].deviceId | <String,Necessary> | The DeviceId; |
| data.list[*].deviceUUID | <String,Necessary> | The device's UUID; |
| data.list[*].modelName | <String,Necessary> | The device's model name; |
| data.list[*].token | <String,Necessary> | The device's net token; It's necessary when you send message to this device; |
| data.list[*].name | <String,Necessary> | Device's product name; |
| data.list[*].type | <String,Necessary> | Device's type name; Such as 'Hub',Could call method <Hub.*> with this device; |
5.Manage.retrieveYoLinkDevice
Retrieve basic information of YoLink device by sn code
BDDP
| Param | Value | Desc |
|---|
| method | Manage.retrieveYoLinkDevice | Retrieve YoLink device info |
| params.sn | <String,Necessary> | Device's SN Code,get it from QR-Code on the device |
BUDP
| Param | Value | Desc |
|---|
| data.list[*].deviceId | <String,Necessary> | The DeviceId; |
| data.list[*].name | <String,Necessary> | Device's product name; |
| data.list[*].deviceUDID | <String,Necessary> | Device's deviceUDID; |
| data.list[*].modelName | <String,Necessary> | Device's model name; |
| data.list[*].zoomKey | <String,Necessary> | Device's zoom id; |
| data.list[*].token | <String,Necessary> | Device's token; |
| data.list[*].type | <String,Necessary> | Device's type name; like 'Hub', Could Call <Hub.*> with this device. |
6.Manage.createAccessToken
Create access_key for api access
BDDP
| Param | Value | Desc |
|---|
| method | Manage.createAccessToken | Create access_key for api access |
| params.scope | <String,Necessary> | Specify the scope of API access |
BUDP
| Param | Value | Desc |
|---|
| data.access_token | <String,Necessary> | The access_token; |
| data.token_type | <String,Necessary> | ["bearer"]; |
| data.expires_in | <Number,Necessary> | In seconds; |
| data.scope | <Array<String>,Necessary> | Permitted scopes of api access |