setMessageCallback（设置消息回调地址）

setMessageCallback：设置消息回调地址

功能说明

设置开发者账号的消息回调地址与订阅类型。查询当前配置见 getMessageCallback。

消息推送整体流程见接收设备消息。订阅能力事件须在 callbackFlag 中包含 capabilityEvent。msgType 见事件消息类型定义 · 事件消息格式定义。

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/setMessageCallback

请求格式

POST JSON 请求体见请求约定；签名见签名。

请求参数

参数名	参数类型	是否必填	默认值	合法取值	参数说明
token	String	是			管理员 accessToken
status	String	是		on、off	是否开启消息订阅：on 开启；off 关闭
callbackUrl	String	否	""	status 为 on 时必填；为 off 时可空	接收设备消息的公网 HTTPS 回调地址。status 为 `on` 时平台会探活该 URL，仅接受 HTTP 2xx；不可达或非 2xx 将返回参数非法（如 `PARAM_ILLEGAL_VALUE`）。
callbackFlag	String	否	""	可多选逗号分隔：`alarm`、`deviceStatus`、`numberstat`、`faceAnalysis`、`capabilityEvent`、`transfer`、`rtFace`、`intelliAnalysis`、`iot` 等（与 `MessageCallbackValidate.CALLBACK_FLAG_LIST` 一致）	status 为 on 时必填；为 off 时可空。详见下方说明
basePush	String	否	2	1：推送；2：不推送	基础推送开关

callbackFlag 表示订阅的事件类别。类型定义见事件消息类型（历史 msgType 对照）；报文外壳见事件消息格式定义。海外能力事件须在 callbackFlag 中包含 capabilityEvent（见接收告警）。

请求示例

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603350639,
 "nonce":"350f4c7a-a352-46cf-ae03-f4f526f5d99f"
 },
 "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
 "params":{
 "callbackFlag":"alarm,deviceStatus",
 "basePush":"2",
 "callbackUrl":"https://www.example.com/callback",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a",
 "status":"on"
 }
}

返回 data 字段

无返回数据。

响应示例

{
 "id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
 "result":{
 "code":"0",
 "msg":"操作成功."
 }
}

错误码

本接口可能返回下列码；完整分组见错误码与能力错误码。

网关与鉴权（SN / TK / OP）

错误码	错误码说明	下一步
`SN1001`	签名校验异常	按 HTTP 开发规范核对 `sign`
`TK1002`	token 无效或过期	重新获取 accessToken
`OP1002`	缺少必填参数	补必填字段
`OP1003`	参数不合法	按本页参数表核对
`OP1009`	权限不足	核对 token 与设备绑定/分享权限
`OP1013`	接口总次数超限	降低调用频率
`OP1014`	接口日限额超限	见接口调用限额
`DV1007`	设备离线	等设备上线

更多见错误码 · OP/SN/TK。

子账号（SUB）

错误码	错误码说明	下一步
`SUB1001`–`SUB1002`	子账号无接口权限	在 addPolicy 中补策略
`SUB1005`	子账号 token 过期	重新 subAccountToken
`SUB1006`	子账号与设备无授权	核对 `Resource` 与设备序列号
`SUB1008`	子账号未绑定应用	先创建并绑定子账号

更多见错误码 · SUB。