按指令ID查询指令列表服务(API名称:findInstructions)
功能介绍
用于与客户系统对接按指令ID查询指令列表时需要用到的接口。
相关接口
接口名称 | 调用说明 |
|---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 | HTTPS地址 | 服务架构 | 消息体类型 |
|---|---|---|---|
POST | https://isdp+域名/openapi/v1/openSceneTask/findInstructions | OpenAPI | application/json |
请求头
KEY | VALUE | 是否必填 | 描述 |
|---|---|---|---|
Content-Type | application/json | 是 | 无 |
Authorization | bearer ${access_token} | 是 | bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
instructionIds | String | 是 | 指令ID,多个通过英文逗号分隔,最多100个 |
响应参数
参数 | 类型 | 描述 |
|---|---|---|
result | Object | 响应消息体 |
errorMessage | String | 错误信息,接口错误时有值,正常调用时为空 |
stateCode | String | 响应状态,“0”成功 其他值失败 |
result 对象出参说明
参数 | 类型 | 描述 |
|---|---|---|
instructionId | Long | 指令ID |
type | Int | 指令类型:1-播报;2-播报+视频;3-播报+拍照;4-播报+录音;5-播报+直播 |
content | String | 播报内容 |
status | Int | 状态 1初始状态 2已完成 3超期 |
creationTimestamp | Long | 指令创建时间 |
isdpDeviceList | Object | 设备使用人集合 |
isdpDeviceList 对象出参说明
参数 | 类型 | 描述 |
|---|---|---|
isdpDeviceId | Long | 设备id |
请求示例
{
"instructionIds":"912"
} 响应示例
{
"result": [
{
"content": "测试一下",
"creationTimestamp": 1663141848000,
"instructionId": 912,
"isdpDeviceList": [
{
"instructionId": 912,
"userId": 1823,
"userName": "张三"
}
],
"lastUpdateTimestamp": 1663141848000,
"status": 1,
"type": 1
}
],
"stateCode": "0"
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码。

