top

关闭

开发者登录

返回开放文档
API导航
基础数据类API
机构基本信息API
用户基本信息API
班级基本信息API
认证会话类API
Oauth认证API
用户会话API
用户关系API

主要使用场景：

1、推送接口

推送接口

前置条件

a.获取接口访问凭证：accessToken

请求说明

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

参数说明

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

1

platformCode

必选

Body(json)

JSON

6

 平台编码

2

type

必选

Body(json)

String

32

 应用分类

3

num

可选

Body(json)

String

6

 显示数目

返回说明

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

1

dataList

可选

JSON

-

 返回结果

1.1

catId

可选

String

32

 推送类别id

1.2

siteCode

可选

String

6

 区域编码

1.3

userName

可选

String

32

 用户姓名

1.4

userAccount

可选

String

32

 用户账号

1.5

personId

可选

String

32

 用户id

1.6

userOrgName

可选

String

64

 用户所在机构名称

1.7

className

可选

String

64

 用户所在班级

1.8

userSubject

可选

String

64

 用户所教学科

1.8

userCage

可选

String

64

 用户所在学段

1.9

orgName

可选

String

64

 机构名称

1.10

orgCage

可选

String

64

 学校类别

1.11

orgId

可选

String

32

 机构id

1.12

createName

可选

String

64

 机构创建人姓名

1.13

memberCount

可选

int

6

 机构成员数量

1.14

orgSubject

可选

String

64

 机构所在学科（所教学科）

1.15

appCode

可选

String

32

 应用code

1.16

score

可选

String

6

 应用评分

1.17

orgArea

可选

String

6

 机构所在区域

1.18

collectCount

可选

int

6

 应用收藏数量

1.19

title

可选

String

64

 标题（精品资源&应用）

1.20

description

可选

String

64

 摘要（精品推荐）

1.21

thumbSmall

可选

String

100

 缩略图地址（小）

1.22

thumbMiddle

可选

String

100

 缩略图地址（中）

1.23

thumbLarge

可选

String

100

 缩略图地址（大）

1.24

url

可选

String

100

 访问链接

1.25

orderBy

可选

Int

6

 排序

1.26

remarks

可选

String

100

 备注名称（重命名）

1.27

dateTime

可选

String

32

 添加时间

示例
Copyright© 2023 All rights reserved  
鄂公网安备 42018502000485号   鄂ICP备13001992号算法推荐相关举报入口
客户服务热线：4001801818

公众号: 天喻教育
关于天喻
公司简介
业务定位
资质证书
成果案例
开放平台
开发者首页
开发者文档
开发者协议
帮助反馈
在线客服
问题反馈
帮助中心
服务支持
服务条款
运营支持
应用监控
联系我们
服务网点
商务合作
证书查询

参数说明

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

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

消息体的关键字对应的值