消息推送接入指南
2023年1月14日大约 4 分钟
消息推送接入指南
提示
该文档主要介绍第三方业务系统或定制应用如何向平台统一推送消息。
前置条件
- 需能访问网办平台服务地址。
- 需要联系实施人员进行接入应用授权，获取调用接口授权ID。
第三方业务系统集成步骤
- 推送消息流程
步骤一、创建推送任务
注意
注：此接口存在鉴权限制，当遇到此问题时，接口返回结果的msg中会有体现。
推送消息接口
1. 接口描述
接口地址：/message-platform-service/api/send
请求方式：POST
2. 请求参数
注意
推送渠道由消息平台动态配置发送，业务系统只负责将消息推送至消息平台中
| 参数名称 | 参数发送方式 | 必选 | 长度 | 类型 | 描述 |
|---|---|---|---|---|---|
| title | Body | 是 | 20 | int | 推送消息标题 |
| content | Body | 是 | String | 推送消息内容 | |
| pushType | Body | 是 | int | 推送消息类型：20-任务类、30-预警类、40-警告类、50-提醒类 | |
| receiver | Body | 是 | Arrays | 接受人员列表（证件号或学号或工号） | |
| url | Body | 否 | String | 链接地址 | |
| wapUrl | Body | 否 | String | wap链接地址（若有单独wap页面时传入） | |
| appId | Header | 是 | String | 授权ID-该参数由实施人员提供 |
3. 输出参数
| 参数名称 | 说明 | 类型 | 描述 |
|---|---|---|---|
| code | 状态码 | int | 状态码返回为0表示请求成功。 |
| msg | 消息内容 | String | 返回的提示消息。 |
| data | 返回结果数据 | Long | 返回数据 |
4. 请求示例
- 请求示例
{
"title": "测试推送",
"content": "测试推送",
"pushType": 20,
"receiver": [
"1"
]
}5. 返回示例
提示
响应数据中，会返回所有渠道推送记录相关业务编码
| 参数名称 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| bizId | String | 是 | 追踪id |
| messageId | String | 是 | 任务编号 |
| businessId | String | 是 | 业务编号 |
- 返回示例
{
"code": 0,
"msg": "操作成功",
"data": [
{
"bizId": "6hRVcztsCRIMcAIPQcYpH",
"messageId": "6hRVcztsCRIMcAIPQcYpH",
"businessId": 2000000120231123
},
{
"bizId": "rnE_EuBiIWHHUCtRtKoxG",
"messageId": "rnE_EuBiIWHHUCtRtKoxG",
"businessId": 2000000120231123
},
{
"bizId": "CcELTQU_GdAttH_uX--ZO",
"messageId": "CcELTQU_GdAttH_uX--ZO",
"businessId": 2000000120231123
},
{
"bizId": "9m-tZ663wD08ApRTJ1Zzt",
"messageId": "9m-tZ663wD08ApRTJ1Zzt",
"businessId": 2000000120231123
}
],
"ok": true
}步骤二、查询推送状态
注意
注：此接口存在鉴权限制，当遇到此问题时，接口返回结果的msg中会有体现。
推送消息接口
1. 接口描述
接口地址：/message-platform-service/api/getSendInfo/{businessId}
请求方式：POST
2. 请求参数
注意
由于平台推送会触发多渠道同时推送，故根据业务id查询记录是会反会多条推送记录及推送状态
| 参数名称 | 参数发送方式 | 必选 | 长度 | 类型 | 描述 |
|---|---|---|---|---|---|
| businessId | Path | 是 | 20 | String | 业务编号 |
| appId | Header | 是 | String | 授权ID-该参数由实施人员提供 |
3. 输出参数
| 参数名称 | 说明 | 类型 | 描述 |
|---|---|---|---|
| code | 状态码 | int | 状态码返回为0表示请求成功。 |
| msg | 消息内容 | String | 返回的提示消息。 |
| data | 返回结果数据 | Long | 返回数据 |
4. 请求示例
- 请求示例
5. 返回示例
提示
响应数据中，会返回所有渠道推送记录相关业务编码
| 参数名称 | 数据类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| bizId | String | 是 | 追踪id |
| createTime | String | 是 | 推送时间 |
| state | int | 是 | 推送状态：20-消费被丢弃、22-消息屏蔽、30-消息被内容去重、40-消息被频次去重、60-下发成功、70-消息下发失败、 |
| pushChannel | String | 是 | 推送渠道：10-站内信、30-短信、40-邮箱、50-服务号、60-小程序、70-企业微信、80-钉钉机器人、90-钉钉工作通知、100-企业微信机器人、110-飞书机器人、120-支付宝小程序 |
| businessId | String | 是 | 业务编号 |
- 返回示例
{
"code": 0,
"msg": "操作成功",
"data": [
{
"bizId": "6hRVcztsCRIMcAIPQcYpH",
"messageId": "6hRVcztsCRIMcAIPQcYpH",
"businessId": 2000000120231123,
"pushChannel": 10,
"state": 60,
"createTime": "2023-11-30 10:00:12"
},
{
"bizId": "rnE_EuBiIWHHUCtRtKoxG",
"messageId": "rnE_EuBiIWHHUCtRtKoxG",
"businessId": 2000000120231123,
"pushChannel": 10,
"state": 60,
"createTime": "2023-11-30 10:00:12"
},
{
"bizId": "CcELTQU_GdAttH_uX--ZO",
"messageId": "CcELTQU_GdAttH_uX--ZO",
"businessId": 2000000120231123,
"pushChannel": 10,
"state": 60,
"createTime": "2023-11-30 10:00:12"
},
{
"bizId": "9m-tZ663wD08ApRTJ1Zzt",
"messageId": "9m-tZ663wD08ApRTJ1Zzt",
"businessId": 2000000120231123,
"pushChannel": 10,
"state": 60,
"createTime": "2023-11-30 10:00:12"
}
],
"ok": true
}定制应用接入步骤
注意
未开放，需联系实施人员，给出示例。