top
关闭

开发者登录

空间公共内容展示API

主要使用场景:需要整合慧教云平台的公共头尾时使用,使应用系统的页头页尾与平台一致

1、空间公共HTML展现信息接口

获取门户空间公共HTML部分信息,使得应用能够方便的使用门户或者空间,例如头部和底部页面HTML代码。

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

method

必选

String

32

commonHTML

2

params

必选

JSON[]

POST 参数JSON[]

3

portalType

可选

Int

门户类型 0:web 1:wap 2:客户端

4

isLogin

可选

Int

用户登录状态,可以通过该参数强制获取非登录状态的公共html代码 0:未登录 1:已登录

5

usessionId

可选

String

255.0

单点登录成功后通过平台用户中心(AAM)子系统接口获取到的用户会话参数,展现子系统通过该参数判定用户是否登录,判定通过则返回已经登录的公共HTML代码,判定失败则返回用户未登录的数据代码

6

areaCode

可选

String

6.0

虚拟门户使用行政区域编码,默认为国家 国家:100000 湖北:420000 武汉:420100 东阳:330783

7

type

必选

String

20.0

公共HTML代码部分类型 header:门户页眉 footer:门户页脚 zoneHeader:空间页眉 zoneFooter:空间页脚

8

version

可选

String

20.0

WAP版本 1:简版 2:3G版 3:触屏版

9

resourceId

可选

String

20.0

应用或资源接入编号,为了门户或空间应用统一面包屑,应用介绍,入口统计做依据

10

logoArea

可选

String

10.0

控制logo区域一行是否显示,默认显示,0不显示,非0显示

11

spaceUid

可选

String

32.0

被访问用户空间的用户id

12

headType

可选

String

2.0

空间头类型 1:学校 2:班级 3:访客

13

scid

可选

String

32.0

学校id或班级id 与headtype结合使用

14

logo

可选

String

1.0

取门户头时logo头像,默认0是武汉1是一师一课

返回说明

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

1

retCode

必选

String

6.0

返回码

2

retDesc

必选

String

返回码描述

3

result

必选

JSON

返回的参数

3.1

commonContent

可选

String

对应的公共页面Html内容

3.2

platformCode

可选

String

平台编码

示例

							请求报文:
{
"method":"commonHTML",
"params":{
      "islogin":"0",
       "areacode":"888888",
       "type":"header",
       "logoArea":"0"
}
} 
应答报文:
{
   "retCode": "000000",
   "retDesc": "请求成功!",
   "result":    {
      "commonContent":  "HTML页面",
      "platformCode": "888888"
   }
}
						

2、应用推送动态

提供给第三方平台,应用推送动态

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

params

必选

JSON对象

-

参数

1.1

url

必选

String

255

标题的url地址(可直接访问的网址)

1.2

title

必选

String

255

标题(不要带中文《》)

1.3

content

可选

String

255

描述内容

1.4

imgUrl

可选

String

255

图片地址(视频模式为单张;图片模式可多张,多张图片时以英文分号;分隔,或者以一维数组传递)

1.5

videoUrl

可选

String

255

可直接播放的视频地址(以MP4格式最好)

1.6

appTempId

必选

String

255

注册的动态模板id

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

示例

							请求报文:
{
    "params": {
        "title": "ww1122",
        "content": "11111",
        "url": "http://www.baidu.com",
        "imgUrl": "http://www.baidu.com",
        "videoUrl": "http://bce.huijiaoyun.cn/******.mp4",
        "appTempId": "1CF27BDE410675F95877CF40******"
    }
}
返回报文:
{
  "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

消息体的关键字对应的值