top
关闭

开发者登录

主要使用场景:

1、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

groupId

必选

Body(json)

String

64

班级ID

返回说明

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

1

result

可选

String

64

000000:成功 100000:失败 000001:无标签

2

resultDesc

可选

String

64

状态描述

3

data

可选

JSON

-

返回数据

3.1

resourceTagsList

可选

JSON[]

-

返回标签集合

示例

							
						

2、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

fileMd5

必选

Body(json)

string

-

文件MD5值

2

userId

必选

Body(json)

string

-

用户ID

3

fileLength

必选

Body(json)

int

-

文件大小:单位字节(byte)

4

filePathLocal

必选

Body(json)

json

-

文件在本地的路径

返回说明

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

1

result

必选

int

-

000000:成功100000:失败

2

resultDesc

必选

int

-

结果描述

3

data

必选

string

-

数据

3.1

fid

必选

string

-

文件ID

3.2

fileLength

必选

string

-

文件大小 单位字节

3.3

fileMd5

必选

string

-

文件MD5值

3.4

fileNameLocal

必选

string

-

文件名

3.5

filePathLocal

必选

string

-

文件本地路径

3.6

filePos

必选

string

-

文件续传位置

3.7

fileSize

必选

string

-

格式化的文件大小

3.8

fileExt

必选

string

-

文件后缀

3.9

postComplete

必选

string

-

是否上传完成"false"=否; "yes”=是

3.10

postedLength

必选

string

-

已上传的文件大小

3.11

postedTime

必选

string

-

上传时间

3.12

userId

必选

string

-

用户ID

示例

							
						

3、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

fileData

必选

Body(json)

string

-

文件流

返回说明

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

1

fid

必选

int

-

文件ID

示例

							
						

4、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

fid

必选

Body(json)

string

-

文件ID

2

userId

必选

Body(json)

string

-

用户ID

3

fileLength

必选

Body(json)

string

-

文件大小:单位字节(byte)

4

fileMd5

必选

Body(json)

string

-

文件MD5值

5

fileNameLocal

必选

Body(json)

string

-

文件名称

6

filePos

必选

Body(json)

string

-

文件位置

7

part

必选

Body(json)

string

-

文件块流

返回说明

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

1

result

必选

string

-

000000:成功

2

resultDesc

必选

string

-

结果描述

3

data

必选

json

-

数据

3.1

fid

必选

int

-

文件ID

3.2

fileLength

必选

int

-

文件大小 单位字节

3.3

fileMd5

必选

string

-

文件MD5值

3.4

fileNameLocal

必选

string

-

文件名

3.5

filePathLocal

必选

string

-

文件本地路径

3.6

filePos

必选

int

-

文件续传位置

3.7

fileSize

必选

string

-

格式化的文件大小

3.8

fileExt

必选

string

-

文件后缀

3.9

postComplete

必选

string

-

是否上传完成"false"=否; "yes”=是

3.10

postedLength

必选

int

-

已上传的文件大小

3.11

postedTime

必选

string

-

上传时间

3.12

userId

必选

string

-

用户ID

示例

							
						

5、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

page

必选

Body(json)

Json对象

-

分页对象

1.1

pageNum

必选

Body(json)

Int

8

当前页

1.2

pageRows

必选

Body(json)

Int

8

每页条数

2

condition

必选

Body(json)

Json对象

-

获取条件

2.1

ownerType

必选

Body(json)

String

1

所有者类型: 3=机构; 4=个人

2.2

persionId

可选

Body(json)

String

64

用户ID: ownerType为4时必传

2.3

orgId

可选

Body(json)

String

64

机构ID: ownerType为3时必传

2.4

productName

可选

Body(json)

String

100

产品名称

2.5

createTimeBegin

可选

Body(json)

String

10

创建开始时间(yyyy-MM-dd)

2.6

createTimeEnd

可选

Body(json)

String

10

创建结束时间(yyyy-MM-dd)

返回说明

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

1

retCode

必选

String

6

返回码

2

retDesc

必选

String

100

返回码描述

3

totalCount

必选

Int

-

总数

4

productList

必选

Json对象

-

产品列表

4.1

productCode

必选

String

-

产品编码

4.2

createTime

必选

String

-

创建时间(yyyy-MM-dd HH:mm:ss)

4.3

downCount

必选

Int

-

下载次数

4.4

viewCount

必选

Int

-

浏览次数

4.5

collectedCount

必选

Int

-

收藏次数

4.6

commentCount

必选

Int

-

评论次数

4.7

productDesc

必选

String

-

产品简介

示例

							
						

6、

请求说明

url
请求方式
格式 json
是否需要鉴权
请求数限制
接口方向

参数说明

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

1

userId

必选

Body(json)

string

-

用户ID

返回说明

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

1

result

必选

string

-

000000:成功100000:失败

2

resultDesc

必选

string

-

结果描述

3

data

必选

json

-

数据

3.1

uncompletedFiles

必选

json

-

文件列表

3.2

fid

必选

string

-

文件id

3.3

fileLength

必选

string

-

文件大小 单位字节

3.4

fileMd5

必选

string

-

文件md5值

3.5

fileNameLocal

必选

string

-

文件名

3.6

filePathLocal

必选

string

-

文件本地路径

3.7

filePos

必选

int

-

文件续传位置

3.8

fileSize

必选

string

-

格式化的文件大小

3.9

fileExt

必选

string

-

文件后缀

3.10

postComplete

必选

string

-

是否上传完成 false yes

3.11

postedLength

必选

int

-

已上传的文件大小

3.12

postedTime

必选

string

-

上传时间

3.13

userId

必选

string

-

用户id

示例

							
						

参数说明

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

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

消息体的关键字对应的值