top
关闭

开发者登录

统一消息API

主要使用场景:需要整合慧教云平台统一消息中心的能力时使用,包括应用消息和通知公告的发送、接收、查看

1、应用消息发送接口

用于以应用的名义发送消息给指定学校或个人,用户可以在慧教云平台空间、教学助手、移动终端家校帮或者微信公众号查看消息内容。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/msgCenter/message/sendAppMsg?accessToken=ACCESS_TOKEN
请求方式 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

             

返回说明

序号 字段名 约束 类型 长度 说明

示例

2、消息列表获取接口

用于获取个人消息列表数据。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/msgCenter/message/getMsgList?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

usessionId

必选

String

64

会话id,唯一标识一个登录用户

2

type

可选

Int

2

消息类型:5.通知公告,12.应用消息;不传为全部

3

isRead

可选

Int

2

已读未读状态:0未读,1已读;不传为全部

3

keyword

可选

String

255

标题模糊查询关键字

5

pageNum

可选

Int

8

当前页码,从1开始,默认1

6

pageRows

可选

Int

8

每页返回行数,默认10

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

可选

String

6

返回结果标识:000000:成功

2

retDesc

必选

String

100

结果描述

3

total

可选

Int

8

总条数

4

pageNum

可选

Int

8

当前页码

5

pageRows

可选

String

8

每页返回行数

6

msgList

必选

Json对象

-

数据集合

6.1

msgId

必选

Int

32

消息id

6.2

type

必选

Int

2

消息类型:5.通知公告,12.应用消息;

6.3

title

必选

String

100

消息标题

6.4

publisher

必选

String

100

消息来源

6.5

publishDate

必选

Int

32

发送时间 时间戳

示例

							请求报文:
{
	"publisherId":"5a36729b67574777b6aa25bdb6b5c280",
	 "platformCode":"420100",
      "loginPlatformCode":"888888"
}
返回报文:
{
   "total": "4",
   "retCode": "000000",
   "retDesc": "操作成功",
   "msgList":    [
            {
         "appUrl": null,
         "title": "待办事项",
         "msgId": "15732",
         "type": "5",
         "publishDate": "1479088266",
         "pcUrl": null,
         "publisher": "冯梦洁"
      },
            {
         "appUrl": null,
         "title": "33333333333333333",
         "msgId": "15727",
         "type": "5",
         "publishDate": "1479086720",
         "pcUrl": null,
         "publisher": "冯梦洁"
      },
            {
         "appUrl": null,
         "title": "还不错还不错还不错还不错还不错",
         "msgId": "4601",
         "type": "5",
         "publishDate": "1476423809",
         "pcUrl": null,
         "publisher": "胡宽"
      },
            {
         "appUrl": null,
         "title": "发送新通知发送新通知",
         "msgId": "4598",
         "type": "5",
         "publishDate": "1476423113",
         "pcUrl": null,
         "publisher": "胡宽"
      }
   ]
}
						

3、获取消息已读未读人员列表

获取消息记录已读未读状态。

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/msgcenter/message/getMsgStatusList?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

msgId

必选

String

64

消息id

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

返回码

2

retDesc

必选

String

返回码描述

3

readList

必选

Json对象

-

已读的人员userId列表

3.1

userId

可选

String

64

用户id

3.2

userName

可选

String

64

用户name

4

unreadList

可选

Json对象

-

未读人员列表

示例

							请求报文:
{        
  "loginPlatformCode":"888888",
  "platformCode":"420100",
  "msgId":"2168"
}
返回报文:
{
   "retCode": "000000",
   "retDesc": null
}
						

4、更新消息状态接口

提供给开放平台的开发者,批量对用户接收到的消息设置已读或未读

前置条件

请求说明

url http://opengate.huijiaoyun.com/msgcenter/message/modMsgStatus?accessToken=ACCESS_TOKEN
请求方式 get
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

usessionId

必选

String

64

会话id,唯一标识一个登录用户

2

msgList

必选

Json对象

-

消息集合

2.1

msgId

必选

Int

32

消息id

2.2

isRead

必选

Int

2

已读未读状态:0未读,1已读;默认1

返回说明

序号 字段名 约束 类型 长度 说明

2

retCode

必选

String

6

返回结果标识:000000:成功

2

retDesc

必选

String

100

结果描述

示例

							请求报文:
{
	 "publisherId":"7b551a5f23c242838c04e0fb02196e51",
	 "platformCode":"888888",
      "loginPlatformCode":"888888",
	 "isRead":1, 
       "msgId":["2334","2335","2327","2171"]
}
返回报文:
{
   "retCode": "000000",
   "retDesc": "操作成功",
   "n": "0"
}
						

5、查询待阅/待我审批消息数

提供给开放平台的开发者,用于查询自己收到的消息数,可获取通过已读未读、已确认未确认、业务操作状态等条件筛选消息数;

前置条件

请求说明

url http://opengate.huijiaoyun.com/msgCenter/message/queryAllMsgCount?accessToken=ACCESS_TOKEN
请求方式 get
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

publisherId

必选

String

64

接收人教育云用户id

2

noticeType

必选

Int

1

通知类型:1.待阅消息;2.待审批;

3

isRead

可选

Int

1

已读未读状态:0.未读,1.已读;

4

isConfirm

可选

Int

1

确认状态:0未确认,1已确认

5

operatorStatus

可选

Int

1

业务操作状态:0.未处理\初始状态;1.已处理\通过\完成\批准;2.不通过\拒绝性的

6

platformCode

必选

String

8

教育云用户平台编码

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6

返回结果标识:000000:成功

2

retDesc

必选

String

100

结果描述

3

count

可选

Int

3

消息数

示例

							请求报文:
{
	 "publisherId":"e155819259bf4e469ed04bcd1f5cb110",
	 "platformCode":"420100",
       "loginPlatformCode":"888888",
       "noticeType":1,
	  "isConfirm":0
}
返回报文:
{
   "total": 4,
   "retCode": "000000",
   "retDesc": "操作成功"
}
						

6、查询应用的消息数

提供给开放平台的开发者,用于查询自己收到的应用的消息数,可获取通过已读未读、已确认未确认等条件筛选消息数;

前置条件

请求说明

url http://opengate.huijiaoyun.com/msgCenter/message/queryAppMsgCount?accessToken=ACCESS_TOKEN
请求方式 get
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

2

agentIds

必选

JSON对象

-

应用id数组,最多50个;

3

isRead

可选

Int

1

已读未读状态:0.未读,1.已读

4

isConfirm

可选

Int

1

确认状态:0未确认,1已确认

5

platformCode

必选

String

6

教育云用户平台编码

1

publisherId

必选

String

64

接收人教育云用户id

返回说明

序号 字段名 约束 类型 长度 说明

2

retDesc

必选

String

100

结果描述

3

agentList

必选

JSON对象

-

应用消息数组

3.1

agentId

必选

String

64

应用消息数组

3.2

count

必选

Int

3

消息数

4

total

必选

Int

3

总数

1

retCode

必选

String

6

返回结果标识:000000:成功

示例

							请求报文:
{
	  "publisherId":"e155819259bf4e469ed04bcd1f5cb110",
	 "platformCode":"420100",
       "loginPlatformCode":"888888",
	   "agentIds":["100000","124048"]
}
返回报文:
{
   "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"
	}
}
											

参数说明

请求参数消息体-link类
序号 字段名 约束 类型 长度 说明

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"
	}
}
											

参数说明

请求参数消息体-oa类
序号 字段名 约束 类型 长度 说明

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

消息体的关键字对应的值