top

关闭

开发者登录

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

模版市场API

主要使用场景：当应用涉及到模版市场相关功能时使用

1、根据机构id获取一级栏目列表

通过学校id获取一级栏目列表接口

前置条件

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

请求说明

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

参数说明

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

1

schoolId

必选

Body(json)

String

32

 机构id（平台编码）

返回说明

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

1

retCode

必选

String

6

 结果 000000:成功

2

retDesc

可选

String

100

 返回码描述

3

count

必选

String

250

 结果总数

4

categoryList

必选

String

250

 栏目列表

4.1

categoryId

必选

String

250

 栏目id

4.2

categoryName

必选

String

250

 栏目名称

4.3

isShow

必选

String

250

 显示状态

4.4

linkUrl

必选

String

250

 链接地址

4.5

categoryType

必选

Int

11

 栏目类型（0系统默认1自定义）

4.6

modeId

必选

Int

11

 栏目模型（1内容模型2.图文型模型）

示例

							请求报文：
{
"schoolId":"cbaa19e76e524c48a0cc10173205137f"
}
返回报文：
{
  "retCode": "000000",
  "conut": 11,
  "categoryList": [
    {
      "categoryId": 13577,
      "categoryName": "222",
      "isShow": 1,
      "categoryType": 1,
      "linkUrl": "http://"
    },
    {
      "categoryId": 13576,
      "categoryName": "111",
      "isShow": 1,
      "categoryType": 1,
      "linkUrl": "http://"
    },
    {
      "categoryId": 11563,
      "categoryName": "招生信息",
      "isShow": 1,
      "categoryType": 1,
      "linkUrl": ""
    },
    ....
  ],
  "retDesc": "调用成功"
}

2、查询学校的班级风采列表接口

根据学校ID来查询学校首页的班级风采年级/班级列表

前置条件

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

请求说明

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

参数说明

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

1

schoolId

必选

Body(json)

String

32

 学校ID

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200014：学校ID不能为空 100000：查询失败

2

retDesc

可选

String

100

 返回描述

3

classsTyleList

必选

JSON

-

 返回列表

3.1

gradeId

可选

String

32

 年级ID

3.2

gradeName

可选

String

64

 年级名称

3.3

classList

可选

JSON

-

 该年级下的班级数组

3.3.1

classAlias

可选

String

64

 班级别用名

3.3.2

classCode

可选

String

16

 班级编号

3.3.3

classId

可选

String

32

 班级ID

3.3.4

className

可选

String

100

 班级名称

3.3.5

eduSysType

可选

String

16

 学制

3.3.6

foundTime

可选

String

16

 入学年份

3.3.7

grade

可选

String

32

 年级ID

3.3.8

gradeClass

可选

String

16

 所属班级、班别、班号： 1班、2班、3班

3.3.9

graduationTime

可选

String

16

 毕业年份

3.3.10

headTeacherId

可选

String

32

 班主任ID

3.3.11

headTeacherName

可选

String

64

 班主任名称

3.3.12

orgaCategory

可选

String

1

 学校类型 0:小学，六三制：1-6，五四制：1-5 1:初中，六三制：1-3，五四制：1-4 2:高中，高中1-3 3:完中，初中一年级到高中三年级 4:机构，电教馆或教育局 5:教学点，小学一年级到六年级 6:九年一贯制，小学一年级到初中三年级 7: 十二年一贯制，小学一年级到高中三年级 9： 其它教育类学校 10: 中职 11: 高职 12：幼儿园

3.3.13

orgaId

可选

String

32

 学校ID

3.3.14

studyPhase

可选

String

32

 学段

示例

							请求报文：
{
"schoolId":"F6C68AAFA3DB437CE040007F01001D3D"
}
返回报文：
{
  "retCode": "000000",
  "classsTyleList": [
    {
      "gradeId": "5",
      "classId": "6772de807766424b8e900c3d4168f3dd",
      "className": "五年级[1]班",
      "imgUrl": "http://www.t.huijiaoyun.com/uploads/avatar/data/2/0/6772de807766424b8e900c3d4168f3dd_90x90.jpg?1474945327",
      "total": 18
    },
    ...
    {
      "gradeId": "5",
      "classId": "974f2cffadb04f4caa0f12d1aa65a4b6",
      "className": "五年级(2)班",
      "imgUrl": "http://css.huijiaoyun.com/tianyu_edu_test/common/images/avatar/class.png?2016",
      "total": 0
    }
  ]
}

3、查询学校的班级动态列表接口

根据班级ID来查询班级动态列表

前置条件

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

请求说明

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

参数说明

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

1

data

必选

Body(json)

JSON

-

 请求参数，JSON对象

1.1

classId

必选

Body(json)

String

32

 班级ID

返回说明

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

1

retCode

可选

String

6

 返回码

2

retDesc

可选

String

100

 返回码描述

3

dynamicList

可选

JSON

-

 学校动态列表集合

3.1

dynamicId

必选

String

32

 动态Id

3.2

authorId

必选

String

32

 用户id

3.3

authorName

必选

String

64

 用户姓名

3.4

authorType

必选

String

6

 用户类型

3.5

dynamicImg

必选

String

100

 动态图片

3.6

dynamicTitle

必选

String

100

 动态标题

3.7

dynamicType

必选

String

6

 动态来源动作类型

3.8

schoolId

必选

String

32

 学校id

3.9

forwardCount

必选

String

6

 转发数

3.10

dynamicUrl

必选

String

100

 不带网址的链接地址

3.11

platFormCode

必选

String

6

 用户所属站点编码

示例

							请求报文：
{
  "data":{
    "classId":"54c8d241643444469e9cb7b209f360d2"
  }
}
返回报文：
{
  "retCode": "000000",
  "retDesc": "success",
  "dynamicList": [
    {
      "dynamicId": 591910,
      "authorId": "f0dc6083fed842c18e4e066fef15b4a8",
      "authorName": "好好",
      "authorType": 0,
      "dynamicImg": "album/2016/1214/208/5850f7155e65b.png",
      "dynamicTitle": "2134",
      "dynamicType": 1101,
      "schoolId": "cbaa19e76e524c48a0cc10173205137f",
      "forwardCount": 0,
      "dynamicUrl": "/index.php?r=space/person/Talbum/PhotoList&sid=f0dc6083fed842c18e4e066fef15b4a8&albumid=1068334",
      "platFormCode": 420100
    }
  ]
}

4、学校应用推送查询接口

根据学校ID来查询学校应用推送

前置条件

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

请求说明

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

参数说明

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

1

orgId

必选

Body(json)

String

32

 学校ID

2

pageNum

可选

Body(json)

String

6

 页码

3

pageRows

可选

Body(json)

String

6

 每页条数

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200014：学校ID不能为空 100000：查询失败

2

retDesc

可选

String

100

 返回描述

3

schoolPushList

必选

JSON

-

 业务数据对象

3.1

data

必选

JSON

-

 返回数据，JSON对象

3.1.1

pushId

可选

String

32

 主键

3.1.2

orgId

可选

String

32

 学校id

3.1.3

appImg

可选

String

100

 应用图片

3.1.4

appName

可选

String

64

 应用名称

3.1.5

goodsId

可选

String

32

 应用编码

3.1.6

type

可选

String

6

 录入方式：1手动，2门户空间获取

3.1.7

hits

可选

String

6

 点击量

3.1.8

publisher

可选

String

64

 发布人

3.1.9

url

可选

String

100

 访问链接

3.1.10

listOrder

可选

String

6

 排序

3.1.11

dateTime

可选

String

18

 推送时间

示例

5、推送接口

推送接口

前置条件

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

 添加时间

示例

6、获取栏目信息

通过学校id和栏目名称获取栏目信息

前置条件

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

请求说明

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

参数说明

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

1

schoolId

必选

Body(json)

String

32

 学校id

2

categoryName

必选

Body(json)

String

64

 栏目名称

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200031：学校ID不能为空

2

retDesc

必选

String

100

 结果信息

3

categoryInfo

必选

JSON对象

-

 栏目信息

3.1

categoryId

必选

String

32

 栏目id

3.2

categoryName

必选

String

64

 栏目名称

3.3

schoolId

必选

String

32

 学校id

3.4

parentId

必选

String

32

 父级栏目id：为0则为一级栏目

3.5

mainOrder

必选

String

6

 首页位置编号

示例

7、获取学校更多应用展现列表

通过学校id获取学校更多应用展现列表接

前置条件

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

请求说明

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

参数说明

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

1

orgId

必选

Body(json)

String

32

 学校id

2

categoryId

可选

Body(json)

String

32

 分类 全部:0 智慧教学:2 智慧学习:3 智慧评价:4智慧研训:5智慧管理:1

3

pageNum

可选

Body(json)

String

6

 页码

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200031：学校ID不能为空

2

retDesc

可选

String

100

 结果信息

3

appList

必选

JSON

-

 App列表信息

3.1

areaLevel

可选

String

1

 区域信息 0区 1国 2省 3市 4区 5校

3.2

appImageUrl

可选

String

100

 App图片链接

3.3

avgScore

可选

String

6

 App评分

3.4

viewCount

可选

String

6

 使用人数

3.5

createTime

可选

String

32

 创建时间

3.6

collCount

可选

String

6

 收藏数量

3.7

appId

可选

String

32

 appid

3.8

appName

可选

String

100

 App名称

3.9

appUrl

可选

String

100

 App详情链接

3.10

categoryId

可选

String

32

 栏目id

4

count

可选

String

6

 该分类下app总数

示例

							请求报文：
{
"orgId":"7b8d7341902943a68aa4a1d6ff723713",
"categoryId":"2"
}
返回报文：
{
  "retCode": "000000",
  "appList": [
    {
      "areaLevel": "0",
      "appImageUrl": "http://res.t.huijiaoyun.cn:30021/data2/sme-new/upload/seft_package/1465970457511.png",
      "avgScore": 5,
      "viewCount": "9",
      "createTime": "2016-06-15 14:00:00",
      "collCount": 0,
      "appId": "AP020000013089",
      "appName": "一师一优课",
      "appUrl": "http://apps.t.huijiaoyun.com/sme-portal/app/appDetailHJY.html?pkid=AP020000013089"
    },
    {
      "areaLevel": "1",
      "appImageUrl": "http://res.t.huijiaoyun.cn:30021/data2/sme-new/upload/seft_package/1466829347534.png",
      "avgScore": 0,
      "viewCount": "5",
      "createTime": "2016-09-28 17:30:42",
      "collCount": 0,
      "appId": "AP020000013207",
      "appName": "微课通",
      "appUrl": "http://apps.t.huijiaoyun.com/sme-portal/app/appDetailHJY.html?pkid=AP020000013207"
    },
    {
      "areaLevel": "0",
      "appImageUrl": "http://res.t.huijiaoyun.cn:30021/data2/sme-new/upload/seft_package/1466059377336.png",
      "avgScore": 4,
      "viewCount": "5",
      "createTime": "2016-06-16 11:17:00",
      "collCount": 0,
      "appId": "AP020000013134",
      "appName": "德育课程",
      "appUrl": "http://apps.t.huijiaoyun.com/sme-portal/app/appDetailHJY.html?pkid=AP020000013134"
    }
  ],
  "count": 3,
  "retDesc": "调用成功"
}

8、查询学校首页的班级风采接口

根据学校ID来查询学校首页的班级风采列表

前置条件

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

请求说明

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

参数说明

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

1

schoolId

必选

Body(json)

Srting

32

 学校ID

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200014：学校ID不能为空 100000：查询失败

2

retDesc

可选

String

100

 结果描述

3

classsTyleList

必选

JSON

-

 班级风采列表

3.1

gradeId

必选

String

32

 年级ID

3.2

classId

必选

String

32

 班级ID

3.3

className

必选

String

64

 班级名称

3.4

imgUrl

必选

String

100

 班级头像

3.5

total

必选

String

6

 访问量

示例

							请求报文：
{
"schoolId":"F6C68AAFA3DB437CE040007F01001D3D"
}
返回报文：
{
  "retCode": "000000",
  "classsTyleList": [
    {
      "gradeId": "5",
      "classId": "6772de807766424b8e900c3d4168f3dd",
      "className": "五年级[1]班",
      "imgUrl": "http://www.t.huijiaoyun.com/uploads/avatar/data/2/0/6772de807766424b8e900c3d4168f3dd_90x90.jpg?1474945327",
      "total": 18
    },
   ...
    {
      "gradeId": "5",
      "classId": "974f2cffadb04f4caa0f12d1aa65a4b6",
      "className": "五年级(2)班",
      "imgUrl": "http://css.huijiaoyun.com/tianyu_edu_test/common/images/avatar/class.png?2016",
      "total": 0
    }
  ]
}

9、查询学校动态接口

根据学校ID来查询学校动态列表

前置条件

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

请求说明

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

参数说明

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

1

data

必选

Body(json)

JSON

-

 请求参数，JSON对象

1.1

orgId

必选

Body(json)

String

32

 学校ID

1.2

pageNum

可选

Body(json)

String

6

 页码

1.3

pageRows

可选

Body(json)

String

6

 每页条数

返回说明

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

1

retCode

可选

String

6

 返回码

2

retDesc

可选

String

100

 返回码描述

3

dynamicList

可选

JSON

-

 学校动态列表集合

3.1

dynamicId

必选

String

32

 动态Id

3.2

authorId

必选

String

32

 用户Id

3.3

authorName

可选

String

64

 用户姓名

3.4

authorType

可选

String

6

 用户类型

3.5

dynamicImg

可选

String

100

 动态图片

3.6

dynamicTitle

可选

String

100

 动态标题

3.7

dynamicType

可选

String

6

 动态来源动作类型

3.8

schoolId

可选

String

32

 学校id

3.9

forwardCount

可选

String

6

 转发数

3.10

dynamicUrl

可选

String

100

 不带网址的链接地址

3.11

platFormCode

可选

String

6

 用户所属站点编码

示例

							请求报文：
{
  "data":{
    "orgId":"cbaa19e76e524c48a0cc10173205137f",
    "pageNum":2,
    "pageRows":10
  }
}
返回报文：
{
  "retCode": "000000",
  "retDesc": "success",
  "dynamicList": [
    {
      "dynamicId": 594360,
      "authorId": "3e23bfb47dde4d16aebb0d******",
      "authorName": "白老师",
      "authorType": 1,
      "dynamicImg": null,
      "dynamicTitle": "《送杜少府之任蜀州》赏析.flv",
      "dynamicType": 1501,
      "schoolId": "cbaa19e76e524c48a0cc10173205137f",
      "forwardCount": 0,
      "dynamicUrl": "/goResDetailInfoDo.do?productCode=PD568438692037787648",
      "platFormCode": 420000
    },
    ...
    {
      "dynamicId": 594352,
      "authorId": "3e23bfb47dde4d16aebb0df******",
      "authorName": "白老师",
      "authorType": 1,
      "dynamicImg": null,
      "dynamicTitle": "骆宾王《咏鹅》赏析.flv",
      "dynamicType": 1501,
      "schoolId": "cbaa19e76e524c48a0cc10173205137f",
      "forwardCount": 0,
      "dynamicUrl": "/goResDetailInfoDo.do?productCode=PD568438719313346560",
      "platFormCode": 420000
    }
  ]
}

10、根据平台编码获取空间动态

根据平台编码获取空间动态

前置条件

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

请求说明

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

参数说明

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

1

platformCode

可选

Body(json)

String

6

 平台编码

2

num

可选

Body(json)

Int

6

 显示数目

返回说明

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

1

data

可选

JSON

-

 返回结果集

1.1

title

可选

String

100

 文章标题

1.2

name

可选

String

100

 用户姓名

1.3

userId

可选

String

32

 用户ID

1.4

url

可选

String

100

 空间链接

1.5

photo

可选

String

100

 用户头像

1.6

userType

可选

String

6

 用户类型

1.7

pubTime

可选

String

18

 发布时间

示例

							请求报文：
{
	"platformCode":530800,
	"num":1
}
返回报文：
{
    "data": [
        {
            "title": "发表了文章 苹果一年前就决定给iPhone X配备...",
            "name": "王老师",
            "userId": "5d0c021d0bed4f55a5a78cb4bf57ee2b",
            "url": "/index.php?r=space/person/index&sid=5d0c021d0bed4f55a5a78cb4bf57ee2b",
            "photo": "http://css.huijiaoyun.com/tianyu_edu_test/common/images/nophoto_mid.gif?2016",
            "userType": 1,
            "pubTime": 1505460231
        }
    ],
    "code": 1
}

11、回复校长信箱接口

回复校长信箱接口

前置条件

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

请求说明

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

参数说明

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

1

orgId

必选

Body(json)

String

32

 学校id

2

title

可选

Body(json)

String

32

 信件标题

3

content

可选

Body(json)

String

100

 信件内容

4

userId

可选

Body(json)

String

32

 用户id

返回说明

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

1

retCode

可选

String

6

 000000：表示成功 200031：学校ID不能为空

2

commentId

可选

String

32

 评论id

3

retDesc

可选

String

100

 返回信息

示例

							请求报文：
{
"orgId":"F6C68AAFA3DB437CE040007F01001D3D",
"userId":"c1a1bea5b90a4f309f96adf11e608cd7",
"title":"test",
"content":"test"
}
返回报文：
{
  "retCode": "000000",
  "commentId": "79",
  "retDesc": "调用成功"
}

12、获取下属栏目资讯列表

通过学校id一级栏目id获取下属栏目资讯列表

前置条件

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

请求说明

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

参数说明

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

1

schoolId

必选

Body(json)

String

32

 学校id

2

categoryId

可选

Body(json)

String

64

 栏目id

返回说明

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

1

retCode

必选

String

6

 000000：表示成功 200031：学校ID不能为空

2

categoryInfo

必选

JSON

-

 栏目信息

2.1

contentList

可选

JSON

-

 资讯列表

2.1.1

contentId

可选

String

32

 资讯id

2.1.2

contentTitle

可选

String

64

 咨询标题

2.1.3

content

可选

String

100

 资讯内容

2.1.4

contentLink

可选

String

100

 资讯链接，此为链接型资讯

2.1.5

categoryId

可选

String

32

 栏目id

2.1.6

modeId

可选

String

32

 模型id（1 文章 2图文）

2.1.7

userName

可选

String

32

 用户名

2.1.8

schoolId

可选

String

32

 学校id

2.1.9

schoolName

可选

String

64

 学校名称

2.1.10

company

可选

String

32

 发布单位

2.1.11

publishDate

可选

String

32

 发布时间

2.1.12

viewCount

可选

String

6

 浏览次数

2.1.13

categoryName

可选

String

64

 栏目名称

2.1.14

isShow

可选

String

1

 显示状态（0隐藏，1显示）

2.1.15

isTop

可选

String

1

 置顶字段（1置顶，0取消置顶,-1置底）

2.1.16

picList

可选

JSON

-

 图片列表

2.1.16.1

picId

可选

String

32

 图片id

2.1.16.2

fid

可选

String

32

 文件id

2.1.16.3

smallUrl

可选

String

64

 缩略图

2.1.16.4

middleUrl

可选

String

64

 中图

2.1.16.5

url

可选

String

64

 链接

2.1.16.6

userId

可选

String

32

 用户id

2.1.16.7

dateTime

可选

String

32

 创建时间

2.1.16.8

type

可选

String

32

 类别id

2.1.16.9

largeUrl

可选

String

64

 大图

2.1.16.10

description

可选

String

64

 描述

2.1.16.11

name

可选

String

32

 名称

2.1.16.12

newPic

可选

JSON

-

 图片资讯列表

2.1.16.13

contentpList

可选

JSON

-

 轮播图片列表

2.1.16.14

retDesc

可选

String

100

 结果信息

示例
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

消息体的关键字对应的值