top
关闭

开发者登录

主要使用场景:

1、

请求说明

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

参数说明

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

1

data

可选

Body(json)

JSON

-

参数json对象

1.1

showVo

可选

Body(json)

JSON

-

班级圈json对象

1.1.1

groupShowType

可选

Body(json)

JSON

-

发布类型 :1.个人 2.班级范围 3.学校范围 json数组 例如 :[

1.1.2

schoolId

可选

Body(json)

String

-

学校id

1.1.3

schoolName

可选

Body(json)

String

-

学校名称

1.1.4

publisherName

可选

Body(json)

JSON

-

发布人 json数组

1.1.5

publisherId

可选

Body(json)

JSON

-

当前发布人id, json数组

1.1.6

publishContent

可选

Body(json)

String

-

发布文字内容

1.1.7

userType

可选

Body(json)

String

-

当前发布人类型(0.学生 1.老师 2.家长)

1.1.9

fileType

可选

Body(json)

String

-

上传文件类型 : 这里固定填1

1.1.10

classVo

可选

Body(json)

JSONArray

-

班级集合

1.1.10.1

classId

可选

Body(json)

String

-

班级编号

1.1.10.2

className

可选

Body(json)

String

-

班级名称

1.1.11

contentType

可选

Body(json)

String

-

文章类型 这里固定填1

1.1.12

platformCodeUser

可选

Body(json)

String

-

用户平台码

1.1.13

loginPlatformCode

可选

Body(json)

String

-

实体平台码

1.2

imgs

可选

Body(json)

JSON

-

图片地址集合图片先通过<接口:图片上传云存储>上传后获取图片地址

1.2.1

urls

可选

Body(json)

JSON

-

Webp图片地址集合

1.2.2

bigUrls

可选

Body(json)

JSON

-

大图地址集合

1.2.3

smallUrls

可选

Body(json)

JSON

-

小图地址集合

1.2.4

webSmallUrls

可选

Body(json)

JSON

-

Web专用图地址集合

1.2.5

picUrl

可选

Body(json)

JSON

-

原图地址集合

返回说明

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

1

retCode

可选

String

-

结果编码: 000000 成功

2

circleId

可选

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

消息体的关键字对应的值