主要使用场景:需要整合慧教云平台统一消息中心的能力时使用,包括应用消息和通知公告的发送、接收、查看
获取消息记录已读未读状态。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/msgCenter/message/getMsgStatusList |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
msgId |
必选 |
Body(json) |
String |
- |
消息id |
2 |
platformCode |
必选 |
Body(json) |
String |
- |
平台编码 |
3 |
isRead |
必选 |
Body(json) |
String |
- |
1为已读 0为未读 |
4 |
publisherId |
必选 |
Body(json) |
string |
- |
发送人id |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|
请求报文: { "publisherId":"7b551a5f23c242838c04e0fb02196e51", "platformCode":"420100", "isRead":1, "msgId":"3806" } 应答报文: { "retCode": "000000", "readList":[ { "sendeeName": "杨小乐", "sendeeId": "6e2573833b8847fd8452014d319837e5" }, { "sendeeName": "天喻壹", "sendeeId": "17cad241c0504aa68a865e42bb7d3172" }, { "sendeeName": "彭乐", "sendeeId": "46e609f2e27e4279bd18b1403c136f94" }, { "sendeeName": "滕老师", "sendeeId": "eab92753997b41d49032fa104b78c6a6" }, { "sendeeName": "蒋一的爸爸二", "sendeeId": "39e750ab3b6e49bf8ae3b539526430b3" }, { "sendeeName": "测试学生二十一", "sendeeId": "7d728eb182074b8ca35ec2ee45910b92" }, { "sendeeName": "胡开兴", "sendeeId": "fa2f1ee9f2f54d08bcfc28ab5628cc64" } ] }
提供给开放平台的开发者,用于查询自己收到的消息数,可获取通过已读未读、已确认未确认、业务操作状态等条件筛选消息数;
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/msgCenter/message/queryAllMsgCount |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
publisherId |
必选 |
Body(json) |
String |
- |
接收人教育云用户id |
2 |
noticeType |
必选 |
Body(json) |
String |
- |
通知类型:1.待阅消息;2.待审批; |
3 |
platformCode |
必选 |
Body(json) |
String |
- |
用户平台码 |
4 |
loginPlatformCode |
可选 |
Body(json) |
string |
- |
实体平台码 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|
请求报文: { "publisherId":"e155819259bf4e469ed04bcd1f5cb110", "platformCode":"420100", "loginPlatformCode":"888888", "noticeType": 2 , } 应答报文: { "total": 75, "retCode": "000000", "retDesc": "操作成功" }
提供给开放平台的开发者,用于查询自己收到的应用的消息数,可获取通过已读未读、已确认未确认等条件筛选消息数;
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/msgCenter/message/queryAppMsgCount |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
publisherId |
必选 |
Body(json) |
String |
- |
接收人教育云用户id |
2 |
platformCode |
必选 |
Body(json) |
JSON |
- |
用户平台码 |
3 |
loginPlatformCode |
可选 |
Body(json) |
String |
- |
|
4 |
agentIds |
必选 |
Body(json) |
string |
- |
应用id数组 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|
请求报文: { "publisherId":"e155819259bf4e469ed04bcd1f5cb110", "platformCode":"420100", "loginPlatformCode":"888888", "agentIds":["100000","124048"] } 应答报文: { "retCode": "000000", "retDesc": "无应用消息" }
用于以应用的名义发送消息给指定学校或个人,用户可以在慧教云平台空间、教学助手、移动终端家校帮或者微信公众号查看消息内容。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/msgCenter/message/sendAppMsg |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
usessionId |
必选 |
String |
64 |
会话id,唯一标识一个登录用户 |
2 |
sendeeId |
必选 |
String |
- |
接收人的personid,多个人用‘|’分隔; 当receiveOrgId字段不为空时,支持全部或按角色发送:全部为@all,全部教职工为@tea,全部家长为@par,全部学生为@stu |
3 |
receiveOrgId |
可选 |
String |
64 |
发送给指定学校 |
4 |
publisher |
可选 |
String |
100 |
消息来源,发送人自定义名称 |
5 |
agentId |
必选 |
String |
64 |
微应用id |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|
请求报文: { "appUrl": "http://xiao.huijiaoyun.com:9801/zhxy_app/repairApply/viewRepairApplyDetail?applyId=1000149500001735&viewType=1&schoolId=10004530", "platformCode": "888888", "senderorgaid": "cbaa19e76e524c48a0cc10173205137f", "appMessageUrl": "http://xiao.huijiaoyun.com:9801/zhxy_app/repairApply/viewRepairApplyDetail?applyId=1000149500001735&viewType=1&schoolId=10004530", "toorga": "cbaa19e76e524c48a0cc10173205137f", "agentId": "100000", "type": "1", "pcUrl": "http://xiaoyuan.huijiaoyun.com/zhxy/webschoolforward?url=/webschool/n/OA/Repaire/repaire_detail_view.jsp?applyRepaireId=1000149500001735", "publisher": "消息中心", "sendeeId": "5a7c7ee56ae0449bbe131faf2655667b|4beed2d160fc4d248badebb07cdecfb4|5c2aa260bf0643d4aa229eacc7b8a6af|cfd8f03d32764f8d8278da2b6c6eb147|d6e95232c6a14ae6beefb1160c100bf3|cbaa19e76e524c48a0cc10173205137f", "agentid": "100000", "id": "UsRepaire1000149500001735", "sender": "6c3d7e609abe422aa401d702a32b0a14", "createtime": "20171127164644", "messageUrl": "http://xiaoyuan.huijiaoyun.com/zhxy/webschoolforward?url=/webschool/n/OA/Repaire/repaire_detail_view.jsp?applyRepaireId=1000149500001735", "oa": { "head": { "bgcolor": "FFCC0000", "text": "电教报修" }, "body": { "form": [{ "value": "彭乐凡", "key": "报修人" }, { "value": "18924649240", "key": "联系电话" }, { "value": "网络故障", "key": "报修主题" }, { "value": "人为损坏", "key": "报修原因" }, { "value": "校长室", "key": "报修地点" }, { "value": "", "key": "报修具体内容" }], "title": "彭乐凡报修校长室网络故障" } }, "msgtype": "oa", "userId": "6c3d7e609abe422aa401d702a32b0a14", "access_token": "", "loginPlatformCode": "888888", "noticeType": 2 } 应答报文: { "msgid": "e258041b-b310-463e-b918-b80a150f68dc", "retCode": "000000", "retDesc": "成功", "msgId": "485928" }
提供给开放平台的开发者,批量对用户接收到的消息设置已读或未读
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/msgCenter/message/modMsgStatus |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
publisherId |
必选 |
Body(json) |
String |
- |
接收人教育云用户id,不为待审批消息时,必传 |
2 |
msgId |
必选 |
Body(json) |
JSON |
- |
应用消息id消息集合,最多50个 |
3 |
isRead |
可选 |
Body(json) |
String |
- |
已读未读状态:0未读,1已读;默认1 |
4 |
platformCode |
可选 |
Body(json) |
String |
- |
用户平台码 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|
请求报文: { "publisherId":"7b551a5f23c242838c04e0fb02196e51", "platformCode":"420100", "isRead":1, "msgId":["3806","1312"] } 应答报文: { "retCode": "000000", "retDesc": "操作成功" }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |