top
关闭

开发者登录

主要使用场景:

1、微网站平台首页轮播图片

前置条件

获取接口访问凭证:accessToken

请求说明

url http://opengate.nmgjyyun.cn/portal/api/mobilebanner
请求方式 POST
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

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

1

schoolid

必选

Body(json)

string

-

平台编码code

2

title

必选

Body(json)

string

-

banner模块类型名称(值必须为“微网站”,并且后台必须创建此banner模块类型)

3

Token

可选

Body(json)

string

-

作为微网站独有接口的标识

返回说明

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

1

retCode

可选

string

-

返回的编码标识(判断返回正确或错误的标识)

2

result

可选

json

-

返回的是个json数组,是想要的数据信息

2.1

lists

可选

string

-

返回的是个json数组,是想要的数据信息

2.1.1

id

可选

int

-

返回该banner的id

2.1.2

title

可选

string

-

返回该banner的标题

2.1.3

status

可选

string

-

返回该banner图是否显示状态(0隐藏,1显示)

2.1.4

small_ur

可选

string

-

返回banner的小图片地址

2.1.5

url

可选

string

-

返回banner的图片地址

2.1.6

link

可选

string

-

返回banner图的跳转连接

2.1.7

schoolid

可选

string

-

返回平台/学校id

示例

							请求报文:
{
  "sid": "888888",
  "catename": "微网站",
  "token": "weiwz"
}
应答报文:
返回:
{
  "retCode": "000000",
  "result": {
    "lists": [{
      "id": null,
      "title": "\u6d4b\u8bd5",
      "viewcount": null,
      "status": null,
      "small_url": null,
      "url": "school\/album\/2019\/0316\/232\/5c8ca73b61bdc.png",
      "datetime": null,
      "userid": null,
      "username": null,
      "schoolid": null,
      "schoolname": null,
      "listorder": null,
      "link": "http:\/\/www.baidu.com",
      "type": null,
      "module": null,
      "position": null
    }],
    "pages": {
      "pageVar": "page",
      "route": "",
      "params": null,
      "validateCurrentPage": true
    },
    "total": 1
  },
  "message": "\u672a\u77e5\u9519\u8bef",
  "runtime": "1,552,721,783.29505"
}

						

参数说明

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

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

消息体的关键字对应的值