用户设备批量取消分享
更新时间:2025-04-07 13:40:01
调用该接口批量取消分享。
描述 | 值 |
---|---|
路径 | /platform/user/device/share/cancel/batch |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
请求参数:
公共请求参数见 公共请求参数
请求字段 | 类型 | 必选 | 描述 |
---|---|---|---|
cancelShareList | List | 是 | 取消分享列表,一次最多50个 |
iotId | String | 否 | productKey和deviceName为空时,该入参不允许为空。 |
productKey | String | 否 | 产品的Key,设备证书信息之一。当iotId为空时,该参数不允许为空。 |
deviceName | String | 否 | 设备的名称,设备证书信息之一。当iotId为空时,该参数不允许为空。 |
receiverOpenId | String | 否 | 三方用户外标id(receiverOpenId和receiverIdentityId二者必须有其一)。 |
receiverOpenIdAppKey | String | 否 | 开放平台颁发的appKey。 |
receiverIdentityId | Long | 否 | 用户身份id(receiverOpenId和receiverIdentityId二者必须有其一)。 |
返回参数:
返回字段 | 类型 | 描述 |
---|---|---|
id | String | 用于识别请求记录,即对应的请求ID。 |
code | Int | 接口返回码字段,请求成功时返回200;请求失败时返回详细的错误码。 |
message | String | 调用失败时,返回的出错信息。 |
data | Object | 响应的结果。 |
resultList | List | 响应结果列表。 |
iotId | String | 设备的iotId。 |
productKey | String | 设备的productKey。 |
deviceName | String | 设备的deviceName。 |
receiverOpenId | String | 三方用户外标id(receiverOpenId和receiverIdentityId二者必须有其一)。 |
receiverOpenIdAppKey | String | 开放平台颁发的appKey。 |
receiverIdentityId | Long | 用户身份id(receiverOpenId和receiverIdentityId二者必须有其一)。 |
errorCode | Int | 错误码:200:成功,非200:失败, 可参考错误码字典 用户+设备不存在分享关系情况,errorCode为200 |
请求示例:
x-ca-key: xxxxxxxx
x-ca-timestamp: 1728634151000
x-ca-nonce: 7b25fc15b9434dd98587a077a92b7e42
x-ca-signature: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
Content-Type: application/json;charset=UTF-8
{
"id": "49a7be925e******8ba0facf7",
"version": "1.0",
"request": {
"apiVer": "1.0.0"
},
"params": {
"cancelShareList": [
{
"iotId": "5aAE7hj8sald******33092",
"receiverOpenIdAppKey": "5Rsd4******ffD",
"receiverIdentityId": 1
}
]
}
}
成功返回示例:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"id": "49a7be925e******8ba0facf7",
"code": 200,
"message": "success",
"data": {
"resultList": [
{
"iotId": "5aAE7hj8sald******33092",
"productKey": "5aAE7h******sklajs",
"deviceName": "5s4fas6df******33092",
"receiverIdentityId": 1,
"errorCode": 200
}
]
}
}