创建指令服务(API名称:createDirectives)
功能介绍
用于与客户系统对接创建指令服务时需要用到的接口
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/openSceneTask/createDirectives |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
isdpDeviceIds |
String |
是 |
isdp唯一设备ID集合,多个通过英文逗号分隔,最多50个 |
type |
Integer |
是 |
指令类型:1-播报;2-播报+视频;3-播报+拍照;4-播报+录音;5-播报+直播 |
content |
String |
是 |
播报内容,长度255 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
result |
Object |
响应消息体 |
errorMessage |
String |
错误信息,接口错误时有值,正常调用时为空 |
stateCode |
String |
响应状态 "0"成功 其他值失败 "100":接口参数为空 "101":设备Id为空 "102":指令类型不存在 "103":指令内容为空 "104":设备Id个数不能超过50 "105":设备Id:xx不正确 "106":指令内容长度超过255 |
result模板头信息Object对象说明
参数 |
类型 |
描述 |
---|---|---|
instructionId |
Long |
指令ID,一次只允许创建一个指令,指令会按照创建顺序依次执行。 |
请求示例
{ "isdpDeviceIds":"1141bianma--1","type":1,"content":"测试一下" }
响应示例
{ "result": { "instructionId": 913 }, "stateCode": "0" }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。