接口功能介绍
本接口用于创建回调规则,即绑定回调模板至设备。
接口约束
创建回调规则确保存在该回调模板以及需要绑定的设备。
请求参数说明:
String类型的参数,传""等同于不传。
Integer类型的参数,传0等同于不传。
Boolean类型的参数,传false等同于不传。
URI
POST /v2/callbackTemplate/*/callbackRule
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
TemplateId | 是 | String | 模板ID。 | 739943519892963328 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
DeviceId | 是 | String | 设备ID。 | 700576974938832896 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码。 | 200 | |
error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
message | String | 响应信息。 | 请求成功 | |
requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
TemplateId | String | 模板ID。 | 739943519892963328 | |
DeviceId | String | 设备ID。 | 700576974938832896 | |
CreatedTime | String | 回调规则创建时间。 | 1691995152 | |
UpdatedTime | String | 回调规则更新时间。 | 1691995152 | |
RequestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b |
枚举参数
无
请求示例
请求url
POST '/v2/callbackTemplate/739943519892963328/callbackRule'
请求头header
无
请求体body
{"DeviceId": "700576974938832896"}
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "20b464ca3a4640ec8f11b39d9d106a2e","returnObj": {"TemplateId": "739943519892963328","DeviceId": "700576974938832896","CreatedTime": "1691995152","UpdatedTime": "1691995152","RequestId": "20b464ca3a4640ec8f11b39d9d106a2e"}}
状态码
请参考 状态码
错误码
请参考 错误码