推送接口

1.功能说明

此接口可推送系统消息及待办事项

2.接口说明

2.1.接口定义

path 请求方式 接口描述 调用权限
/messageservice/serverPush/pushNotice POST 可推送系统消息及待办事项 子服务

2.2.请求头说明

名称 是否必须 类型 默认值 备注
Authorization true string N/A 添加服务级别的access_token，如：Bearer a3cc6613-ebe7-4ab8-9e25-48ed2c9d6c6a
Content-Type true string application/json N/A

2.3.请求参数说明

名称 是否必须 类型 备注
msgId true string 消息id,判断消息是否重复
regionType true string 范围类型:single-个人，tag-标签,platform-平台，batch
receiveUserAccount 依赖regionType字段 string regionType填入single，此字段填写接收者用户openid
platform 依赖regionType字段 string regionType填入platform，此字段填写all
tags 依赖regionType字段 array regionType填入tag，此字段填写需推送到的用户标签
noticeType true string 通知类型：system-系统通知，backlog-待办任务，office:办公助手
messageInfo true object 消息内容主体
  msgType true string 消息类型：text-文本、html、picture
  msgContent true string 消息正文
  title true string 消息标题
  msgLevel true string 消息级别
  extras false object 扩展字段，以自定义key：value的形式传递
route false object 路由
  value true string 路由跳转路径
  callback true string 回调规范

2.4.返回参数说明

名称 是否必须 类型 备注
ret true string 请求是否正常返回状态码："-1"请求异常 ,"0":请求成功
errorCode true string 请求成功返回null，失败返回code码
msg true string 成功返回"ok",失败返回错误信息
data true string 请求成功返回"ok",失败返回"no"

3.请求示例

// 请求参数
{
    "msgId": "1",
    "receiveUserAccount": "ZDRlNTExNDQtYg1040850670d6e5c9",
    "platform": "",
    "regionType": "single",
    "tags": [],
    "noticeType": "backlog",
    "messageInfo": {
        "msgType": "text",
        "msgContent": "测试推送个人",
        "title": "测试推送个人标题",
        "msgLevel":"H",
        "extras": {
            "key": "value"
        }
    },
    "route": {
        "value": "http://xxxx?",
        "callback": ""
    }
}

3.1.成功请求返回

{
  "errorCode":null,
  "msg":"ok",
  "data":"ok"
  "ret":"0"
}

3.2.失败请求返回

{
  "errorCode":"109001",
  "msg":"失效的token",
  "ret":"-1"
}

results matching ""

    No results matching ""