调用该接口通过指定手机、邮箱或具体identityId的方式,将设备和场景分享给其他人。对于使用自有账号体系的用户,在智能生活平台一般不会保存对应账号的手机和邮箱等信息,此时可以借助自有账号ID和智能生活平台identityId映射关系,来实现该分享接口的调用。每次分享最多可以分享20个设备。
路径 | /uc/shareDevicesAndScenes |
版本号 | 1.0.8 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 10000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotIdList | List | 否 | ["aD12ef8KkWYrT1****JJ0010825000","cJUOGpBmLvWSkcWAd****010573e00"] | 设备ID列表,设备ID是生活物联网平台为设备颁发的ID,设备的唯一标识符。iotIdList和sceneIdList不可同时为空。 |
sceneIdList | List | 否 | ["0ee988d4079843f****cdd01e69aba40","e3ef24c7bfc14e8a8****02360b64ed7"] | 场景ID列表,场景ID是生活物联网平台赋予场景的唯一标识符。iotIdList和sceneIdList不能同时为空。 |
groupId | String | 否 | Ncv7Zq91WR8l7QLrs****00002ba00 | 设备和场景所在空间的ID,生活物联网平台赋予空间的唯一标识符。如:家ID。 |
accountAttr | String | 否 | 目标用户唯一属性的类型。MOBILE(表示手机号);EMAIL(表示邮箱)。 | |
accountAttrType | String | 否 | 唯一标识目标用户的属性类型(如:手机号、邮箱等),手机号:"MOBILE",邮箱:"EMAIL"。 | |
mobileLocationCode | String | 否 | 86 | 手机号的区位码。 |
targetIdentityId | String | 否 | 分享目标的身份ID。 | |
autoAccept | Boolean | 否 | 目前仅支持用户手动接受分享。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.8",
"iotToken": "token"
},
"params":{
"iotIdList":[
"aD12ef8KkWYrT1****JJ0010825000",
"cJUOGpBmLvWSkcWAd****010573e00"
],
"sceneIdList":[
"0ee988d4079843f****cdd01e69aba40",
"e3ef24c7bfc14e8a8****02360b64ed7"
],
"groupId": "Ncv7Zq91WR8l7QLrs****00002ba00",
"accountAttr": "value3",
"accountAttrType": "EMAIL",
"mobileLocationCode": "86",
"targetIdentityId": "value6",
"autoAccept": "value7"
}
}
正常返回示例
JSON
格式
{
"code":200,
"id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}
异常返回示例
JSON
格式
{
"code":2064,
"id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
"localizedMsg":"请求错误",
"message":"needauthorizetobind"
}