top
关闭

开发者登录

空间公共内容展示API

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

1、文章-删除

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

json

-

用户编号

2

id

必选

Body(json)

json

-

文章编号

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/post/del?accessToken=******
请求报文:
{
		"id":"1611675611",
		"userid":"d7780bb644aa4c8a9b8f003ee0ca9aa5"
}

应答报文:
{
  "code": "000000",
  "message": "删除成功!",
  "runtime": "0.48239"
}                 
						

2、安管-解锁用户空间记录

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

可选

Body(json)

string

-

用户id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

消息提示

3

data

可选

string

-

返回数据结果

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/control/unlock?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "操作成功!",
    "data": 1
}               
						

3、个人空间-学生通过年级学期获取成绩

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/space/openapi/score/getScoreByGradeTerm
请求方式 GET
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

返回说明

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

示例

							请求报文:
http://www.t.huijiaoyun.com//index.php?r=openapi/score/getScoreByGradeTerm&userid=a8c07c12dbb748b3badffaa0ecb0008c&grade=11&term=2
应答报文:
{"code":"000000","message":"查询成功!","result":[],"runtime":"0.43965"}
						

4、动态-点赞

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

sessionid

必选

Body(json)

json

-

用户会话id

2

id

必选

Body(json)

json

-

动态id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://www.t.huijiaoyun.com/index.php?r=api/openTrends/addPraise?accessToken=******
请求报文:
{
	"sessionid":"******",
	"id":"******"
}

应答报文:
{
    "code": "000000", 
    "message": "成功", 
    "runtime": "0.01751"
}               
						

5、应用推送动态

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

前置条件

1、获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

params

必选

Body(json)

JSON对象

-

参数

1.1

url

必选

Body(json)

String

255

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

1.2

title

必选

Body(json)

String

255

标题(不要带中文《》)

1.3

content

可选

Body(json)

String

255

描述内容

1.4

imgUrl

可选

Body(json)

String

255

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

1.5

videoUrl

可选

Body(json)

String

255

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

1.6

appTempId

必选

Body(json)

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": "成功"
}
						

6、统计-空间获取统计数(动态数 文章数 相册数 留言数 访客数

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userId

必选

Body(json)

string

-

被访者用户id

返回说明

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

1

code

可选

string

-

状态码 000000:表示成功

2

message

可选

string

-

消息提示

3

data

可选

string

-

结果集

3.1

trends_num

可选

int

-

动态数

3.2

post_num

可选

int

-

文章数

3.2

photo_num

可选

int

-

相片数

3.4

message_num

可选

int

-

留言数

3.5

visitor_num

可选

int

-

被访问数

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/visitor/spaceCensus?accessToken=b61e79d4d3e840be8******&userId=ef84cb7cbc56419aad2ba5d******

应答报文:
{
    "code": "000000",
    "message": "",
    "data": {
        "trends_num": 68,
        "post_num": 33,
        "photo_num": 21,
        "message_num": 0,
        "visitor_num": 59
    }
}          
						

7、相册-照片点赞

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

json

-

照片id

2

sessionid

必选

Body(json)

json

-

用户会话id

3

albumid

必选

Body(json)

json

-

相册id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/photo/addPraise?accessToken=******

请求报文:
{
		"id":"1804298",
		"albumid":"1069473",
		"sessionid":"8ef5405e-34bd-4455-bc63-b938bba59d4c"
}

应答报文:
{
    "code": "000000", 
    "message": "点赞成功", 
    "runtime": "0.01751"
}                
						

8、统计-获取平台当前在限人数

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

data

可选

string

-

返回结果

3.1

count

可选

int

-

平台当前在限人数统计

4

runtime

可选

string

-

返回速度

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/user/onlineCount?accessToken=******

应答报文:
{
    "code":"000000",
    "message":"查询成功",
    "data":
        {
            "count":0
        },
    "runtime":"0.75569"
}              
						

9、动态-详情

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

sessionid

可选

Body(json)

string

-

用户会话id,如果不传,只能看公开的动态

2

id

必选

Body(json)

int

-

动态id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

id

可选

string

-

动态id

4.2

type

可选

int

-

动态动作类型(发布个人文章1001,转载文章1002)

4.3

objecttype

可选

int

-

动态对象类型(规定文章对象类型为1000)

4.4

objectid

可选

string

-

业务动作id(发布文章时的id)

4.5

objectpid

可选

string

-

业务动作分类id(发布文章时的文章分类id)

4.6

comment_id

可选

int

-

被评论、回复的评论id(动态是由评论产生的)

4.7

user_img

可选

string

-

动态主体的用户头像

4.8

user_name

可选

string

-

动态主体的用户姓名

4.9

user_type

可选

string

-

动态主体的用户类型(0学生,1老师,2家长等等)

4.10

user_id

可选

string

-

动态主体的用户id

4.11

content

可选

string

-

业务文字内容(比如文章内容)

4.12

title

可选

string

-

业务文字标题(比如《父亲的手》)

4.13

img_list

可选

json

-

图片二维数组

4.13.1

big_src

可选

string

-

原图片地址

4.13.2

src

可选

string

-

170x170的图片地址

4.14

img_count

可选

string

-

图片的张数

4.15

typename

可选

string

-

业务划分(post文章类型,photo相册类型,res资源类型,msg说说类型)

4.16

resource_download_url

可选

string

-

为资源类型时,提供资源下载地址

4.17

resource_id

可选

string

-

为资源类型时,提供资源文件fid(也可能没资源文件fid)

4.18

resource_icon

可选

string

-

为资源类型时,web资源图标地址

4.19

resource_ext

可选

string

-

为资源类型时,资源格式

4.20

url

可选

string

-

web业务连接地址

4.21

is_report

可选

string

-

是否有举报权限

4.22

is_del

可选

string

-

是否有删除权限

4.23

power

可选

string

-

动态权限范围(1公开,2好友,3私密)

4.24

power_msg

可选

string

-

动态权限文字说明

4.25

fid_type

可选

int

-

二次动态来源类型,转发1,赞2,评论3,回复4

4.26

action_title

可选

string

-

动作描述标题(转发了xx的动态)

4.27

show_startid

可选

string

-

是否为二次动态(true和false,非原生的都属于)

4.28

content_forward

可选

string

-

二次动态描述内容(比如用户转载时写的描述)

4.29

startid_user_id

可选

string

-

源头动态生成者的用户id

4.30

startid_user_name

可选

string

-

源头动态生成者的用户姓名

4.31

startid_user_type

可选

string

-

源头动态生成者的用户类型

4.32

startid_action_title

可选

string

-

源头动态的动作描述标题(发布了文章)

4.33

startid_pubdate

可选

string

-

源头动态友好时间格式

4.34

startid_pubdate_time

可选

string

-

源头动态时间戳

4.35

pubdate

可选

string

-

动态友好时间格式

4.36

pubdate_time

可选

string

-

动态时间戳

4.37

show_form

可选

string

-

动态来自哪里

4.38

is_commont

可选

string

-

动态的展示状态(1公开,0私有)

4.39

show_praise

可选

string

-

是否可以点赞(true和false)

4.40

praise_num

可选

int

-

点赞数

4.41

praise_list

可选

string

-

点赞人列表信息

4.42

praise_exists

可选

string

-

查看者是否已点赞(true和false)

4.43

show_forward

可选

string

-

是否可以转载(true和false)

4.44

forward_num

可选

int

-

转载次数

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/trends/info?accessToken=******&id=******

应答报文:
{
    "code": "000000", 
    "result": {
        "id": 596984, 
        "type": 1001, 
        "objecttype": 1000, 
        "objectid": "1611662943", 
        "objectpid": "2665477", 
        "comment_id": 0, 
        "user_img": "http://www.t.huijiaoyun.com/uploads/avatar/data/85/8/c1a1bea5b90a4f309f96adf11e608cd7_180x180.jpg?1498459355", 
        "user_name": "肖伟", 
        "user_type": 1, 
        "user_id": "c1a1bea5b90a4f309f96adf11e608cd7", 
        "content": "4444", 
        "title": "444", 
        "is_commont": 1, 
        "typename": "post", 
        "url": "http://www.t.huijiaoyun.com/index.php?r=space/person/post/view&sid=c1a1bea5b90a4f309f96adf11e608cd7&id=1611662943", 
        "is_del": false, 
        "is_report": true, 
        "power_msg": "公开", 
        "action_title": "发表了文章", 
        "show_startid": false, 
        "pubdate": "07-25 13:42", 
        "pubdate_time": 1500961333, 
        "show_form": "文章", 
        "show_praise": true, 
        "praise_num": 1, 
        "praise_list": [
            {
                "USER_SYS_CODE": "8495963a22da4b5baf6c321dfdccbcaa", 
                "USER_NAME": "柳小小", 
                "PUBDATE": 1501125682, 
                "ID": null, 
                "PID": null
            }
        ], 
        "praise_exists": false, 
        "show_forward": true, 
        "forward_num": 1
    }, 
    "runtime": "0.01751"
}                        
						

10、相册-保存上传照片至相册

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

albumid

必选

Body(json)

json

-

相册id

2

photokey

必选

Body(json)

json

-

上传照片安全码

3

content

可选

Body(json)

json

-

描述内容,200字符以内

4

sessionid

必选

Body(json)

json

-

用户会话id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/photo/photoUploadSave?accessToken=******
请求报文:
{
	"albumid":"******",
	"photokey":"******",
	"sessionid":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "操作成功", 
    "runtime": "0.03398"
}                 
						

11、动态-转载动态

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

json

-

动态id

2

sessionid

必选

Body(json)

json

-

用户会话id

3

desc

可选

Body(json)

json

-

转载的描述,140字符以内

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/trends/forward?accessToken=******
请求报文:
{
	"id":"******",
	"sessionid":"******",
	"desc":"******"
}

应答报文:
{
    "code": "000000", 
    "message": "成功", 
    "runtime": "0.01751"
}               
						

12、访问量-空间访客记录

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userId

必选

Body(json)

json

-

被访者用户id

2

visitorId

必选

Body(json)

json

-

访问者用户id

3

source

必选

Body(json)

json

-

访问来源 0:web 1:移动

4

visitorType

必选

Body(json)

json

-

访问者用户身份类型 0学生 1老师 2家长等

5

visitorName

必选

Body(json)

json

-

访问者用户名称

返回说明

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

1

code

可选

string

-

000000:表示成功

2

message

可选

string

-

消息提示

3

data

可选

string

-

当成功是 返回空,错误返回错误参数结果集

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/visitor/spaceVisits?accessToken=******

请求报文:
{
    "userId":"******",
	"visitorId":"******",
	"source":"******",
	"visitorType":"******",
	"visitorName":"******"
}
应答报文:
{
    "code": "000000",
    "message": "保存成功",
    "data": ""
}                
						

13、个人空间留言、回复留言

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

params

可选

Body(json)

string

-

1.1

content

必选

Body(json)

json

-

留言内容

1.2

type

必选

Body(json)

json

-

类型 留言就传message

1.3

objectid

必选

Body(json)

json

-

被留言者用户id

1.4

objectpid

可选

Body(json)

json

-

目标父id

1.5

pid

可选

Body(json)

json

-

所回复的留言id

1.6

userid

必选

Body(json)

json

-

留言者id

1.7

username

必选

Body(json)

json

-

留言者名称

1.8

snsid

可选

Body(json)

json

-

是否是社区评论

1.9

byreply_userid

可选

Body(json)

json

-

被回复用户id

1.10

byreply_username

可选

Body(json)

json

-

被回复用户名称

1.11

byreply_id

可选

Body(json)

json

-

被回复目标id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

data

可选

string

-

返回结果

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/messagenew/publishMessage?accessToken=******
请求参数
{
	"params":{
		"objectid":"ef84cb7cbc56419aad2ba5d14a9a3375",
		"type":"message",
		"content":"测试留言",
		"userid":"3e0e37aeb85d4404b85b533ca570ee7a",
		"username":"陈教师二"
	}
}

应答报文:
{
    "code":"000000",
    "message":"success",
    "data":982799
}                   
						

14、相册-分类创建

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

title

必选

Body(json)

json

-

名称标题,30字符以内

2

right

必选

Body(json)

json

-

相册权限,1公开,2好友,3私密

3

content

可选

Body(json)

json

-

相册描述内容

4

sessionid

必选

Body(json)

json

-

用户会话

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

id

可选

string

-

分类id

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/photo/albumCreate?accessToken=******
请求报文:
{
"title":"******",
"right":"******",
"sessionid":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": {
        "id": 1
    }, 
    "runtime": "0.03398"
}            
						

15、文章-文章详情

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

usertype

可选

Body(json)

string

-

用户类型

2

filter

可选

Body(json)

int

-

移动端适应

3

username

可选

Body(json)

string

-

用户名称

4

count

可选

Body(json)

int

-

是否累加阅读量 1 (展现端传递1)

5

userid

可选

Body(json)

string

-

用户编号

6

id

必选

Body(json)

int

-

文章编号

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

info

可选

string

-

结果详情

4.1.1

id

可选

string

-

文章id

4.1.2

userid

可选

string

-

用户id

4.1.3

username

可选

string

-

用户昵称

4.1.4

organizationid

可选

string

-

机构id

4.1.5

classid

可选

string

-

班级id

4.1.6

title

可选

string

-

文章标题

4.1.7

content

可选

string

-

文章内容

4.1.8

categoryid

可选

string

-

分类id

4.1.9

article_category_id

可选

string

-

4.1.10

publishid

可选

string

-

4.1.11

parentid

可选

string

-

4.1.12

paperid

可选

string

-

4.1.13

copyid

可选

string

-

4.1.14

type

可选

string

-

类型

4.1.15

external_type

可选

string

-

外部类型

4.1.16

tags

可选

string

-

标签

4.1.17

datetime

可选

string

-

发布时间

4.1.18

updatetime

可选

string

-

更新时间

4.1.19

searchtime

可选

string

-

最后查看时间

4.1.20

status

可选

string

-

状态

4.1.21

copy_status

可选

string

-

转载状态

4.1.22

comment_status

可选

string

-

评论状态

4.1.23

comment_count

可选

string

-

评论总数

4.1.24

view_count

可选

string

-

阅读总数

4.1.25

like_count

可选

string

-

喜欢总数

4.1.26

copy_count

可选

string

-

转载总数

4.1.27

favorite_count

可选

string

-

收藏总数

4.1.28

child_count

可选

string

-

4.1.29

resource

可选

string

-

4.1.30

istop

可选

string

-

是否置顶

4.1.31

isdel

可选

string

-

是否删除

4.1.32

reply_status

可选

string

-

回复状态

4.1.33

operate

可选

string

-

4.1.34

issnspost

可选

string

-

4.1.35

isPrivate

可选

string

-

是否私密文章

4.1.36

credit

可选

string

-

学分

4.1.37

experience

可选

string

-

经验

4.1.38

password

可选

string

-

4.1.39

publisher

可选

string

-

4.1.40

original_type

可选

string

-

原始类型

4.1.41

original_type_url

可选

string

-

原始类型地址

4.1.42

studyphase

可选

string

-

4.1.43

majorsubjectid

可选

string

-

4.1.44

majorsubjectname

可选

string

-

4.1.45

usertype

可选

string

-

用户类型

4.1.46

platformCode

可选

string

-

平台码

4.1.47

shareid

可选

string

-

4.1.48

commendlevel

可选

string

-

4.1.49

areacode

可选

string

-

区域码

4.1.50

hasPicture

可选

string

-

是否有图片

4.1.51

issharepost

可选

string

-

4.1.52

objectid

可选

string

-

4.1.53

taskId

可选

string

-

4.1.54

from_type

可选

string

-

来源类型

4.1.55

from_move

可选

string

-

4.1.56

has_add_credit

可选

string

-

是否增加学分

4.1.57

templateid

可选

string

-

模板id

4.1.58

musicid

可选

string

-

背景音乐id

4.1.59

cover

可选

string

-

封面

4.1.60

source

可选

string

-

资源

4.1.61

categorytitle

可选

string

-

分类名称

4.1.62

copy_userid

可选

string

-

转载人用户id

4.1.63

copy_username

可选

string

-

转载人昵称

4.1.64

music

可选

string

-

背景音乐集

4.1.64.1

category_id

可选

string

-

音乐集id

4.1.64.2

category_name

可选

string

-

音乐集名称

4.1.64.3

category_description

可选

string

-

音乐集描述

4.1.64.4

category_music_count

可选

string

-

音乐集音乐数量

4.1.64.5.6

datetime

可选

string

-

添加时间

4.1.64.5.4

url

可选

string

-

地址

4.1.64.5.5

content

可选

string

-

描述

4.1.64.5.1

id

可选

string

-

音乐id

4.1.64.5.7

display_order

可选

string

-

排序

4.1.64.5

category_music_list

可选

string

-

音乐集音乐信息

4.1.64.5.2

category_id

可选

string

-

音乐分类id

4.1.64.5.3

title

可选

string

-

音乐名称

4.1.64.5.8

status

可选

string

-

状态

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/view?accessToken=******&id=******

应答报文:
{
  "code": "000000",
  "message": "请求成功",
  "runtime": "0.66171",
  "result": {
    "info": {
      "id": 1611612785,
      "userid": "eab92753997b41d49032fa104b78c6a6",
      "username": "滕老师",
      "organizationid": "cbaa19e76e524c48a0cc10173205137f",
      "classid": null,
      "title": "初三物理理论知识",
      "content": "


\"image\"初三物理理论知识,概念介绍;

", "categoryid": 2597959, "article_category_id": null, "publishid": 0, "parentid": null, "paperid": 0, "copyid": null, "type": "post", "external_type": "public", "tags": "学无止", "datetime": 1426579188, "updatetime": 1486707652, "searchtime": "2018-07-24 14:41:49", "status": "publish", "copy_status": "close", "comment_status": "close", "comment_count": 0, "view_count": 39, "like_count": 1, "copy_count": null, "favorite_count": 0, "child_count": null, "resource": "", "istop": 1472026683, "isdel": null, "reply_status": null, "operate": null, "issnspost": null, "isPrivate": null, "credit": 0, "experience": 0, "password": "", "publisher": null, "original_type": null, "original_type_url": null, "studyphase": "0", "majorsubjectid": "jcsub30", "majorsubjectname": "劳动技术", "usertype": "1", "platformCode": "888888", "shareid": null, "commendlevel": null, "areacode": "420106", "hasPicture": null, "issharepost": null, "objectid": null, "taskId": null, "from_type": null, "from_move": null, "has_add_credit": null, "templateid": null, "musicid": null, "cover": null, "source": null, "categorytitle": "111", "copy_

16、个人中心-获取个人空间头像

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/space/api/openicon/index
请求方式 GET
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

id

必选

Body(json)

string

-

用户id

2

size

可选

Body(json)

string

-

头像大小 1=小 2=中 3=大

3

type

可选

Body(json)

string

-

头像类型,默认0 0=用户 1=机构 2=学校 3=班级

返回说明

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

1

code

可选

string

-

返回状态

2

url

可选

string

-

头像地址

示例

							请求报文:
http://opengate.huijiaoyun.com/space/api/openicon/index?id=xxxxx
应答报文:
{
    "code": "000000",
    "url": "xxx"
}
						

17、安管-添加或编辑管控

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

type_fun

必选

Body(json)

string

-

类型 1发布留言 2发布评论 3转载动态 4发布文章

2

end_date

必选

Body(json)

string

-

管控结束时间

3

id

可选

Body(json)

string

-

编号,增加时不传,编辑时必须传

4

message

必选

Body(json)

string

-

提示内容

5

star_date

必选

Body(json)

string

-

管控开始时间

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

消息提示

3

data

可选

string

-

返回参数

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/control/operatControl?accessToken=******
请求报文:
{
	"type_fun":1,
	"message":"暂时禁止发布留言",
	"star_date":1532424329,
	"end_date":1532510729
}

应答报文:
{
    "code": "000000",
    "message": "保存成功!",
    "data": {
        "type_fun": "2",
        "message": "暂时无法评论",
        "star_date": 1532069327,
        "end_date": 1532155727
    }
}                                
						

18、动态-发布的动态数量

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

type

必选

Body(json)

string

-

wap_person客户端-个人动态

2

userid

必选

Body(json)

string

-

用户id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

userid

可选

string

-

用户id

4.2

num

可选

string

-

动态数量

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/trends/getTrendsNum?accessToken=******&userid=******&type=wap_person

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": {
        "userid": '1000', 
        "num": 180
    }, 
    "runtime": "0.01751"
}          
						

19、安管-管控控制列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

消息提示

3

data

可选

string

-

返回数据结果

3.1

id

可选

string

-

编号

3.2

type_fun

可选

string

-

类型 1发布留言 2发布评论 3转载动态 4发布文章

3.3

message

可选

string

-

提示内容

3.4

star_date

可选

string

-

管控开始时间(时间戳)

3.5

end_date

可选

string

-

管控结束时间(时间戳)

3.6

create_time

可选

string

-

创建时间

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/control/getControlist?accessToken=******


应答报文:
{
    "code": "000000",
    "message": "",
    "data": [
        {
            "id": 2,
            "type_fun": 1,
            "message": "暂时禁止发布留言",
            "star_date": 1506873600,
            "end_date": 1527609600,
            "create_time": 1508825256
        },
        {
            "id": 3,
            "type_fun": 2,
            "message": "暂时禁止发布评论!",
            "star_date": 1526918400,
            "end_date": 1527696000,
            "create_time": 1508825748
        },
        {
            "id": 4,
            "type_fun": 3,
            "message": "暂时禁止转载动态!",
            "star_date": 1526572800,
            "end_date": 1527477446,
            "create_time": 1509515071
        }
    ]
}                                    
						

20、安管-封锁用户空间记录

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户id

返回说明

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

1

code

可选

string

-

0返回码 00000:表示成功

2

message

可选

string

-

000000:表示成功

3

data

可选

string

-

返回数据结果

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/control/lock?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "操作成功!",
    "data": true
}               
						

21、访问量-空间访客人员列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户id

2

pagesize

可选

Body(json)

int

-

每页数量

3

page

可选

Body(json)

int

-

当前页

返回说明

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

1

code

可选

string

-

状态码 000000:表示成功

2

message

可选

string

-

消息提示

3

data

可选

string

-

返回数据结果

3.1

total

可选

string

-

总数量

3.2

lists

可选

json

-

访问人员列表

3.2.1

avatar

可选

string

-

头像

3.2.2

date_name

可选

string

-

日期

3.2.3

userid

可选

string

-

被访者用户id

3.2.4

visitorid

可选

string

-

访问者用户id

3.2.5

visitorname

可选

string

-

访问者用户名

3.2.6

lasttime

可选

string

-

访问时间

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/visitor/getVisitorlist?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "",
    "data": {
        "total": 58,
        "daytotal": 0,
        "lists": [
            {
                "avatar": "http://www.t.huijiaoyun.com/uploads/avatar/data/24/83/d7780bb644aa4c8a9b8f003ee0ca9aa5_90x90.jpg?1516676338",
                "date_name": "2018-07-12",
                "userid": "ef84cb7cbc56419aad2ba5d14a9a3375",
                "visitorid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "visitorname": "王霞",
                "lasttime": 1531391013
            },
            {
                "avatar": "http://www.t.huijiaoyun.com/uploads/avatar/data/85/36/eab92753997b41d49032fa104b78c6a6_90x90.jpg?1522380687",
                "date_name": "2018-07-03",
                "userid": "ef84cb7cbc56419aad2ba5d14a9a3375",
                "visitorid": "eab92753997b41d49032fa104b78c6a6",
                "visitorname": "滕老师",
                "lasttime": 1530604990
            },
            {
                "avatar": "http://www.t.huijiaoyun.com/uploads/avatar/data/90/30/5e01e925cbf24b4c86d98b33929338d9_90x90.jpg?1501204781",
                "date_name": "2018-04-09",
                "userid": "ef84cb7cbc56419aad2ba5d14a9a3375",
                "visitorid": "5e01e925cbf24b4c86d98b33929338d9",
                "visitorname": "李老师",
                "lasttime": 1523240233
            },
            {
                "avatar": "http://www.t.huijiaoyun.com/uploads/avatar/data/33/20/dee5f163f39d4fcebc37d93aaa661f51_90x90.jpg?1522200355",
                "date_name": "2018-04-04",
                "userid": "ef84cb7cbc56419aad2ba5d14a9a3375",
                "visitorid": "dee5f163f39d4fcebc37d93aaa661f51",
                "visitorname": "张晓雅",
                "lasttime": 1522812858
            },
            {
                "avatar": "http://www.t.huijiaoyun.com/uploads/avatar/data/90/83/69eeac6fa45c4f17b02bc09
						

22、动态-列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

查询者的用户id(wap_person、wap_related、wap_friend、wap_teacher、wap_msg、wap_attention时必传)

2

usertype

必选

Body(json)

string

-

查询者的用户类型,0学生,1老师,2家长

3

orgid

可选

Body(json)

string

-

查询者的用户学校id

4

classid

可选

Body(json)

string

-

查询者的用户班级id

5

otherinfo

可选

Body(json)

string

-

是否获取被查询者用户的其它关联信息(学校,背景图等等),1是,0否,默认0

6

startid

可选

Body(json)

string

-

查询的起始id,默认0,无起始点

7

type

必选

Body(json)

string

-

查询的类型,wap_person客户端个人动态,wap_related客户端与我相关,wap_school客户端学校动态,wap_class客户端班级动态,wap_friend客户端好友动态,wap_teacher客户端用户可见范围内的老师动态,wap_msg客户端说说动态,wap_attention客户端用户关注人的动态

8

spaceuserid

可选

Body(json)

string

-

被查询者的用户id,看他人动态时必传

9

cpagesize

可选

Body(json)

string

-

每条动态查询的评论数量,默认10

10

pagesize

可选

Body(json)

string

-

查询的数量,默认10

返回说明

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

1

code

可选

string

-

返回状态

2

runtime

可选

string

-

返回速度

3

result

可选

string

-

返回结果

3.1

id

可选

string

-

动态id

3.2

type

可选

string

-

动态动作类型(发布个人文章1001,转载文章1002)

3.3

objecttype

可选

string

-

动态对象类型(规定文章对象类型为1000)

3.4

objectid

可选

string

-

业务动作id(发布文章时的id)

3.5

objectpid

可选

string

-

业务动作分类id(发布文章时的文章分类id)

3.6

comment_id

可选

string

-

被评论、回复的评论id(动态是由评论产生的)

3.7

user_img

可选

string

-

动态主体的用户头像

3.8

user_name

可选

string

-

动态主体的用户姓名

3.9

user_type

可选

string

-

动态主体的用户类型(0学生,1老师,2家长等等)

3.10

user_id

可选

string

-

动态主体的用户id

3.11

content

可选

string

-

业务文字内容(比如文章内容)

3.12

title

可选

string

-

业务文字标题(比如《父亲的手》)

3.13

is_commont

可选

string

-

动态的展示状态(1公开,0私有)

3.14

typename

可选

string

-

业务划分(post文章类型,photo相册类型,res资源类型,msg说说类型)

3.15

url_web

可选

string

-

web业务连接地址

3.16

is_del

可选

string

-

是否有删除权限

3.17

is_report

可选

string

-

是否有举报权限

3.18

power

可选

string

-

动态权限范围(1公开,2好友,3私密)

3.19

power_msg

可选

string

-

动态权限文字说明

3.20

action_title

可选

string

-

动作描述标题(转发了xx的动态)

3.21

url

可选

string

-

wap业务连接地址

3.22

show_startid

可选

string

-

是否为衍生动态(true和false,非原生的都属于)

3.23

pubdate

可选

string

-

动态友好时间格式

3.24

pubdate_time

可选

string

-

动态时间戳

3.25

show_form

可选

string

-

动态来自哪里

3.26

comment_list

可选

string

-

评论列表

3.27

comment_num

可选

string

-

评论数

3.28

show_praise

可选

string

-

是否可以点赞(true和false)

3.29

praise_num

可选

string

-

点赞数

3.30

show_forward

可选

string

-

是否可以转载(true和false)

3.31

show_forward_code

可选

string

-

不可转载的描述码(200000限制类动态,不能转发;200001原动态是自己所发,不能转发;200003非公开类型动态,不能转发)

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/trends/list?accessToken=b61e79d4d3e840be893eacb69777f95d&userid=xxx&usertype=x&type=xx

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": [
        {
            "id": 594868, 
            "type": 1001, 
            "objecttype": 1000, 
            "objectid": "1611662453", 
            "objectpid": "2668480", 
            "comment_id": 0, 
            "user_img": "http://www.t.huijiaoyun.com/uploads/avatar/data/32/53/3187e743e6d044e7b3bba47bebd33707_45x45.jpg?1488763530", 
            "user_name": "马骏", 
            "user_type": 1, 
            "user_id": "3187e743e6d044e7b3bba47bebd33707", 
            "url": "http://www.t.huijiaoyun.com//index.php?r=space/person/post/view&sid=3187e743e6d044e7b3bba47bebd33707&id=1611662453", 
            "is_del": false, 
            "is_report": true, 
            "power_msg": "公开", 
            "action_title": "发表了文章", 
            "show_startid": false, 
            "typename": "post", 
            "content": "经常才能烦恼那些你休息吧我好吃你猜那些年息怒息怒", 
            "title": "好方法就到家", 
            "img_list": [
                {
                    "src": "http://www.t.huijiaoyun.com/uploads/170x170/post/wap/2017/05/02/1493688654_66938.jpg", 
                    "big_src": "http://www.t.huijiaoyun.com/uploads/post/wap/2017/05/02/1493688654_66938.jpg"
                }
            ], 
            "pubdate": "昨天09:43", 
            "pubdate_time": 1493689393, 
            "show_form": "文章", 
            "comment_num": 0, 
            "is_commont": 1, 
            "show_praise": true, 
            "praise_num": 0, 
            "show_forward": true, 
            "forward_num": 0
        }
    ], 
    "runtime": "0.01751",
    "info":{"orgName":"第一中学","orgId":"2","userIcon":"http://.....","userId":"111","userType":"1","userGender":"1","divImg":"http://.....","divTheme":"theme1",}
}                                                         
						

23、通讯录-好友推荐

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

被查询的用户id

2

num

可选

Body(json)

string

-

查询的数量,默认12

3

page

可选

Body(json)

string

-

被查询的页码(默认为1)

4

usertype

必选

Body(json)

string

-

被查询的用户类型,0学生,1老师,2家长

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

page

可选

string

-

返回下一页页码

4

data

可选

string

-

返回数据

4.1

username

可选

string

-

用户昵称

4.2

personid

可选

string

-

用户id

4.3

usertype

可选

int

-

用户类型

4.4

usertype_desc

可选

string

-

用户类型描述

4.5

url

可选

string

-

个人主页地址

4.6

orgname

可选

string

-

机构名称

4.7

orgid

可选

string

-

机构id

4.8

platformCode

可选

string

-

平台码

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/friendship/friendship?accessToken=******&userid=d7780bb644aa4c8a9b8f003ee0ca9aa5&usertype=1

应答报文:
{
    "code": "000000",
    "message": "成功",
    "data": [
        {
            "username": "肖川一",
            "personid": "0134c569f29f4bf78e2ba6e58b422890",
            "usertype": "1",
            "usertype_desc": "老师",
            "url": "index.php?r=space/person/index&sid=0134c569f29f4bf78e2ba6e58b422890",
            "platformCode": "420100",
            "orgname": "武汉大学第一附属小学",
            "orgid": "cbaa19e76e524c48a0cc10173205137f"
        },
        {
            "username": "张海雪",
            "personid": "F259F9A5AC957692E04010AC73D40970",
            "usertype": "1",
            "usertype_desc": "老师",
            "url": "index.php?r=space/person/index&sid=F259F9A5AC957692E04010AC73D40970",
            "platformCode": "420105",
            "orgname": "武汉市翠微中学",
            "orgid": "5309cdb1fd6646d0807fd22cac7cbd25"
        },
        {
            "username": "滕老师",
            "personid": "eab92753997b41d49032fa104b78c6a6",
            "usertype": "1",
            "usertype_desc": "老师",
            "url": "index.php?r=space/person/index&sid=eab92753997b41d49032fa104b78c6a6",
            "platformCode": "420100",
            "orgname": "武汉大学第一附属小学",
            "orgid": "cbaa19e76e524c48a0cc10173205137f"
        },
        {
            "username": "李洪绸",
            "personid": "F259F9A705C57692E04010AC73D40970",
            "usertype": "1",
            "usertype_desc": "老师",
            "url": "index.php?r=space/person/index&sid=F259F9A705C57692E04010AC73D40970",
            "platformCode": "420100",
            "orgname": "武汉东湖高新区关南中学",
            "orgid": "F6C68AAFA413437CE040007F01001D3D"
        },
        {
            "username": "白老师",
            "personid": "3e23bfb47dde4d16aebb0df38af15f58",
            "usertype": "1",
            "usertype_desc": "老师",
            "url": "index.php?r=space/perso
						

24、文章-文章喜欢

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

int

-

文章编号

2

from_username

必选

Body(json)

string

-

用户名称

3

from_userid

必选

Body(json)

string

-

用户编号

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

info

可选

string

-

结果详情

4.1.1

message

可选

string

-

点赞结果消息

4.1.2

like_count

可选

int

-

喜欢总数

4.1.3

status

可选

int

-

状态

示例

							请求报文:
http://www.t.huijiaoyun.com/index.php?r=api/openPost/like&id=1611675570&from_userid=d7780bb644aa4c8a9b8f003ee0ca9aa5&from_username=王霞

应答报文:
{
    "code": "000000",
    "message": "请求成功",
    "runtime": "0.44694",
    "result": {
        "info": {
            "message": "点赞成功",
            "like_count": 1,
            "status": 1
        }
    }
}
						

25、相册-照片列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

string

-

相册id

2

userid

必选

Body(json)

string

-

相册拥有者的用户id

3

pagesize

可选

Body(json)

int

-

返回数量,页码与返回数量同时传递时生效,否则查全部

4

page

可选

Body(json)

int

-

页码,页码与返回数量同时传递时生效,否则查全部

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

list

可选

string

-

照片列表

4.1.1

id

可选

string

-

照片id

4.1.2

albumid

可选

string

-

相册id

4.1.3

albumuserid

可选

string

-

相册所属用户id

4.1.4

image

可选

string

-

照片地址

4.1.5

name

可选

string

-

照片名称

4.1.6

description

可选

string

-

照片描述

4.1.7

size

可选

string

-

照片大小

4.1.8

userid

可选

string

-

用户id

4.1.9

username

可选

string

-

用户名称

4.1.10

uploadtime

可选

string

-

上传时间

4.1.11

iscover

可选

string

-

是否是封面

4.1.12

type

可选

string

-

类型

4.1.13

right

可选

string

-

4.1.14

pageviews

可选

string

-

4.1.15

platformCode

可选

string

-

平台码

4.1.16

areacode

可选

string

-

区域码

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/photoList?accessToken=******&userid=******&id=******

应答报文:
{
    "code": "000000",
    "message": "success",
    "result": {
        "list": [
            {
                "id": 1804298,
                "albumid": 1069473,
                "albumuserid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "image": "http://whty-source.oss-cn-beijing.aliyuncs.com/mnt/data2/2018/7/23/11/14/d7780bb644aa4c8a9b8f003ee0ca9aa5/5e0718e367424e37a21f181c2ede68d6/35c2dab00fb247e082a0dcc4256c4a29.jpg?x-oss-process=style/whty",
                "name": "1",
                "description": "",
                "size": 7881,
                "userid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "username": "王霞",
                "uploadtime": 1532315531,
                "iscover": "1",
                "type": "person",
                "right": "1",
                "pageviews": 3,
                "platformCode": "888888",
                "areacode": "421181"
            }
        ],
        "total": 1,
        "page": 1
    },
    "runtime": "0.11399"
}            
						

26、相册-照片查询点赞

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

int

-

照片id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

num

可选

string

-

点赞数

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/getPraise?accessToken=******&id=******

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": {
        "num": 10, 
    }, 
    "runtime": "0.01751"
}          
						

27、通讯录-用户取消关注

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

params

必选

Body(json)

json

-

请求参数

1.1

sessionid

必选

Body(json)

json

-

用户sessionid

1.2

attId

必选

Body(json)

json

-

取消关注对象id, 数组

返回说明

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

1

result

可选

string

-

返回状态

2

desc

可选

string

-

结果信息

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/friendship/cancelattention?accessToken=******


请求报文:
{
	"params":{
		"sessionid":"46fdb368-78fd-421c-abcd-5f97abe98b0b",
		"attId":["3e23bfb47dde4d16aebb0df38af15f58"]
	}
}

应答报文:
{
    "result": "000000",
    "desc": "cancel attentions successful!"
}            
						

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

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

前置条件

1、获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

method

必选

Body(json)

String

32

commonHTML

2

params

必选

Body(json)

JSON[]

-

POST 参数JSON[]

3

portaltype

可选

Body(json)

Int

1

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

4

islogin

可选

Body(json)

Int

1

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

5

usessionid

可选

Body(json)

String

255.0

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

6

areacode

可选

Body(json)

String

6.0

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

7

type

必选

Body(json)

String

20.0

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

8

version

可选

Body(json)

String

20.0

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

9

resourceid

可选

Body(json)

String

20.0

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

10

logoarea

可选

Body(json)

String

10.0

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

11

spaceuid

可选

Body(json)

String

32.0

被访问用户空间的用户id

12

headtype

可选

Body(json)

String

2.0

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

13

scid

可选

Body(json)

String

32.0

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

14

logo

可选

Body(json)

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

29、文章-转载

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

json

-

文章编号

2

userid

必选

Body(json)

json

-

用户编号

3

username

必选

Body(json)

json

-

用户名称

4

usertype

必选

Body(json)

json

-

用户类型

5

categoryid

必选

Body(json)

json

-

文章分类

6

organizationid

必选

Body(json)

json

-

机构编号

7

step

必选

Body(json)

json

-

步骤 1:查询转载状态, 2:转载

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/copy?accessToken=******

参数
{
		"id":"1611675570",
		"userid":"d7780bb644aa4c8a9b8f003ee0ca9aa5",
		"username":"王霞",
		"usertype":1,
		"categoryid":"2670086",
		"organizationid":"39A641E1E2677DC6E050A8C08E063B62",
		"step":2
}

应答报文:
{
  "code": "000000",
  "message": "转载文章成功!",
  "runtime": "3.89317"
}                     
						

30、文章-文章新增

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

json

-

用户编号

2

username

必选

Body(json)

json

-

用户姓名

3

organizationid

可选

Body(json)

json

-

机构(学校)编号

4

categoryid

可选

Body(json)

json

-

文章分类

5

external_type

可选

Body(json)

json

-

公开类型 public(公开可见), follow(关注可见), friend(好友可见), private(私密)

6

usertype

必选

Body(json)

json

-

用户类型

7

title

必选

Body(json)

json

-

文章标题

8

content

必选

Body(json)

json

-

文章内容

9

tags

可选

Body(json)

json

-

文章标签

10

comment_status

可选

Body(json)

json

-

评论状态 open(允许), close(关闭)

11

copy_status

可选

Body(json)

json

-

转载状态 open(允许), close(关闭)

12

istop

可选

Body(json)

json

-

置顶 top(置顶), untop(取消置顶)

13

areacode

可选

Body(json)

json

-

地域编码

14

type

可选

Body(json)

json

-

文章类型 post(普通文章), template(模板文章)

15

templateid

可选

Body(json)

json

-

模板编号

16

musicid

可选

Body(json)

json

-

音乐编号

17

cover

可选

Body(json)

json

-

封面地址

18

class_contribute

可选

Body(json)

json

-

投稿班级编号,逗号分隔,例如:1000,1001,1002

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

info

可选

string

-

结果详情

4.1.1

id

可选

string

-

文章id

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/post/add?accessToken=******
请求报文:
{
	"userid":"******",
	"username":"******"
}
应答报文:
{
    "code": "000000",
    "message": "请求成功",
    "runtime": "1.58468",
    "result": {
        "info": {
            "id": 1611675570
        }
    }
}                
						

31、相册-照片详情

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

string

-

照片id

2

userid

必选

Body(json)

string

-

相册照片拥有者id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

id

可选

string

-

相片id

4.2

albumid

可选

string

-

相册id

4.3

albumuserid

可选

string

-

相册所属用户id

4.4

image

可选

string

-

相片地址

4.5

name

可选

string

-

相片名称

4.6

description

可选

string

-

描述

4.7

size

可选

string

-

大小

4.8

userid

可选

string

-

用户id

4.9

username

可选

string

-

用户昵称

4.10

uploadtime

可选

string

-

上传时间

4.11

iscover

可选

string

-

是否是封面

4.12

type

可选

string

-

类型

4.13

right

可选

string

-

4.14

pageviews

可选

string

-

4.15

platformCode

可选

string

-

平台码

4.16

areacode

可选

string

-

区域码

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/photoInfo?accessToken=******&id=******&userid=******

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": {
        "id": 1768866, 
        "albumid": 1068414, 
        "albumuserid": "eab92753997b41d49032fa104b78c6a6", 
        "image": "http://www.t.huijiaoyun.com/uploads/album/wap/2017/04/27/1493259151_42546.jpg", 
        "name": "", 
        "description": "", 
        "size": 9668, 
        "userid": "eab92753997b41d49032fa104b78c6a6", 
        "username": "滕老师", 
        "uploadtime": 1493259151, 
        "iscover": "0", 
        "type": "person", 
        "right": "1", 
        "pageviews": 1, 
        "platformCode": "888888", 
        "areacode": "420106"
    }, 
    "runtime": "0.01751"
}             
						

32、访问量-个人空间访客统计

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户id

返回说明

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

1

code

可选

string

-

返回状态码

2

message

可选

string

-

消息提示

3

data

可选

string

-

返回数据结果

3.1

total

可选

string

-

总访问量

3.2

todayTotal

可选

string

-

今日访问量

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/visitor/getVisitorcount?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "",
    "data": {
        "total": 58,
        "todayTotal": 0
    }
}          
						

33、个人空间-获取学生成绩

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/space/api/score/StudentGetScoreData
请求方式 GET
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

studentid

必选

Body(json)

string

-

学生personid

2

page

可选

Body(json)

int

-

页码

3

pagesize

可选

Body(json)

int

-

每页条数

返回说明

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

1

code

可选

string

-

返回状态码

2

message

可选

string

-

返回消息

3

result

可选

string

-

返回结果

3.1

total

可选

string

-

结果总数

3.2

lists

可选

string

-

成绩列表

示例

							请求报文:
http://www.t.huijiaoyun.com/index.php?r=api/score/StudentGetScoreData&studentid=c4c6224722c64f2e880796f920930e31&page=1&pagesize=10 
应答报文:
{"code":"000000","message":"\u67e5\u8be2\u6210\u529f","result":{"lists":[{"score":{"scoreid":408,"subject":["\u8bed\u6587","\u6570\u5b66","\u82f1\u8bed","\u8bc4\u4ef7","\u7269\u7406","\u5316\u5b66","\u751f\u7269","\u8bc4\u4ef7","\u6392\u540d"],"title":"\u6d4b\u9a8c\u6210\u7ee9-2","publish":1,"teacherid":"ef84cb7cbc56419aad2ba5d14a9a3375","teachername":"\u8303\u8001\u5e08","classid":"3a4b402f10d6432190b8c18b3af90fe7","classname":"\u4e00\u5e74\u7ea7[1]\u73ed","inputtime":1532673471,"publishtime":1532673480,"isconfirm":"-1"},"scorelist":{"\u59d3\u540d":"\u5c0f\u71d5\u5b50","\u5b66\u751fID":"c4c6224722c64f2e880796f920930e31","\u8d26\u53f7":"xiaoyan","\u8bed\u6587":60,"\u6570\u5b66":66,"\u82f1\u8bed":0,"\u8bc4\u4ef7":"\u4e19","\u7269\u7406":"C","\u5316\u5b66":"B","\u751f\u7269":"C","\u6392\u540d":3,"scoreviewid":5001}},{"score":{"scoreid":407,"subject":["\u8bed\u6587","\u6570\u5b66","\u82f1\u8bed","\u8bc4\u4ef7"],"title":"\u6d4b\u9a8c\u6210\u7ee9","publish":1,"teacherid":"ef84cb7cbc56419aad
						

34、获取用户等级和当月登录次数

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

type

可选

Body(json)

string

-

查询类型 ‘level’查询用户等级,’logincount’查询当月登录次数,不传返回所有信息

2

userid

必选

Body(json)

string

-

用户id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

data

可选

string

-

返回结果

3.1

logincount

可选

string

-

用户当月登录次数

3.2

level

可选

string

-

用户等级

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/user/getLevellogins?accessToken=******&userid=******

应答报文:
{
    "code":"000000",
    "data":
    {
        "logincount":0,
        "level":1
    },
    "message":"查询成功",
    "runtime":"0.35755"
}              
						

35、文章-批量查看文章详情

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

ids

必选

Body(json)

string

-

文章编号,多个id以”,”分割

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

id

可选

string

-

文章id

4.2

userid

可选

string

-

用户id

4.3

username

可选

string

-

用户昵称

4.4

organizationid

可选

string

-

机构id

4.5

classid

可选

string

-

班级id

4.6

title

可选

string

-

文章标题

4.7

content

可选

string

-

文章内容

4.8

categoryid

可选

string

-

分类id

4.9

article_category_id

可选

string

-

4.10

publishid

可选

string

-

4.11

parentid

可选

string

-

4.12

paperid

可选

string

-

4.13

copyid

可选

string

-

转载文章id

4.14

type

可选

string

-

类型

4.15

external_type

可选

string

-

外部权限

4.16

tags

可选

string

-

标签

4.17

datetime

可选

int

-

发表时间

4.18

updatetime

可选

int

-

更新时间

4.19

searchtime

可选

string

-

最后查看时间

4.20

status

可选

string

-

状态

4.21

copy_status

可选

string

-

转载权限

4.22

comment_status

可选

string

-

评论权限

4.23

comment_count

可选

string

-

评论数

4.24

view_count

可选

string

-

查看次数

4.25

like_count

可选

string

-

喜欢数

4.26

copy_count

可选

string

-

转载数

4.27

favorite_count

可选

string

-

收藏数

4.28

child_count

可选

string

-

4.29

resource

可选

string

-

4.30

istop

可选

string

-

是否置顶

4.31

isdel

可选

string

-

是否删除

4.32

reply_status

可选

string

-

回复状态

4.33

operate

可选

string

-

4.34

issnspost

可选

string

-

4.35

isPrivate

可选

string

-

4.36

credit

可选

string

-

学分

4.37

experience

可选

string

-

经验

4.38

password

可选

string

-

4.39

publisher

可选

string

-

4.40

original_type

可选

string

-

4.41

original_type_url

可选

string

-

4.42

studyphase

可选

string

-

4.43

majorsubjectid

可选

string

-

4.44

majorsubjectname

可选

string

-

4.45

usertype

可选

string

-

用户类型

4.46

platformCode

可选

string

-

平台码

4.47

shareid

可选

string

-

4.48

commendlevel

可选

string

-

4.49

areacode

可选

string

-

区域码

4.50

hasPicture

可选

string

-

是否有图片

4.51

issharepost

可选

string

-

是否是分享的文章

4.52

objectid

可选

string

-

被分享的文章id

4.53

taskId

可选

string

-

4.54

from_type

可选

string

-

来源类型

4.55

from_move

可选

string

-

4.56

has_add_credit

可选

string

-

是否添加学分

4.57

templateid

可选

string

-

模板id

4.58

musicid

可选

string

-

背景音乐id

4.59

cover

可选

string

-

封面

4.60

source

可选

string

-

资源地址

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/views?accessToken=******&ids=xxx

应答报文:
{"code":"000000","message":"请求成功","runtime":"0.08345","result":[{"_id":{"$id":"5507def54d4a13d8618b4587"},"id":1611612785,"userid":"eab92753997b41d49032fa104b78c6a6","username":"滕老师","organizationid":"cbaa19e76e524c48a0cc10173205137f","classid":null,"title":"初三物理理论知识","content":"

\"image\"初三物理理论知识,概念介绍;
<\/p>","categoryid":2597959,"article_category_id":null,"publishid":0,"parentid":null,"paperid":0,"copyid":null,"type":"post","external_type":"public","tags":"学无止","datetime":1426579188,"updatetime":1486707652,"searchtime":"2018-07-18 10:13:50","status":"publish","copy_status":"close","comment_status":"close","comment_count":0,"view_count":39,"like_count":1,"copy_count":null,"favorite_count":0,"child_count":null,"resource":"","istop":1472026683,"isdel":null,"reply_status":null,"operate":null,"issnspost":null,"isPrivate":null,"credit":0,"experience":0,"password":"","publisher":null,"original_type":null,"original_type_url":null,"studyphase":"0","majorsubjectid":"jcsub30","majorsubjectname":"劳动技术","usertype":"1","platformCode":"888888","shareid":null,"commendlevel":null,"areacode":"420106","hasPicture":null,"issharepost":null,"objectid":null,"taskId":null,"from_type":null,"from_move":null,"has_add_credit":null,"templateid":null,"musicid":null,"cover":null,"source":null}]}                                              
						

36、通讯录-删除指定的推荐好友

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/openapi/friendship/addBlack?accessToken=******&userid=******&addid=******
请求方式 GET
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

userid

必选

Body(json)

string

-

通讯录的用户id

2

addid

必选

Body(json)

string

-

删除的用户id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/friendship/addBlack?accessToken=******&userid=******&addid=******


应答报文:
{"code":"000000","msg":"success!"}          
						

37、获取个人空间留言列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

type

必选

Body(json)

string

-

类型 留言就传message

2

objectid

必选

Body(json)

string

-

被留言者用户id

3

objectpid

可选

Body(json)

string

-

目标父id(留言可以不传)

4

viewerid

可选

Body(json)

string

-

查看者用户id

5

page

可选

Body(json)

string

-

页码

6

pagesize

可选

Body(json)

string

-

获取条数

7

pid

可选

Body(json)

string

-

所回复的留言id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

data

可选

string

-

返回数据

3.1

list

可选

string

-

评论列表

3.2

count

可选

string

-

评论总数

3.3

canComment

可选

string

-

是否可以评论

3.4

pages

可选

string

-

3.4.1

pageVar

可选

string

-

3.4.2

route

可选

string

-

3.4.3

params

可选

string

-

页面参数

3.4.4

validateCurrentPage

可选

string

-

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/messagenew/messagelist?accessToken=******&objectid=******&type=message

应答报文:
{
  "code": "000000",
  "message": "列表查询成功!",
  "data": {
    "list": [
      {
        "id": 983070,
        "userid": "3e0e37aeb85d4404b85b533ca570ee7a",
        "username": "陈教师二",
        "type": "message"
      }
    ],
    "count": 1,
    "canComment": false,
    "pages": {
      "pageVar": "page",
      "route": "",
      "params": null,
      "validateCurrentPage": true
    }
  }
}                     
						

38、动态-删除动态评论

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

json

-

评论id

2

type

可选

Body(json)

json

-

评论对象类型(post表示文章,trend表示动态,默认动态)

3

sessionid

必选

Body(json)

json

-

用户会话id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/trends/delComment?accessToken=******
请求报文:
{
	"id":"******",
	"sessionid":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "删除成功", 
    "runtime": "0.01751"
}                 
						

39、动态-发布动态

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

json

-

产生动态的用户userid

2

type

必选

Body(json)

json

-

动作类型编号,根据业务提前申请

3

objecttype

必选

Body(json)

json

-

对象类型编号,根据业务提前申请

4

content

可选

Body(json)

json

-

动态内容,截取255长度

5

img

可选

Body(json)

json

-

动态图片,单张直接传入,多张数组传入

6

group_code_usertype

可选

Body(json)

json

-

指定省市区域/学校/班级又同时指定用户类型接收

7

objectid

可选

Body(json)

json

-

动态对象id,自己业务id

8

objectpid

可选

Body(json)

json

-

动态对象父id,自己业务父级id

9

trendspriv

可选

Body(json)

json

-

动态权限,默认1;1所有,2好友,3私有,5指定分组的指定成员可见/或指定分组可见/或指定区域分组可见

10

url

可选

Body(json)

json

-

带网址的链接地址

11

group_userid_v2

可选

Body(json)

json

-

指定用户id接收对象

12

title

可选

Body(json)

json

-

动态标题,截取255长度

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/trends/add?accessToken=******
请求报文:
{
	"userid":"******",
	"type":"******",
	"objecttype":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "发布成功", 
    "runtime": "0.01751"
}                 
						

40、动态-发布评论

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

json

-

关联的主对象id(动态id、文章id)

2

pid

可选

Body(json)

json

-

被回复的评论id

3

type

可选

Body(json)

json

-

评论对象类型(post表示文章,trend表示动态,默认动态)

4

sessionid

必选

Body(json)

json

-

用户会话id

5

desc

必选

Body(json)

json

-

评论内容,140字符以内

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://www.t.huijiaoyun.com/index.php?r=api/openTrends/subComment?accessToken=******
请求报文:
{
"id":"******",
"sessionid":"******",
"desc":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "发布成功", 
    "runtime": "0.01751"
}                 
						

41、相册-分类列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户编号

2

sessionid

可选

Body(json)

string

-

用户会话

3

w

可选

Body(json)

int

-

封面照片宽度,默认500

4

h

可选

Body(json)

int

-

封面照片高度,默认500

5

page

可选

Body(json)

int

-

页码

6

pagesize

可选

Body(json)

int

-

返回数量

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

result

可选

string

-

返回结果

4

runtime

可选

string

-

返回速度

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/albumList?accessToken=******&userid=******

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "result": {
        "list": [
            {
                "id": 1068414, 
                "num": 5, 
                "cover_img": "http://www.t.huijiaoyun.com/uploads/500x500//album/wap/2017/03/31/1490944200_89293.jpg", 
                "name": "呀呀呀呀呀", 
                "createtime": 1490944117, 
                "updatetime": 1493259151, 
                "createuserid": "eab92753997b41d49032fa104b78c6a6", 
                "right": "1", 
                "identifier": "eab92753997b41d49032fa104b78c6a6", 
                "type": "person", 
                "is_look": 1
            }, 
            {
                "id": 1068206, 
                "num": 27, 
                "cover_img": "http://www.t.huijiaoyun.com/uploads/500x500/album/2016/0815/250/57b166c211c0d.jpg", 
                "name": "123345", 
                "createtime": 1469428305, 
                "updatetime": 1480476058, 
                "createuserid": "eab92753997b41d49032fa104b78c6a6", 
                "right": "1", 
                "identifier": "eab92753997b41d49032fa104b78c6a6", 
                "type": "person", 
                "is_look": 1
            }
        ], 
        "page": 1, 
        "pagesize": 2, 
        "w": 500, 
        "h": 500, 
        "count": 11, 
        "max_page": 6, 
        "is_admin": false
    }, 
    "runtime": "0.03398"
}               
						

42、动态-删除

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

sessionid

必选

Body(json)

json

-

用户会话id

2

id

必选

Body(json)

json

-

动态id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							示例:
http://opengate.t.huijiaoyun.com/openapi/trends/del?accessToken=******
请求报文:
{
	"sessionid":"******",
	"id":"******"
}
应答报文:
{
    "code": "000000", 
    "message": "成功", 
    "runtime": "0.01751"
}              
						

43、登录后工作空间头尾接口

慧教云4.0用户登录后的工作空间[center/person/index]头部和底部接口

前置条件

1、获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

params

必选

Body(json)

JSON

-

请求参数,JSON对象

1.1

type

必选

Body(json)

String

64

参数可选值 centerHeader 工作空间头部 centerFooter 工作空间底部

1.2

usessionId

必选

Body(json)

String

64

当前登录用户的usessionid,当获取工作空间头部centerHeader时为必填项,不传返回错误提示信息

返回说明

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

1

retCode

必选

String

100

返回码:000000成功

2

retDesc

必选

String

64

接口返回码信息描述.

3

data

必选

JSON

-

接口返回结果集

3.1

commonContent

必选

String

64

sCommonContent 公共html代码内容,位于result数组之内的

示例

							请求报文:
{
    "params": {
        "type": "centerHeader",
        "usessionId": "ffaf22f0-006c-426e-817d-7b34ba601370"
    }
}
返回报文:
{
    "retCode": "000000",
    "retDesc": "请求成功!",
    "data": {
        "commonContent": "HTML页面"
    }
}
						

44、相册-用户最新照片列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

相册拥有者的用户id

2

spacetype

可选

Body(json)

string

-

查看类型(self自己查看,friend好友查看,space访客查看)

3

pagesize

可选

Body(json)

string

-

查看的数量,默认2条

4

w

可选

Body(json)

int

-

是否缩放宽度,需要和h同时使用

5

h

可选

Body(json)

int

-

是否缩放高度,需要和w同时使用

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

list

可选

string

-

照片列表

4.1.1

id

可选

string

-

照片id

4.1.2

albumid

可选

string

-

相册id

4.1.3

albumuserid

可选

string

-

相册所属用户id

4.1.4

image

可选

string

-

照片存放地址

4.1.5

name

可选

string

-

照片名称

4.1.6

description

可选

string

-

照片描述

4.1.7

size

可选

string

-

照片大小

4.1.8

userid

可选

string

-

用户id

4.1.9

username

可选

string

-

用户名

4.1.10

uploadtime

可选

string

-

上传时间

4.1.11

iscover

可选

string

-

是否是封面

4.1.12

type

可选

string

-

类型

4.1.13

right

可选

string

-

4.1.14

pageviews

可选

string

-

4.1.15

platformCode

可选

string

-

平台码

4.1.16

areacode

可选

string

-

区域码

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/photoNewList?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "success",
    "result": {
        "list": [
            {
                "id": 1804298,
                "albumid": 1069473,
                "albumuserid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "image": "http://whty-source.oss-cn-beijing.aliyuncs.com/mnt/data2/2018/7/23/11/14/d7780bb644aa4c8a9b8f003ee0ca9aa5/5e0718e367424e37a21f181c2ede68d6/35c2dab00fb247e082a0dcc4256c4a29.jpg?x-oss-process=style/whty",
                "name": "1",
                "description": "",
                "size": 7881,
                "userid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "username": "王霞",
                "uploadtime": 1532315531,
                "iscover": "1",
                "type": "person",
                "right": "1",
                "pageviews": 3,
                "platformCode": "888888",
                "areacode": "421181"
            }
        ]
    },
    "runtime": "0.09357"
}            
						

45、删除个人空间留言

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

int

-

要删除的留言id

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/messagenew/delMessage?accessToken=******&id=******

应答报文:
{
    "code": "000000",
    "message": "成功"
}            
						

46、文章-图文上传

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户编号

2

name

必选

Body(json)

string

-

文件名称

3

size

必选

Body(json)

int

-

文件大小

4

type

必选

Body(json)

string

-

文件类型

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

info

可选

string

-

结果详情

4.1.1

fileSrc

可选

string

-

图片保存路径

4.1.2

fileName

可选

string

-

图片保存后的名称

4.1.3

filePath

可选

string

-

图片保存根目录

4.1.4

fileType

可选

string

-

图片文件类型

4.1.5

fileSize

可选

string

-

大小

4.1.6

oriName

可选

string

-

图片原始名称

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/upload?accessToken=******&userid=d7780bb644aa4c8a9b8f003ee0ca9aa5&name=1.jpg&size=19906&type=image/jpeg

应答报文:
{
    "code": "000000",
    "message": "请求成功",
    "result": {
        "info": {
            "fileSrc": "/uploads/post/wap/2018/07/18/1531897819_88432.jpg",
            "fileName": "1531897819_88432.jpg",
            "filePath": "post/wap/2018/07/18",
            "fileType": "image/jpeg",
            "fileSize": 19906,
            "oriName": "1.jpg"
        }
    },
    "runtime": "0.28960"
}              
						

47、动态-获取评论

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

id

必选

Body(json)

int

-

动态id,文章id

2

page

可选

Body(json)

int

-

当前页数,默认1

3

type

可选

Body(json)

string

-

评论对象类型(post表示文章,trend表示动态,默认动态)

4

order

可选

Body(json)

int

-

查询排序方式,1倒序,2正序,默认1

4.1

praise

可选

Body(json)

string

-

点赞信息

4.1.1

count

可选

Body(json)

string

-

点赞数

4.1.2

list

可选

Body(json)

string

-

点赞列表

4.2

comment

可选

Body(json)

string

-

评论信息

4.2.1

count

可选

Body(json)

string

-

评论数

4.2.2

list

可选

Body(json)

string

-

评论列表

5

userid

可选

Body(json)

string

-

当前查询者用户id

6

pagesize

可选

Body(json)

int

-

查询数量,默认10

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/trends/getComment?accessToken=******&id=******

应答报文:
{
    "code": "000000",
    "result": {
        "praise": {
            "count": 0,
            "list": []
        },
        "comment": {
            "count": 0,
            "count_lv_1": 1,
            "list": []
        }
    },
    "runtime": "0.13955"
}          
						

48、文章-我的文章

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

type

可选

Body(json)

string

-

类型 template(美文)

2

userid

必选

Body(json)

string

-

用户编号

3

categoryid

可选

Body(json)

int

-

文章分类

4

page

可选

Body(json)

int

-

页码

5

pagesize

可选

Body(json)

int

-

返回数量

6

keyword

可选

Body(json)

string

-

标题关键词

7

from_type

可选

Body(json)

string

-

来源 wap (移动端)

8

original

可选

Body(json)

int

-

原创 1(原创)

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

categorytitle

可选

string

-

分类标题

4.2

total

可选

string

-

文章总数

4.3

list

可选

string

-

文章列表

4.3.1

id

可选

string

-

文章id

4.3.2

userid

可选

string

-

用户id

4.3.3

username

可选

string

-

用户昵称

4.3.4

organizationid

可选

string

-

机构id

4.3.5

classid

可选

string

-

班级id

4.3.6

title

可选

string

-

文章标题

4.3.7

content

可选

string

-

文章内容

4.3.8

categoryid

可选

string

-

文章分类id

4.3.9

article_category_id

可选

string

-

4.3.10

publishid

可选

string

-

4.3.11

parentid

可选

string

-

4.3.12

paperid

可选

string

-

4.3.13

copyid

可选

string

-

4.3.14

type

可选

string

-

类型

4.3.15

external_type

可选

string

-

外部类型

4.3.16

tags

可选

string

-

标签

4.3.17

datetime

可选

string

-

添加时间

4.3.18

updatetime

可选

string

-

更新时间

4.3.19

searchtime

可选

string

-

最后查看时间

4.3.20

status

可选

string

-

阅读状态

4.3.21

copy_status

可选

string

-

转载状态

4.3.22

comment_status

可选

string

-

评论状态

4.3.23

comment_count

可选

string

-

评论总数

4.3.24

view_count

可选

string

-

阅读数

4.3.25

like_count

可选

string

-

喜欢数

4.3.26

copy_count

可选

string

-

转载数

4.3.27

favorite_count

可选

string

-

收藏数

4.3.28

child_count

可选

string

-

4.3.29

resource

可选

string

-

4.3.30

istop

可选

string

-

是否置顶

4.3.31

isdel

可选

string

-

是否删除

4.3.32

reply_status

可选

string

-

回复状态

4.3.33

operate

可选

string

-

4.3.34

issnspost

可选

string

-

4.3.35

isPrivate

可选

string

-

是否私密文章

4.3.36

credit

可选

string

-

学分

4.3.37

experience

可选

string

-

经验

4.3.38

password

可选

string

-

4.3.39

publisher

可选

string

-

4.3.40

original_type

可选

string

-

原始类型

4.3.41

original_type_url

可选

string

-

原始类型地址

4.3.41

studyphase

可选

string

-

4.3.42

majorsubjectid

可选

string

-

4.3.43

majorsubjectname

可选

string

-

4.3.44

usertype

可选

string

-

用户类型

4.3.45

platformCode

可选

string

-

平台码

4.3.46

shareid

可选

string

-

4.3.47

commendlevel

可选

string

-

4.3.48

areacode

可选

string

-

区域码

4.3.49

hasPicture

可选

string

-

是否有图片

4.3.50

issharepost

可选

string

-

是否分享文章

4.3.51

objectid

可选

string

-

4.3.52

taskId

可选

string

-

4.3.53

from_type

可选

string

-

来源类型

4.3.54

from_move

可选

string

-

4.3.55

has_add_credit

可选

string

-

是否增加学分

4.3.56

templateid

可选

string

-

模板id

4.3.57

musicid

可选

string

-

背景音乐id

4.3.58

cover

可选

string

-

封面

4.3.59

source

可选

string

-

资源地址

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/mine?accessToken=******&userid=******

应答报文:
{"code":"000000","message":"请求成功","runtime":"0.35313","result":{"categorytitle":"全部文章","total":169,"list":[{"id":1611612785,"userid":"eab92753997b41d49032fa104b78c6a6","username":"滕老师","organizationid":"cbaa19e76e524c48a0cc10173205137f","classid":null,"title":"初三物理理论知识","content":"

\"image\"初三物理理论知识,概念介绍;
<\/p>","categoryid":2597959,"article_category_id":null,"publishid":0,"parentid":null,"paperid":0,"copyid":null,"type":"post","external_type":"public","tags":"学无止","datetime":1426579188,"updatetime":1486707652,"searchtime":"2017-12-11 16:21:44","status":"publish","copy_status":"close","comment_status":"close","comment_count":0,"view_count":39,"like_count":1,"copy_count":null,"favorite_count":0,"child_count":null,"resource":"","istop":1472026683,"isdel":null,"reply_status":null,"operate":null,"issnspost":null,"isPrivate":null,"credit":0,"experience":0,"password":"","publisher":null,"original_type":null,"original_type_url":null,"studyphase":"0","majorsubjectid":"jcsub30","majorsubjectname":"劳动技术","usertype":"1","platformCode":"888888","shareid":null,"commendlevel":null,"areacode":"420106","hasPicture":null,"issharepost":null,"objectid":null,"taskId":null,"from_type":null,"from_move":null,"has_add_credit":null,"templateid":null,"musicid":null,"cover":null,"source":null},{"id":1611612962,"userid":"eab92753997b41d49032fa104b78c6a6","username":"滕老师","organizationid":"cbaa19e76e524c48a0cc10173205137f","classid":null,"title":"163618_学无止境.doc","content":"

学无止境<\/p>","categoryid":2597959,"article_category_id":null,"publishid":0,"parentid":null,"paperid":0,"copyid":null,"type":"post","external_type":"public","tags":"学无","datetime":1426583068,"updatetime":1472023367,"searchtime":"2017-02-16 17:36:38","status":"publish","copy_status":"close","comment_status":"close","comment_count":0,"view_count":40,"like_count":1,"copy_count":null,"favorite_count":1,"child_count":null,"resource":
						

49、个人空间-学生获取教师寄语

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/space/api/teachercomment/GetListByUserid
请求方式 GET
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

返回说明

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

示例

							请求报文:
http://www.t.huijiaoyun.com/index.php?r=api/teachercomment/GetListByUserid&userid=581098772b9f485f980e4d0903f833b6&page=1&pagesize=10
应答报文:
{"code":"000000","message":"\u67e5\u8be2\u6210\u529f","result":{"datalist":[{"ID":3330,"TITLE":"\u52a0\u6cb9","CONTENT":"\u7ee7\u7eed\u52a0\u6cb9","RANK":1,"INPUTTIME":1553133466,"CLASSID":"dc62f9fcb53b4620848590c9055b98b2","CLASSNAME":"\u4e8c\u5e74\u7ea7[2]\u73ed","USERID":"ef84cb7cbc56419aad2ba5d14a9a3375","STUDENTID":"581098772b9f485f980e4d0903f833b6","STUDENTNAME":"\u738b\u654f","TEACHERNAME":"\u8303\u8001\u5e08","TYPE":0,"ISREAD":0,"PARENTID":3330,"SUBJECT":"","GRADE":0,"TERM":0},{"ID":2408,"TITLE":"\u54c1\u5b66\u517c\u4f18","CONTENT":"\u4e0a\u8bfe\u79ef\u6781","RANK":1,"INPUTTIME":1548138797,"CLASSID":"dc62f9fcb53b4620848590c9055b98b2","CLASSNAME":"\u4e8c\u5e74\u7ea7[2]\u73ed","USERID":"9709d2d5cd0d439b9530d798269fec5f","STUDENTID":"581098772b9f485f980e4d0903f833b6","STUDENTNAME":"\u738b\u654f","TEACHERNAME":"\u9648\u8001\u5e08","TYPE":0,"ISREAD":0,"PARENTID":0,"SUBJECT":null,"GRADE":0,"TERM":0},{"ID":2405,"TITLE":"\u54c1\u5b66\u517c\u4f18\uff0c\u4e50\u4e8e\u52a9\u4eba","CONTENT"
						

50、文章-文章分类

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

用户编号

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

4

result

可选

string

-

返回结果

4.1

list

可选

string

-

分类列表

4.1.1

id

可选

string

-

分类id

4.1.2

userid

可选

string

-

所属用户id

4.1.3

parentid

可选

string

-

父类id

4.1.4

title

可选

string

-

分类名称

4.1.5

issystem

可选

string

-

是否是系统分类

4.1.6

order

可选

string

-

排序

4.1.7

type

可选

string

-

类型

4.1.8

postcount

可选

string

-

分类总数

4.1.9

postcount_public

可选

string

-

公开的类别总数

4.1.10

fold_status

可选

string

-

状态

4.1.11

platformCode

可选

string

-

平台码

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/post/category?accessToken=******&userid=******

应答报文:
{
    "code": "000000",
    "message": "请求成功",
    "runtime": "0.10342",
    "result": {
        "list": [
            {
                "id": 2670085,
                "userid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "parentid": 2670084,
                "title": "分类一",
                "issystem": 1,
                "order": 1,
                "type": "post",
                "postcount": 0,
                "postcount_public": 0,
                "fold_status": null,
                "platformCode": null
            },
            {
                "id": 2670084,
                "userid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "parentid": 0,
                "title": "默认分组",
                "issystem": 1,
                "order": 1,
                "type": "post",
                "postcount": 0,
                "postcount_public": 0,
                "fold_status": null,
                "platformCode": null
            },
            {
                "id": 2670086,
                "userid": "d7780bb644aa4c8a9b8f003ee0ca9aa5",
                "parentid": 2670084,
                "title": "分类二",
                "issystem": 1,
                "order": 2,
                "type": "post",
                "postcount": 1,
                "postcount_public": 1,
                "fold_status": null,
                "platformCode": null
            }
        ]
    }
}                        
						

51、相册-分类更新

前置条件

获取接口访问凭证:accessToken

请求说明

url https://opengate.huijiaoyun.com/openapi/photo/albumUpdate
请求方式 POST
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

id

必选

Body(json)

json

-

相册id

2

title

必选

Body(json)

json

-

相册名称

3

content

可选

Body(json)

json

-

相册描述内容,200字符以内

4

right

必选

Body(json)

json

-

相册权限,1公开,2好友,3私密

5

sessionid

必选

Body(json)

json

-

用户会话

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

runtime

可选

string

-

返回速度

示例

							请求报文:
http://www.t.huijiaoyun.com/index.php?r=api/openPhoto/albumUpdate

应答报文:
{
    "code": "000000", 
    "message": "success", 
    "runtime": "0.03398"
}
						

52、相册-照片上传

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

name

必选

Body(json)

string

-

文件实际名称

2

type

必选

Body(json)

string

-

文件实际类型

3

size

必选

Body(json)

int

-

文件实际大小

返回说明

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

1

code

可选

string

-

返回状态

2

message

可选

string

-

返回消息

3

result

可选

string

-

返回结果

3.1

imgurl

可选

string

-

图片临时预览地址

3.2

imgkey

可选

string

-

图片安全编码,保存上传图片至相册时使用

4

runtime

可选

string

-

返回速度

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/photo/photoUpload?accessToken=******&type=xxxxxxx&size=xxxxxxx&name=xxxxxxx

应答报文:
{
    "code": "000000", 
    "message": "success",
    "result": {
          "imgurl": "www.t.huijiaoyun.com/uploads/temp/2017/04/25/1493098036_83910.jpg",
          "imgkey": "xxxxxxxxxxxx",
      },
    "runtime": "0.01751"
}          
						

53、动态-定制简版列表

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

userid

必选

Body(json)

string

-

被查询的用户id

2

usertype

可选

Body(json)

int

-

被查询的用户类型,0学生,1老师,2家长

3

orgid

可选

Body(json)

string

-

被查询的用户学校id

4

pagesize

可选

Body(json)

int

-

查询的数量,默认10

5

startid

可选

Body(json)

int

-

查询的起始id,默认0,无起始点

6

type

必选

Body(json)

string

-

查询的类型,jxzs_person-个人指定查教学助手动态

返回说明

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

1

code

可选

string

-

返回状态

2

runtime

可选

string

-

返回速度

3

result

可选

string

-

返回结果

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/trends/simpleList?accessToken=******&userid=******&type=jxzs_person

应答报文:
{
    "code": "000000",
    "result": [],
    "runtime": "0.02754"
}          
						

54、通讯录-用户加关注

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

sessionid

必选

Body(json)

string

-

用户sessionid

2

username

可选

Body(json)

string

-

用户名称

3

userid

可选

Body(json)

string

-

用户id

4

attId

必选

Body(json)

string

-

关注对象id

返回说明

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

1

result

可选

string

-

返回状态

2

desc

可选

string

-

描述

3

data

可选

string

-

返回结果

3.1

attstatus

可选

string

-

关注状态

示例

							请求报文:
http://opengate.t.huijiaoyun.com/openapi/friendship/addattention?accessToken=******&sessionid=46fdb368-78fd-421c-abcd-5f97abe98b0b&attId=3e23bfb47dde4d16aebb0df38af15f58

应答报文:
{
    "result": "000000",
    "desc": "Add attention successful!",
    "fanscount": "1",
    "data": {
        "attstatus": 0
    }
}          
						

参数说明

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

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

消息体的关键字对应的值