内容检索

API地址 : /content/search

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID(为空则本站点)
channelIds Array 栏目ID
searchPos String 搜索位置 title 标题、txt 正文、 titleAndTxt 标题或者正文 为空则默认titleAndTxt
keyCondition String 关键词条件 any 包含以下任意一个关键词 all 包含以下全部关键词 notInclude 不包含以下关键词 为空则默认any
keyword String 关键词
typeIds Array 类型Id数组
tagIds Array tagID数组
timeStage String 发布时间阶段 oneDay 一天内、oneWeek 一周内、oneMonth 一月内、oneYear 一年内、timeRage 指定时间范围段、
releaseTimeBegin String 发布时间开始,日期格式(2019-06-05)
releaseTimeEnd String 发布时间结束日期格式日期格式(2019-06-05)
issueOrg Number 发文字号的机关代号的ID
issueYear Number 发文字号的年份的ID
issueNum String 发文字号的顺序号
isTop Boolean 是否置顶 true 则只查询置顶的,为空或者false则忽略条件
releaseApp Boolean 是否支持app通道 (true只查询支持app通道的内容 false或为空则忽略该条件)
releaseMiniprogram Boolean 是否支持小程序通道 (true只查询支持小程序通道的内容 false或为空则忽略该条件)
orderBy Number 排序 28 发布时间升序 27 发布时间降序 默认没有值则相关度排序
page Number 1 第几页
size Number 20 分页大小
source Object 来源
 |-sourceName String 来源名称
 |-sourceLink String 来源链接
 |-isOpenTarget Boolean 是否新窗口打开

响应参数

名称 类型 初始值 说明
content Array
   |— channel Object
      |— id Number 1905
      |— name String 测试栏目
   |— comments Number 0
   |— contentFrontVo Object 图片视频封装vo
      |— imageJson Object 图片字段JSON集合
         |— xinwenliebiaotu Object 单图图片对象实例
            |— dimensions String 1440*900
            |— resourceDate Null null
            |— resourceType Number 1
            |— suffix String .jpg
            |— url String /u/cms/www/201911/23092336vm53.jpg
         |— multiImageUpload_YpzamX Array 多图图片集合对象实例
            |— resourcesSpaceData Object 多图图片中单图对象实例
               |— dimensions String 1440*900
               |— resourceDate Null null
               |— resourceType Number 1
               |— suffix String .jpg
               |— url String /u/cms/www/201911/2309244537v1.jpg
      |— modelId Number 912 内容模型ID
      |— multiImageUploads Array ["multiImageUpload_YpzamX"] 内容多图key字段集合
         |— 0 String multiImageUpload_YpzamX 多图key字段
      |— videoJson Object 视频字段JSON集合
         |— videoUpload_J50J3x Object 视频对象实例
            |— dimensions String 资源尺寸:如图片100X300
            |— resourceDate Number 40 时长,单位:秒(仅限音频及视频)
            |— resourceType Number 2 文件类型(1图片 2视频 3音频 4附件)
            |— suffix String .mp4 后缀名(如.js)
            |— url String /u/cms/www/201911/23092437k3ee.mp4 资源url
   |— description String 这是摘要 内容摘要
   |— downloads Number 0 下载量
   |— downs Number 0 点踩数
   |— id Number 3112 内容ID
   |— releaseTime String 2019-11-23 09:27:14 发布时间
   |— site Object 站点对象
      |— id Number 1 站点ID
      |— name String jeecms演示站 站点名称
   |— source Object 来源对象
      |— isOpenTarget Boolean true 是否新窗口打开
      |— sourceLink String 来源链接
      |— sourceName String 人民网 来源名称
   |— title String 这是一篇新闻 内容标题
   |— ups Number 0 点赞数
   |— url String /cslm/3112 浏览url
   |— urlWhole String http://192.168.0.200/cslm/3112 url绝对路径
   |— views Number 0 浏览量
first Boolean true
last Boolean true
size Number 20
totalElements Number 1
totalPages Number 1

内容检索栏目统计

API地址 : /content/searchSummary

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID(为空则本站点)
channelIds Array 栏目ID
searchPos String 搜索位置 title 标题、txt 正文、 titleAndTxt 标题或者正文 为空则默认titleAndTxt
keyCondition String 关键词条件 any 包含以下任意一个关键词 all 包含以下全部关键词 notInclude 不包含以下关键词 为空则默认any
keyword String 关键词
typeIds Array 类型Id数组
tagIds Array tagID数组
timeStage String 发布时间阶段 oneDay 一天内、oneWeek 一周内、oneMonth 一月内、oneYear 一年内、timeRage 指定时间范围段、
releaseTimeBegin String 发布时间开始,日期格式(2019-06-05)
releaseTimeEnd String 发布时间结束日期格式日期格式(2019-06-05)
issueOrg Number 发文字号的机关代号的ID
issueYear Number 发文字号的年份的ID
issueNum String 发文字号的顺序号
isTop Boolean 是否置顶 true 则只查询置顶的,为空或者false则忽略条件
releaseApp Boolean 是否支持app通道 (true只查询支持app通道的内容 false或为空则忽略该条件)
releaseMiniprogram Boolean 是否支持小程序通道 (true只查询支持小程序通道的内容 false或为空则忽略该条件)
orderBy Number 排序 28 发布时间升序 27 发布时间降序 默认没有值则相关度排序

响应参数

名称 类型 初始值 说明
result Array
   |— channel Object
      |— id Number 1 栏目ID
      |— name String 新闻 栏目名称
   |— count Number 3 文档数量

通过id获取

API地址 : /content/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 栏目id存在时,上一条,下一条只取本栏目的

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点id
channelId Number 栏目id
next Boolean true 下一条 false 上一条

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— commentControl Number 3 评论设置(1允许游客评论 2登录后评论 3不允许评论)
   |— comments Number 0 评论量
   |— contentAttrs Array
      |— contentAttrRes Array
         |— attrType String 扩展字段类型
         |— sizeUnit String 大小
         |— alias String 资源别名
         |— url String 资源路径
         |— resourceType String 资源对象类型(1图片 2视频 3音频 4附件)
         |— description String 描述
      |— alias String 资源别名
      |— resourceType String 资源对象类型(1图片 2视频 3音频 4附件)
      |— url String 资源路径
      |— areaName String 县区名称
      |— cityName String 市名称
      |— provinceName String 省名称
      |— attrType String 扩展字段名
      |— attrValue String 扩展字段值
   |— contentExt Object
      |— pdfUrl String 内容PDF地址
      |— author String 作者
      |— description String 摘要
      |— isNewTarget Boolean false 新窗口打开外部链接(false-否 true-是)
      |— keyWord String 关键词
      |— keyword String 关键字
      |— outLink String 外链
   |— contentTxts Array
      |— attrKey String content 字段
      |— attrTxt String

正文

正文
   |— docResource Object null
      |— url String 资源路径
      |— sizeUnit String 大小
      |— alias String 别名
      |— resourceType String 资源对象类型(1图片 2视频 3音频 4附件)
   |— downloads Number 0 下载量
   |— downs Number 0 点踩量
   |— id Number 1472 内容id
   |— reData Object null
      |— url String 资源路径
      |— sizeUnit String 大小
      |— alias String 别名
      |— resourceType Number 资源对象类型(1图片 2视频 3音频 4附件)
   |— releaseTime String 2019-08-07 18:15:58 发布时间
   |— releaseTimeString String 08.07 发布时间
   |— shortTitle String 副标题 副标题
   |— title String 标题 标题
   |— titleColor String #666666 标题颜色
   |— titleIsBold Boolean true true 加粗 false 不加粗
   |— ups Number 0 点赞量
   |— views Number 0 访问量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-22 16:49:10
token String

分页

API地址 : /content/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id
channelIds Array 栏目id数组
tagIds Array tag词id数组
channelPaths Array 栏目地址数组
siteIds Array 站点id数组
typeIds Array 类型id数组
title String 标题
isNew Boolean true 新内容
isTop Boolean true 置顶
timeBegin String 开始时间
timeEnd String 结束时间
excludeId Array tag词存在时排除的内容id数组
orderBy Number 1创建时间降序2创建时间升序3总访问数降序4总访问数升序 5月访问数降序6月访问数升序7周访问数降序8周访问数升序 9日访问数降序10日访问数升序11总评论数降序12总评论数升序 13月评论数降序14月评论数升序15周评论数降序16周评论数升序 17日评论数降序18日评论数升序19总点赞数降序20总点赞数升序 21月点赞数降序22月点赞数升序23周点赞数降序24周点赞数升序 25日点赞数降序26日点赞数升序27发布时间降序28发布时间升序 29置顶降序30id升序31id降序32日下载降序33周下载降序34月下载降序 35总下载降序
page Number 页数
size Number 每页条数
releaseTarget String 1pc 2手机

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— comments Number 0 评论量
      |— contentExt Object
         |— author String 作者
         |— description String 描述
         |— isNewTarget Boolean false 新窗口打开外部链接(false-否 true-是)
         |— keyWord String 关键词
         |— keyword String 关键字
         |— outLink String 外链
      |— downloads Number 0 下载量
      |— downs Number 0 点踩量
      |— id Number 1847 内容id
      |— reData Object null
      |— releaseTime String 2019-08-21 17:06:07 发布时间
      |— releaseTimeString String 昨天 发布时间
      |— shortTitle String 短标题
      |— sortNum Number 10 排序值
      |— sortWeight Number 0 排序权重
      |— title String 你好我的爱人 标题
      |— titleColor String #666666 标题颜色
      |— titleIsBold Boolean true true 加粗 false 不加粗
      |— top Boolean false true 置顶
      |— topStartTime String null 置顶时间
      |— ups Number 0 点赞量
      |— viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
      |— views Number 0 访问量
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-22 17:18:16
token String

相关内容

API地址 : /relation/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id数组
orderBy String
count Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— comments Number 0 评论量
   |— contentExt Object
      |— author String 作者
      |— description String 描述
      |— isNewTarget Boolean false 新窗口打开外部链接(false-否 true-是)
      |— keyWord String 关键词
      |— keyword String 关键字
      |— outLink String 外链
   |— downloads Number 0 下载量
   |— downs Number 0 点踩量
   |— id Number 1847 内容id
   |— reData Object
   |— releaseTime String 2019-08-21 17:06:07 发布时间
   |— releaseTimeString String 昨天 发布时间
   |— shortTitle String 短标题
   |— sortNum Number 10 排序值
   |— sortWeight Number 0 排序权重
   |— title String 你好我的爱人 标题
   |— titleColor String #666666 标题颜色
   |— titleIsBold Boolean true true 加粗 false 不加粗
   |— top Boolean false true 置顶
   |— topStartTime String null 置顶时间
   |— ups Number 0 点赞量
   |— viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
   |— views Number 0 访问量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-22 17:18:16
token String

通过id数组获取内容列表

API地址 : /content/ids

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentIds Array [1,2]
 |-0 Number 1
orderBy Number 1创建时间降序2创建时间升序3总访问数降序4总访问数升序 5月访问数降序6月访问数升序7周访问数降序8周访问数升序 9日访问数降序10日访问数升序11总评论数降序12总评论数升序 13月评论数降序14月评论数升序15周评论数降序16周评论数升序 17日评论数降序18日评论数升序19总点赞数降序20总点赞数升序 21月点赞数降序22月点赞数升序23周点赞数降序24周点赞数升序 25日点赞数降序26日点赞数升序27发布时间降序28发布时间升序 29置顶降序30id升序31id降序32日下载降序33周下载降序34月下载降序 35总下载降序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— comments Number 0 评论量
   |— contentExt Object
      |— author String 作者
      |— description String 描述
      |— isNewTarget Boolean false 新窗口打开外部链接(false-否 true-是)
      |— keyWord String 关键词
      |— keyword String 关键字
      |— outLink String 外链
   |— downloads Number 0 下载量
   |— downs Number 0 点踩量
   |— id Number 1847 内容id
   |— reData Object
   |— releaseTime String 2019-08-21 17:06:07 发布时间
   |— releaseTimeString String 昨天 发布时间
   |— shortTitle String 短标题
   |— sortNum Number 10 排序值
   |— sortWeight Number 0 排序权重
   |— title String 你好我的爱人 标题
   |— titleColor String #666666 标题颜色
   |— titleIsBold Boolean true true 加粗 false 不加粗
   |— top Boolean false true 置顶
   |— topStartTime String null 置顶时间
   |— ups Number 0 点赞量
   |— viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
   |— views Number 0 访问量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-22 17:18:16
token String

获取内容列表

API地址 : /content/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
channelIds Array 栏目id数组
tagIds Array tag词数组
channelPaths Array 栏目地址数组
siteIds Array 站点id数组
typeIds Array 类型id数组
title String 标题
isNew Boolean true 新内容
isTop Boolean true 置顶
timeBegin String 开始时间
timeEnd String 结束时间
excludeId Array 排除的内容id数组
orderBy Number
count Number 数量
releaseTarget Number 1pc 2手机

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— comments Number 0 评论量
   |— contentExt Object
      |— author String 作者
      |— description String 描述
      |— isNewTarget Boolean false 新窗口打开外部链接(false-否 true-是)
      |— keyWord String 关键词
      |— keyword String 关键字
      |— outLink String 外链
   |— downloads Number 0 下载量
   |— downs Number 0 点踩量
   |— id Number 1847 内容id
   |— reData Object
   |— releaseTime String 2019-08-21 17:06:07 发布时间
   |— releaseTimeString String 昨天 发布时间
   |— shortTitle String 短标题
   |— sortNum Number 10 排序值
   |— sortWeight Number 0 排序权重
   |— title String 你好我的爱人 标题
   |— titleColor String #666666 标题颜色
   |— titleIsBold Boolean true true 加粗 false 不加粗
   |— top Boolean false true 置顶
   |— topStartTime String null 置顶时间
   |— ups Number 0 点赞量
   |— viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
   |— views Number 0 访问量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-22 17:18:16
token String

点赞

API地址 : /content/up

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true 成功
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:06:23
token String

取消点赞

API地址 : /content/cancelUp

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true 成功
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:06:23
token String

预览切换设备

API地址 : /preview

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
device String pc PC端 mobile 手机端 tablet平板端

响应参数

名称 类型 初始值 说明
code Number 200
data String true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:06:23
token String

查询内容评论列表

API地址 : /usercomment

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述: "评论人"回复了"评论的对象的用户对象"

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 1 内容id值
sortStatus Number 1 排序方式:1-最热,2-最新
page Number 1 页码
size Number 2 每页显示的条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— count Number 3 该内容的总评论数(审核通过的评论)
   |— page Object 评论分页列表对象
      |— content Array
         |— distanceTime String "19分钟前"
         |— report Boolean false
         |— isLike Boolean true
         |— children Array 评论子集集合
            |— distanceTime String "19分钟前" 显示时间
            |— report Boolean false 是否可以举报,true->可以点赞,false->不可以点赞
            |— isLike Boolean false 是否可以点赞,true->可以点赞,false->不可以点赞
            |— children Array []
            |— commentText String 我在回复1 评论、回复详情
            |— createTime String 2019-09-16 15:50:07 创建时间
            |— id Number 510 评论、回复的ID值
            |— replyParent Boolean true 是否回复父节点
            |— replyUser Object 评论的对象的用户对象
               |— userExt Object 对象扩展对象
                  |— userImgUrl String 对象头像url
               |— username String tanghuiliang 对象头像url
            |— upCount Number 0 该评论的点赞数
            |— user Object 评论的用户对象
               |— userExt Object
                  |— userImgUrl String
               |— username String tanghuiliang
         |— commentText String 我在评论1
         |— createTime String 2019-09-16 15:49:39
         |— id Number 509
         |— replyParent Boolean false
         |— replyUser Null null
         |— upCount Number 0
         |— user Object
            |— userExt Object
               |— userImgUrl String
            |— username String tanghuiliang
      |— first Boolean true
      |— last Boolean true
      |— size Number 3
      |— totalElements Number 1
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-09-16 17:14:01
token String

新增评论

API地址 : /usercomment

请求方式: post

请求参数类型: application/json

是否启用Header信息:否

描述: 1. 父级id指的是当你回复某一条评论的时候的那条评论处于的第一层评论(评论只有两层)的id值。 2. 被评论的id值,指的是你回复的那条评论的id值

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 1285 内容id值
commentText String 你好我这是评论2 评论(或回复的id值)
parentId Number 32 父级id值
userCommentId Number 54 被评论的id值

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-23 09:09:27
token String

点赞

API地址 : /usercomment/up

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
commentId Number 评论id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 成功 false 失败
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:06:23
token String

取消点赞

API地址 : /usercomment/cancel/up

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
commentId Number 评论id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true 成功
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:06:23
token String

举报评论

API地址 : /usercomment/report

请求方式: post

请求参数类型: application/json

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
commentId Number 1 评论ID值

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-23 09:09:27
token String

查询内容评论详情(子集)

API地址 : /usercomment/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->评论ID

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— children Array 该评论的子集
      |— children Array []
      |— commentText String 七般
      |— createTime String 2019-10-15 15:27:00
      |— distanceTime String 1小时前
      |— id Number 185
      |— isLike Boolean true
      |— replyParent Boolean true
      |— replyUser Object
         |— userExt Object
            |— userImgUrl String /u/cms/www/201909/28174247endf.jpg
         |— username String system
      |— report Boolean true
      |— upCount Number 0
      |— user Object
         |— userExt Object
            |— userImgUrl String /u/cms/www/201909/28174247endf.jpg
         |— username String system
   |— commentText String 三般 评论详情
   |— distanceTime String 1小时前 评论创建时间
   |— id Number 184 评论ID
   |— isLike Boolean true 是否可以点赞,true->可以点赞,false->不可以点赞
   |— replyParent Boolean false 是否回复父节点
   |— replyUser Null null 评论的对象的用户对象
   |— report Boolean true 是否可以举报,true->可以点赞,false->不可以点赞
   |— upCount Number 0 点赞数
   |— user Object 评论对象
      |— userExt Object 对象扩展对象
         |— userImgUrl String /u/cms/www/201909/28174247endf.jpg 用户头像URL
      |— username String system 用户名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 17:20:51
token String

最热评论列表(手机端)-列表

API地址 : /usercomment/mobile/hottest

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array
      |— childrenNum Number 0 评论拥有的子评论的数量
      |— commentText String 都在干嘛啊 评论详情
      |— distanceTime String 刚刚 创建时间
      |— id Number 407 评论ID
      |— isLike Boolean true 是否可以点赞,true->可以点赞,false->不可以点赞
      |— report Boolean true 是否可以举报,true->可以点赞,false->不可以点赞
      |— upCount Number 0 该评论的点赞数
      |— user Object 评论的用户对象
         |— userExt Object 用户扩展对象
            |— userImgUrl String /u/cms/www/201909/28174247endf.jpg 用户头像URL
         |— username String system 用户用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-29 15:49:31
token String

列表

API地址 : /channel/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
parentId Number 父栏目id(传0获取顶级栏目,不传获取所有栏目)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— description String 描述
   |— id Number 752
   |— link String 外链
   |— linkTarget Boolean false true 新窗口打开 false直接打开
   |— name String 领导视察 栏目名
   |— path String ldsc10 访问路径
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 10:51:19
token String

根据id集合获取列表

API地址 : /channel/getByIds

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2]
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— description String 描述
   |— id Number 892
   |— link String 外链
   |— linkTarget Boolean false true 新窗口打开
   |— name String 新增栏目测试 栏目名
   |— path String ldscnew111 访问路径
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:08:12
token String

栏目详情

API地址 : /channel/get

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 栏目id
site Number 站点id
path String 栏目路径

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— attrs Array []
      |— res Array
         |— alias String 资源别名
         |— resourceType String 文件类型(1图片 2视频 3音频 4附件)
         |— url String 路径
         |— description String 描述
      |— alias String 资源别名
      |— resourceType String 文件类型(1图片 2视频 3音频 4附件)
      |— url String 路径
      |— areaName String 县区
      |— cityName String
      |— provinceName String
      |— attrType String 数据类型(对应模型字段数据类型)
      |— attrValue String 扩展字段值
   |— childNum Number 7 子栏目数
   |— childPv Number 0
   |— contribute Boolean false 是否允许投稿(false-不允许 true-允许)
   |— description String 描述
   |— id Number 1
   |— isTop Boolean false 是否置顶 true 置顶
   |— link String 外链
   |— linkTarget Boolean false 外链是否新窗口打开 (false-否 true -是)
   |— name String 新闻 栏目名称
   |— pv Number 0 栏目访问量
   |— txts Array []
      |— attrTxt String 正文
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-31 14:24:25
token String

分页

API地址 : /questionnaire/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— answerCount Number 0 参与人数量
      |— coverPicUrl String 图片
      |— deadline String 结束时间
      |— details String 描述 描述
      |— id Number 223
      |— status Number 3 3进行中 4 已结束
      |— title String 测试1804 标题
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 19
   |— totalPages Number 2
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-07 18:03:51
token String

查看问卷结果

API地址 : questionnaire/result

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
questionnaireId Number 问卷id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— number Number 1 参与人
   |— subjects Array
      |— options Array
         |— rate Number 100 占比
         |— name String 选项一 选项名称
      |— index Null null 排序
      |— id Number 450 题目id
      |— title String 单选题 标题
      |— type Number 1 1单选2多选3问答4下拉5级联6附件
   |— title String 这是复制的问卷 问卷标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 17:33:11
token String

问答题详细列表分页

API地址 : /questionnaire/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
questionnaireId String 问卷id
subjectId String 题目id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— answer String 单选题答案 答案
      |— questionnaireId Number 255 问卷id
      |— subjectId Number 450 题目id
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-11 17:49:56
token String

提交问卷

API地址 : /questionnaire

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
attr_{subjectId} String 选择题传选项id
questionnaireId Number 问卷id
other_{optionId} String 选项题其他选项

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-10 15:59:13
token String

信箱列表

API地址 : /letter/getBoxs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
boxTypeId String 类型id
name String 名称

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— adminUsernames String system,test 信箱管理员
   |— boxType Object 信箱类型
      |— id Number 1
      |— name String 投诉
   |— boxTypeId Number 1
   |— createTime String 2020-01-04 17:53:04
   |— createUser String system
   |— id Number 22
   |— name String 副局长信箱1 名称
   |— sortNum Number 10
   |— sortWeight Number 10
   |— updateTime Null null
   |— updateUser String
   |— workflow Object 工作流
      |— id Number 485
      |— name String 工作流审核步骤
   |— workflowId Number 485
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:16:37
token String

信件类型列表

API地址 : /letter/getTypes

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— coverPic Object 类型封面图
      |— id Number 1
      |— url String /u/cms/www/201911/22173609efvz.jpg
   |— coverPicId Number 1
   |— createTime String 2020-01-10 11:00:46
   |— createUser String system
   |— default Boolean false
   |— deviceSubLimit Number 10 设备提交次数限制
   |— deviceSubLimitUnit Number 1 设备提交次数限制单位(1只能2每小时3每天 0不限制)
   |— form Object 使用表单
      |— id Number 12
      |— title String 投诉表单
   |— formId Number 12
   |— id Number 32
   |— ipSubLimit Number 10 ip提交次数限制单位(1只能2每小时3每天0不限制)
   |— ipSubLimitUnit Number 1 ip提交次数限制
   |— name String 投诉2 名称
   |— processType Number 1 提交成功后处理方式(1显示文字信息2显示信件编号及查询码 )
   |— prompt String 提交成功,感谢您的参与! 文字信息/指定页面
   |— recBox Object 接收信箱
      |— boxType Object
         |— id Number 1
         |— name String 投诉
      |— id Number 3
      |— name String 局长信箱1
   |— recBoxId Number 3
   |— scoreSet Number 3 满意度评价设置(1开启且公开评价结果 2开启但不公开评价结果 3不开启)
   |— sortNum Number 10
   |— sortWeight Number 11
   |— submitLimitLogin Boolean true 是否登录后才能投票
   |— updateTime String 2020-02-11 12:05:53
   |— updateUser String system
   |— userSubLimit Null null 用户提交次数限制
   |— userSubLimitUnit Null null 用户提交次数限制单位(1只能2每小时3每天)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:21:20
token String

信件表单查询详情

API地址 : /letter/getForm/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— beginTime Null null
   |— bgConfig String {"bgType":1,"bgColor":"#F0F0F0","bgImageUrl":"/u/cms/www/201911/26102414mnfg.jpg","alignType":"left top","bgImage":20,"isRepeat":1,"opacity":100}
   |— contConfig String {"borderColor":"#e8e8e8","bgColor":"#ffffff","borderRadius":0,"borderWidth":1,"hasBorder":1}
   |— coverPic Null null
   |— coverPicId Null null
   |— createTime String 2020-01-07 08:55:09
   |— createUser String system
   |— description String 投诉表单
   |— deviceSubLimit Null null
   |— deviceSubLimitUnit Null null
   |— endTime Null null
   |— fontConfig String {"descStyle":{"fontAlign":"left","fontSize":14,"fontWigth":400,"fontColor":"#333333"},"optStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#333333"},"titleStyle":{"fontAlign":"center","fontSize":24,"fontWigth":600,"fontColor":"#333333"},"stemStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#333333"}}
   |— formScene Number 1
   |— headConfig String {"bgImageUrl":"/u/cms/www/201911/22173638yekm.jpg","bgImage":4}
   |— id Number 12
   |— ipSubLimit Null null
   |— ipSubLimitUnit Null null
   |— isCaptcha Boolean false
   |— isOnlyWechat Boolean false
   |— items Array
      |— content String {"preview":"DInputPreview","editor":"DInputEditor","groupType":1,"icon":"wenben","index":3,"groupIndex":1,"type":"input","dragable":true,"prop":"input_1578618073334_771855","name":"标题","isCustom":false,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":"","inputLimit":"chinese","name":"title","tip":"请输入内容","isInputLimit":true,"label":"标题","placeholder":"请输入内容","isLengthLimit":true,"isRegister":false}}
      |— createTime String 2020-02-11 10:50:33
      |— createUser String system
      |— dataType String input
      |— defValue String
      |— field String title
      |— formId Number 12
      |— groupType String 1
      |— id Number 192
      |— isCustom Boolean false
      |— isRequired Boolean false
      |— itemLabel String 标题
      |— placeholder String 请输入内容
      |— sortNum Number 3
      |— tipText String 请输入内容
      |— updateTime Null null
      |— updateUser String
   |— processType Null null
   |— prompt String
   |— shareDesc String
   |— shareLogo Null null
   |— shareLogoId Null null
   |— subConfig String {"borderColor":"#ffffff","bgColor":"#1ec6df","borderRadius":4,"borderWidth":1,"btnHeight":36,"hasBorder":1,"text":"提交","btnWidth":100,"fontStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#ffffff"}}
   |— submitLimitLogin Boolean false
   |— title String 投诉表单
   |— updateTime String 2020-01-07 11:26:27
   |— updateUser String system
   |— userSubLimit Null null
   |— userSubLimitUnit Null null
   |— wechatSubLimit Null null
   |— wechatSubLimitUnit Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:24:15
token String

信件分页

API地址 : /letter/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
typeId Number 类型ID
title String title 标题
letterNo String 编号
qPass String qPass 查询密码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— attrMap Object 字段详情JSON
      |— city Null null 发信所在城市
      |— cityCode String
      |— content String 我修222改的内容333d44d222d3dsdafasd 内容
      |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
      |— createTime String 2018-02-11 15:19:45
      |— createUser String system
      |— currNodeId Number 1574
      |— finishMinute Number 154560 办结效率(时间分钟)
      |— finishTime Number 1581408161000 办结时间
      |— firstBox Object 接收信箱
         |— id Number 42
         |— name String 局长投诉信箱
      |— firstBoxId Number 42
      |— flowProcessId String c66d0df7-4ca2-11ea-a4ef-54e1ad2b05bb
      |— flowStartUserId Number 1
      |— id Number 162
      |— ip String 0:0:0:0:0:0:0:1 IP
      |— isOpen Boolean true 是否选登
      |— isRecycle Boolean false 是否删除到回收站
      |— letterNo String 20200211100001 编号
      |— nextBox Object 办理信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— nextBoxId Number 32
      |— openIntention Boolean true
      |— openTime Null null 选登时间
      |— openUser Null null 选登用户
      |— openUserId Null null
      |— province Null null 省份
      |— provinceCode String
      |— qPass String P2pW2xN4
      |— recycleTime Null null
      |— recycleUser Null null
      |— recycleUserId Null null
      |— replyBox Object 回复信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— replyBoxId Number 32
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1581407242000 回复时间
      |— replyUser Object 回复用户
         |— id Number 1
         |— username String system
      |— replyUserId Number 1
      |— score Number 0 评分
      |— scoreSet Number 1
      |— scoreTime Null null 评分时间
      |— sendUser Object
         |— id Number 1
         |— username String system
      |— status Number 2 状态
      |— title String content 标题
      |— type Object 信件类型
         |— id Number 42
         |— name String 咨询
      |— typeId Number 42
      |— updateTime String 2020-02-11 16:02:42
      |— updateUser String system
      |— userDel Boolean false
      |— userId Number 1
      |— viewReplyContent String 您好,已收件qwqwqwfasdffdd 前台用户查看回复内容
      |— workflowId Number 485
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:36:23
token String

信件不带分页

API地址 : /letter/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
typeId Number 类型ID
title String title 标题
letterNo String 编号
qPass String qPass 查询密码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— city Null null 发信所在城市
      |— cityCode String
      |— content String 我修222改的内容333d44d222d3dsdafasd 内容
      |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
      |— createTime String 2018-02-11 15:19:45
      |— createUser String system
      |— currNodeId Number 1574
      |— finishMinute Number 154560 办结效率(时间分钟)
      |— finishTime Number 1581408161000 办结时间
      |— firstBox Object 接收信箱
         |— id Number 42
         |— name String 局长投诉信箱
      |— firstBoxId Number 42
      |— flowProcessId String c66d0df7-4ca2-11ea-a4ef-54e1ad2b05bb
      |— flowStartUserId Number 1
      |— id Number 162
      |— ip String 0:0:0:0:0:0:0:1 IP
      |— isOpen Boolean true 是否选登
      |— isRecycle Boolean false 是否删除到回收站
      |— letterNo String 20200211100001 编号
      |— nextBox Object 办理信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— nextBoxId Number 32
      |— openIntention Boolean true
      |— openTime Null null 选登时间
      |— openUser Null null 选登用户
      |— openUserId Null null
      |— province Null null 省份
      |— provinceCode String
      |— qPass String P2pW2xN4
      |— recycleTime Null null
      |— recycleUser Null null
      |— recycleUserId Null null
      |— replyBox Object 回复信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— replyBoxId Number 32
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1581407242000 回复时间
      |— replyUser Object 回复用户
         |— id Number 1
         |— username String system
      |— replyUserId Number 1
      |— score Number 0 评分
      |— scoreSet Number 1
      |— scoreTime Null null 评分时间
      |— sendUser Object
         |— id Number 1
         |— username String system
      |— status Number 2 状态
      |— title String content 标题
      |— type Object 信件类型
         |— id Number 42
         |— name String 咨询
      |— typeId Number 42
      |— updateTime String 2020-02-11 16:02:42
      |— updateUser String system
      |— userDel Boolean false
      |— userId Number 1
      |— viewReplyContent String 您好,已收件qwqwqwfasdffdd 前台用户查看回复内容
      |— workflowId Number 485
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:36:23
token String

我的信件分页

API地址 : member/letter/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
typeId Number 类型ID
title String title 标题
letterNo String 编号
hasReply String 是否已回复(全部留空)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— city Null null 发信所在城市
      |— cityCode String
      |— content String 我修222改的内容333d44d222d3dsdafasd 内容
      |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
      |— createTime String 2018-02-11 15:19:45
      |— createUser String system
      |— currNodeId Number 1574
      |— finishMinute Number 154560 办结效率(时间分钟)
      |— finishTime Number 1581408161000 办结时间
      |— firstBox Object 接收信箱
         |— id Number 42
         |— name String 局长投诉信箱
      |— firstBoxId Number 42
      |— flowProcessId String c66d0df7-4ca2-11ea-a4ef-54e1ad2b05bb
      |— flowStartUserId Number 1
      |— id Number 162
      |— ip String 0:0:0:0:0:0:0:1 IP
      |— isOpen Boolean true 是否选登
      |— isRecycle Boolean false 是否删除到回收站
      |— letterNo String 20200211100001 编号
      |— nextBox Object 办理信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— nextBoxId Number 32
      |— openIntention Boolean true
      |— openTime Null null 选登时间
      |— openUser Null null 选登用户
      |— openUserId Null null
      |— province Null null 省份
      |— provinceCode String
      |— qPass String P2pW2xN4
      |— recycleTime Null null
      |— recycleUser Null null
      |— recycleUserId Null null
      |— replyBox Object 回复信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— replyBoxId Number 32
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1581407242000 回复时间
      |— replyUser Object 回复用户
         |— id Number 1
         |— username String system
      |— replyUserId Number 1
      |— score Number 0 评分
      |— scoreSet Number 1
      |— scoreTime Null null 评分时间
      |— sendUser Object
         |— id Number 1
         |— username String system
      |— status Number 2 状态
      |— title String content 标题
      |— type Object 信件类型
         |— id Number 42
         |— name String 咨询
      |— typeId Number 42
      |— updateTime String 2020-02-11 16:02:42
      |— updateUser String system
      |— userDel Boolean false
      |— userId Number 1
      |— viewReplyContent String 您好,已收件qwqwqwfasdffdd 前台用户查看回复内容
      |— workflowId Number 485
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:36:23
token String

信件详情

API地址 : /letter/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同信件分页属性
   |— attrMap Object 字段详情JSON
   |— city Null null
   |— cityCode String
   |— content String 我修222改的内容333d44d222d3dsdafasd
   |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
   |— createTime String 2018-02-11 15:19:45
   |— createUser String system
   |— currNodeId Number 1574
   |— finishMinute Number 154560
   |— finishTime Number 1581408161000
   |— firstBox Object
      |— id Number 42
      |— name String 局长投诉信箱
   |— firstBoxId Number 42
   |— flowProcessId String c66d0df7-4ca2-11ea-a4ef-54e1ad2b05bb
   |— flowStartUserId Number 1
   |— id Number 162
   |— ip String 0:0:0:0:0:0:0:1
   |— isOpen Boolean true
   |— isRecycle Boolean false
   |— letterNo String 20200211100001
   |— nextBox Object
      |— id Number 32
      |— name String 副局长信箱12
   |— nextBoxId Number 32
   |— openIntention Boolean true
   |— openTime Null null
   |— openUser Null null
   |— openUserId Null null
   |— province Null null
   |— provinceCode String
   |— qPass String P2pW2xN4
   |— recycleTime Null null
   |— recycleUser Null null
   |— recycleUserId Null null
   |— replyBox Object
      |— id Number 32
      |— name String 副局长信箱12
   |— replyBoxId Number 32
   |— replyContent String 您好,已收件qwqwqwfasdffdd
   |— replyTime Number 1581407242000
   |— replyUser Object
      |— id Number 1
      |— username String system
   |— replyUserId Number 1
   |— score Number 0
   |— scoreSet Number 1
   |— scoreTime Null null
   |— sendUser Object
      |— id Number 1
      |— username String system
   |— status Number 2
   |— title String content
   |— type Object
      |— id Number 42
      |— name String 咨询
   |— typeId Number 42
   |— updateTime String 2020-02-11 16:02:42
   |— updateUser String system
   |— userDel Boolean false
   |— userId Number 1
   |— viewReplyContent String 您好,已收件qwqwqwfasdffdd
   |— workflowId Number 485
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:49:18
token String

信件统计

API地址 : /letter/survey

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— processingCount Number 0 在办理数量
   |— replyCount Number 1 已回复数量
   |— totalCount Number 1 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:51:00
token String

写信

API地址 : /letter

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
letterTypeId Number 信件类型ID
title String 标题
content String 内容
openIntention Boolean 公开意愿
city String 样例: city是城市类型字段名称 ciytC城市编码 cityP省份编码 address 是地址类型字段名称 addressP省份编码 addressC城市编码 addressA 详细地址 其中P、C、A固定 multiImageUploadDesc multiImageUpload是多图字段名,Desc是多图上传字段固定后缀

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— msg Null null
   |— processType Number 1 信件发信成功后处理方式提交成功后处理方式(1显示文字信息2显示信件编号及查询码 )
   |— prompt String 提交成功,感谢您的参与! 文字信息/指定页面
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 17:46:45
token String

评分

API地址 : /member/letter/score

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number
score Number 2-10

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 18:02:11
token String

信件类型单个详情

API地址 : /letter/type/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同信件类型列表
   |— coverPic Object
      |— id Number 1
      |— url String /u/cms/www/201911/22173609efvz.jpg
   |— coverPicId Number 1
   |— createTime String 2020-04-02 09:05:57
   |— createUser String system
   |— default Boolean true
   |— deviceSubLimit Number 10
   |— deviceSubLimitUnit Number 1
   |— form Null null
   |— formId Null null
   |— id Number 1
   |— ipSubLimit Number 10
   |— ipSubLimitUnit Number 1
   |— name String 咨询2
   |— noticeOpen Boolean true
   |— noticeTxt String 必须的
   |— processType Number 1
   |— prompt String 提交成功,感谢您的参与!
   |— recBox Null null
   |— recBoxId Number 42
   |— scoreSet Number 3
   |— sortNum Number 10
   |— sortWeight Number 10
   |— submitLimitLogin Boolean true
   |— updateTime Null null
   |— updateUser String
   |— userSubLimit Null null
   |— userSubLimitUnit Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-02 09:06:15
token String

表单查询详情

API地址 : /smartForm/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— beginTime Null null
   |— bgConfig String {"bgType":1,"bgColor":"#F0F0F0","bgImageUrl":"/u/cms/www/201911/26102414mnfg.jpg","alignType":"left top","bgImage":20,"isRepeat":1,"opacity":100}
   |— contConfig String {"borderColor":"#e8e8e8","bgColor":"#ffffff","borderRadius":0,"borderWidth":1,"hasBorder":1}
   |— coverPic Null null
   |— coverPicId Null null
   |— createTime String 2020-01-07 08:55:09
   |— createUser String system
   |— description String 投诉表单
   |— deviceSubLimit Null null
   |— deviceSubLimitUnit Null null
   |— endTime Null null
   |— fontConfig String {"descStyle":{"fontAlign":"left","fontSize":14,"fontWigth":400,"fontColor":"#333333"},"optStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#333333"},"titleStyle":{"fontAlign":"center","fontSize":24,"fontWigth":600,"fontColor":"#333333"},"stemStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#333333"}}
   |— formScene Number 1
   |— headConfig String {"bgImageUrl":"/u/cms/www/201911/22173638yekm.jpg","bgImage":4}
   |— id Number 12
   |— ipSubLimit Null null
   |— ipSubLimitUnit Null null
   |— isCaptcha Boolean false
   |— isOnlyWechat Boolean false
   |— items Array
      |— content String {"preview":"DInputPreview","editor":"DInputEditor","groupType":1,"icon":"wenben","index":3,"groupIndex":1,"type":"input","dragable":true,"prop":"input_1578618073334_771855","name":"标题","isCustom":false,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":"","inputLimit":"chinese","name":"title","tip":"请输入内容","isInputLimit":true,"label":"标题","placeholder":"请输入内容","isLengthLimit":true,"isRegister":false}}
      |— createTime String 2020-02-11 10:50:33
      |— createUser String system
      |— dataType String input
      |— defValue String
      |— field String title
      |— formId Number 12
      |— groupType String 1
      |— id Number 192
      |— isCustom Boolean false
      |— isRequired Boolean false
      |— itemLabel String 标题
      |— placeholder String 请输入内容
      |— sortNum Number 3
      |— tipText String 请输入内容
      |— updateTime Null null
      |— updateUser String
   |— processType Null null
   |— prompt String
   |— shareDesc String
   |— shareLogo Null null
   |— shareLogoId Null null
   |— subConfig String {"borderColor":"#ffffff","bgColor":"#1ec6df","borderRadius":4,"borderWidth":1,"btnHeight":36,"hasBorder":1,"text":"提交","btnWidth":100,"fontStyle":{"fontSize":14,"fontWigth":400,"fontColor":"#ffffff"}}
   |— submitLimitLogin Boolean false
   |— title String 投诉表单
   |— updateTime String 2020-01-07 11:26:27
   |— updateUser String system
   |— userSubLimit Null null
   |— userSubLimitUnit Null null
   |— wechatSubLimit Null null
   |— wechatSubLimitUnit Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 17:24:15
token String

提交表单

API地址 : /smartForm

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
formId Number 表单ID
title String 标题
content String 内容
city String 样例: city是城市类型字段名称 ciytC城市编码 cityP省份编码 address 是地址类型字段名称 addressP省份编码 addressC城市编码 addressA 详细地址 其中P、C、A固定 multiImageUploadDesc multiImageUpload是多图字段名,Desc是多图上传字段固定后缀

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— msg Null null
   |— processType Number 1 信件发信成功后处理方式提交成功后处理方式(1显示文字信息2显示信件编号及查询码 )
   |— prompt String 提交成功,感谢您的参与! 文字信息/指定页面
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 17:46:45
token String

页面刷新浏览量

API地址 : /smartForm/view/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Number 15 浏览量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 18:00:19
token String

发送邮箱验证码

API地址 : /register/sendEmailMsg

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 发送邮箱验证码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
type Number 2 1.注册2.找回密码3.身份验证4.验证新号码(手机或邮箱)
targetNumber String 714066238@qq.com 邮箱

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

根据用户名或邮箱找回密码

API地址 : /register/rectrieve/key

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 根据用户名或邮箱找回密码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String Hello 用户名或邮箱
validateCode Number 814853 验证码
pStr String Kh2+07MaeeQ= 密码(加密)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

发送短信验证码

API地址 : /register/sendPhoneMsg

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 发送短信验证码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
type Number 2 1.注册2.找回密码3.身份验证4.验证新号码(手机或邮箱)
targetNumber String 18870852070 电话号码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

根据手机号找回密码

API地址 : /register/rectrieve/phone

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 根据手机号找回密码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
phone String 18870852070 手机号
validateCode Number 615386 验证码
pStr String Kh2+07MaeeQ= 密码(加密)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

手机验证验证码

API地址 : /register/mobile/authcode

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 手机验证验证码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mobile String 手机号
code String 验证码
type String 1.注册2.找回密码3.身份验证4.验证新号码(手机或邮箱)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true通过false不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

邮箱验证验证码

API地址 : /register/mail/authcode

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 邮箱验证验证码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
email String 邮箱
code String 验证码
type Number 1.注册2.找回密码3.身份验证4.验证新号码(手机或邮箱)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true通过false不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563352563347
token String

修改密码

API地址 : /member/memberinfo/pstr

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 修改密码(都要加密)旧密码在第三方登录的时候可不填

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
oldPStr String Kh2+07MaeeQ= 旧密码
newPStr String Kh2+07MaeeQ= 新密码
againPStr String Kh2+07MaeeQ= 重新输入密码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563439626595
token String

修改注册邮箱

API地址 : /member/memberinfo/email

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 修改注册邮箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
code String 995653 验证码
newEmail String 3158655288@qq.com 新邮箱
newEmailCode String 417531 新邮箱验证码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563439626595
token String

用户信息

API地址 : /member/memberinfo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 获取个人信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— headImage Number 头像URL
   |— levelIcon String 等级图标URL
   |— admin Boolean true管理员false会员
   |— dataField Object
      |— password String cb931b75c901ee57e3d7560fd552ebe40daba40a
      |— checkStatus Boolean true
      |— userLevel Number 1
      |— integral Number 0
      |— telephone String 18870852078
      |— id Number 352
      |— userGroup Number 62
      |— email String 714066987@qq.com
      |— realname String 卢俊伟
      |— username String Hello
      |— status Number 1
   |— id Number 352
   |— renderingField Object
      |— formListBase Array
         |— preview String DPasswordPreview
         |— editor String DPasswordEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 4
         |— groupIndex Number 4
         |— type String password
         |— disableFields Array ["label","name","isRequired","isRegister"]
            |— 0 String label
         |— hiddenFields Array ["placeholder","defaultValue","isSmsVerification","isSmsFindPassword"]
            |— 0 String placeholder
         |— dragable Boolean true
         |— name String 密码
         |— isCustom Boolean false
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean true
            |— defaultValue String
            |— name String password
            |— isSmsVerification Boolean false
            |— tip String
            |— label String 密码
            |— placeholder String 请输入内容
            |— isSmsFindPassword Boolean false
            |— isRegister Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563435265368
token String

修改个人资料

API地址 : /member/memberinfo

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
telephone String 798795465 手机号
realname String Siri 真实姓名
json Object 自定义字段
 |-fax_Wu1i9z String 这是传真
 |-input_cxQXwC String 个性签名
 |-city_c981df Object
  |-provinceCode Number 1001
  |-cityCode Number 1002
 |-address_UkoQ9D Object
  |-provinceCode Number 1001
  |-cityCode Number 1002
  |-areaCode Number 1003
  |-address String 西湖区观洲阳光小区
 |-imageUpload_lqPB7R Number 98
headImage Number 会员资源ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563438200259
token String

手机端修改个人系统信息

API地址 : /member/memberinfo/system

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 手机端修改个人系统信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
realname String ljw 真实姓名
telephone String 手机号

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 13:41:10
token String

手机端修改个人扩展信息

API地址 : /member/memberinfo/custom

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 手机端修改个人扩展信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
attrName String imageUpload_AYpSyX 扩展字段名
attrValue String 15326 扩展字段值
attrType String imageUpload 数据类型(对应模型字段数据类型)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 13:41:10
token String

微信分享

API地址 : /wechat/sign

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
url String 要分享的地址

响应参数

名称 类型 初始值 说明
appId String 公众号appId
timestamp String 签名时间戳
nonceStr String 签名随机串
signature String 签名

我的互动列表

API地址 : /member/interaction/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 我的互动列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startTime String 评论开始时间
endTime String 评论结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— parentId Number 父结点ID
      |— contentUrl String 内容地址
      |— upCount Number 点赞数
      |— username String 用户名
      |— commentTime String 2019-07-20 14:12 评论时间
      |— contentId Number 1285 内容ID
      |— id Number 53 评论ID
      |— text String 你好我这是评论4 评论内容
      |— title String 正式测试新增 标题
      |— type Number 1 互动类型 1.我的评论,2.我的回复,3.回复我的
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563607085157
token String

删除互动

API地址 : /member/interaction/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 删除互动

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563607062201
token String

手机端我的互动列表

API地址 : /member/interaction/mobilePage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 手机端我的互动列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— like String 是否点赞
      |— replyUsername String 回复人名称
      |— headImage String 头像
      |— commentTime String 2019-09-30 11:14 评论时间
      |— id Number 72 评论ID
      |— mobileContent Object 手机端内容
         |— channelName String 国内 栏目名称
         |— comments Number 44 评论数
         |— createTime String 2019-09-05 10:28 创建时间
         |— id Number 2574 内容ID
         |— imageJson Object 图片JSON
            |— resource Object 资源
               |— dimensions String 370*204 尺寸
               |— resourceDate Null null 时长,单位:秒(仅限音频及视频)
               |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
               |— suffix String .png 后缀名(如.js)
               |— url String /u/cms/www/201909/06142219ojl9.png URL
            |— multiImageUpload_xANIbN Array [] "多图上传"字段,string集合
         |— multiImageUploads Array ["multiImageUpload_xANIbN"] "多图上传"字段,string集合
            |— 0 String multiImageUpload_xANIbN
         |— title String “斗争”!习近平这篇讲话大有深意 内容标题
         |— ups Number 0 点赞数
         |— url String http://192.168.0.200:8700/gn/2574 内容URL
         |— videoJson Object 视频JSON
         |— views Number 218 浏览量
      |— parentId Null null 父结点Id
      |— text String 测试 评论内容
      |— type Number 1 互动类型 1.我的评论,2.我的回复,3.回复我的
      |— upCount Number 0 我的点赞数
      |— username String test 互动用户名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 13
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 17:30:41
token String

一键清空我的互动

API地址 : /member/interaction/clear

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 一键清空我的互动

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563607062201
token String

批量删除互动

API地址 : /member/interaction

请求方式: delete

请求参数类型: application/json

是否启用Header信息:是

描述: 批量删除互动

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1]
 |-0 Number 1 互动ID数组

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563607062201
token String

我的点赞列表分页

API地址 : /member/memberinfo/like

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 我的点赞列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 页数
size String 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— contentUrl String 内容地址
      |— comment String 测试评论2 评论内容
      |— commentId Number 42 评论ID
      |— contentId Null null 内容ID
      |— title String 正式测试新增 标题
      |— type Number 1 1.点赞评论 2.点赞内容
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 5
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:17
token String

取消点赞

API地址 : /member/memberinfo/quitlike

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 取消点赞

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 评论ID或内容ID
type Number 1.点赞评论 2.点赞内容

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

手机端我的点赞列表分页

API地址 : /member/memberinfo/moblielike

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 手机端我的点赞列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentSum String 评论数
      |— ups String 点赞数
      |— time String 评论时间
      |— replyUsername String 回复人名称
      |— headImage String 头像
      |— username String 评论人名称
      |— commentType Number 评论类型1.我的评论2.回复我的
      |— comment String 121 评论内容
      |— commentId Number 12 评论ID
      |— mobileContent Object 手机内容实体
         |— modelId Number 1 内容模型ID
         |— channelName String 要闻 栏目名称
         |— comments Number 4 评论量
         |— createTime String 2019-09-04 10:46 创建时间
         |— id Number 2353 内容ID
         |— imageJson Object 图片json
            |— resource Object 资源对象
               |— dimensions String 1200*600 资源尺寸:如图片100X300
               |— resourceDate Null null 时长,单位:秒(仅限音频及视频)
               |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
               |— suffix String .png 后缀名(如.js)
               |— url String /u/cms/www/201909/09110420wn54.png URL
         |— multiImageUploads Array ["multiImageUpload_xANIbN"] "多图上传"字段,string集合
            |— 0 String multiImageUpload_xANIbN
         |— title String 梦想从学习开始——共筑中国梦 内容标题
         |— ups Number 2 点赞数
         |— url String http://192.168.0.200:8700/yw/2353 内容URL
         |— videoJson Object 视频JSON
         |— views Number 80 浏览量
      |— type Number 1 1.点赞评论 2.点赞内容
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 17:30:49
token String

是否允许投稿

API地址 : /member/memberinfo/isContribute

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true->允许投稿,false->不允许投稿
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 22:36:27
token String

可以投稿的栏目树形

API地址 : /channel/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— operatingContribute Boolean true true->可以投稿,false->不允许投稿
   |— name String 新闻 栏目名称
   |— id Number 1 栏目id
   |— parentId Null null 栏目父类id
   |— children Array 栏目子集
      |— operatingContribute Boolean true true->可以投稿,false->不允许投稿
      |— name String 国内新闻
      |— id Number 2
      |— parentId Number 1 栏目父类id
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 23:09:03
token String

新建一个投稿

API地址 : /member/memberinfo/contribute

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
channnelId Number 1 栏目id
title String 这是投稿的栏目 标题
description String 这是投稿内容的描述 描述
author String 这是投稿作者 作者
contxt String 这是投稿的内容 内容
isSubmit Boolean false 是否提交()

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 23:21:37
token String

修改投稿内容

API地址 : /member/memberinfo/contribute

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
channnelId Number 1 栏目id
title String 这是投稿的栏目1 内容标题
description String 这是投稿内容的描述1 内容描述
author String 这是投稿作者1 内容作者
contxt String 这是投稿的内容1 内容正文
contentId Number 743 内容id
isSubmit Boolean true 是否提交(true->提交,false->暂存)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-31 14:17:25
token String

删除单个投稿

API地址 : /member/memberinfo/contribute

请求方式: delete

请求参数类型: application/json

是否启用Header信息:是

描述: 只有状态为暂存时,才可以进行删除

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 743 内容id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-31 14:31:23
token String

投稿内容分页列表(手机端)

API地址 : /member/memberinfo/mobile/contribute/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Number 1 状态:1.待审核、2.已发布
page Number 1 页数
size Number 1 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— modelId Number 1 内容模型ID
      |— channelName String 栏目1 栏目名称
      |— comments Number 0 评论数量
      |— createTime String 1分钟前 创建时间
      |— id Number 4009 内容ID
      |— imageJson Object 图片JSON
         |— multiImageUpload_tgI6wp Array 多图上传资源list集合
            |— resourcesSpaceData Object 资源对象
               |— dimensions String 1440*900
               |— resourceDate Null null
               |— resourceType Number 1
               |— suffix String .jpg
               |— url String /u/cms/www/201910/15143818k20v.jpg
         |— imageUpload_baiLUz Object 单图上传资源对象
            |— dimensions String 1440*900
            |— resourceDate Null null
            |— resourceType Number 1
            |— suffix String .jpg
            |— url String /u/cms/www/201910/15143845gdqt.jpg
         |— resource Object 单图上传默认字段
            |— dimensions String 1440*900
            |— resourceDate Null null
            |— resourceType Number 1
            |— suffix String .jpg
            |— url String /u/cms/www/201910/1514374514tv.jpg
      |— multiImageUploads Array ["multiImageUpload_tgI6wp","multiImageUpload_WmOIQa"] "多图上传"字段名称集合
         |— 0 String multiImageUpload_tgI6wp
      |— title String 测试投稿回填 内容标题详情
      |— titleColor String #666666 内容标题颜色
      |— titleIsBold Boolean true 内容标题是否加粗
      |— ups Number 0 点赞数
      |— url String http://192.168.0.200:8700/lm1/4009 浏览URL
      |— videoJson Object 视频JSON
         |— videoUpload_ikjigT Object 视频字段名称
            |— dimensions String 资源尺寸:如图片100X300
            |— resourceDate Number 40 时长,单位:秒(仅限音频及视频)
            |— resourceType Number 2 文件类型(1图片 2视频 3音频 4附件)
            |— suffix String .mp4 后缀名(如.js)
            |— url String /u/cms/www/201910/15143801mioa.mp4 资源路径
      |— views Number 0 浏览量
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 17
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-15 14:40:05
token String

收藏分页

API地址 : /member/usercollections/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
title String 标题
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— contentMobileVo Object 内容图片、多图、视频资源json
         |— imageJson Object 图片json实例
            |— xinwenliebiaotu Null null
            |— biaotitu Null null
            |— shoujibannertu Null null
            |— resource Object 单个图片对象
               |— dimensions String 370*240 资源尺寸:如图片100X300
               |— resourceDate Null null 时长,单位:秒(仅限音频及视频)
               |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
               |— suffix String .png 后缀名(如.js)
               |— url String /u/cms/www/201909/10110857atq7.png 资源路径
            |— shoujiliebiaotu Null null
            |— xinwenfenxiangtu Null null
            |— neirongtu Null null
            |— multiImageUpload_YpzamX Array 多图json集合实例
               |— resourcesSpaceData Object 多图中单个图片对象
                  |— dimensions String 1440*900
                  |— resourceDate Null null
                  |— resourceType Number 1
                  |— suffix String .jpg
                  |— url String /u/cms/www/201911/22181403gqm7.jpg
            |— leixingtu Null null
         |— modelId Number 912 内容模型ID
         |— multiImageUploads Array ["multiImageUpload_YpzamX"] 多图集合的key对应的list集合
            |— 0 String multiImageUpload_YpzamX
         |— videoJson Object 视频json实例
            |— videoUpload_J50J3x Object 单个视频对象
               |— dimensions String
               |— resourceDate Number 40
               |— resourceType Number 2
               |— suffix String .mp4
               |— url String /u/cms/www/201911/22181350p62n.mp4
      |— createDate String 2019-09-28 创建时间(无分钟小时秒)
      |— createTime String 2019-09-28 11:48:15 创建时间
      |— id Number 147 收藏ID
      |— source String 光明日报 内容来源
      |— title String 教师节将至 教育部部长陈宝生撰文谈“尊师重教” 内容标题
      |— url String /gn/2702 内容URL
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 7
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-22 18:21:55
token String

添加收藏

API地址 : /member/usercollections

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 成功 false 失败
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

取消收藏

API地址 : /member/usercollections/cancel

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 收藏id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

批量取消收藏

API地址 : /member/usercollections/delete

请求方式: delete

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2]
 |-0 Number 2

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

取消收藏(根据内容)

API地址 : /member/usercollections/recall

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

一键清空

API地址 : /member/usercollections/deleteAll

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 11:37:00
token String

收藏分页(手机端)

API地址 : /member/usercollections/mobile/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
title String 标题
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— collectionTime String 15小时前 发布时间简短中文格式 刚刚,1分钟前...
      |— contentMobileVo Object 内容所有图片、视频封装vo
         |— channelName String 国内 内容栏目名称
         |— comments Number 0 评论量
         |— id Number 2702 内容ID
         |— imageJson Object 所有图片集合的json
            |— resource Object 单图对象实例
               |— dimensions String 370*240
               |— resourceDate Null null
               |— resourceType Number 1
               |— suffix String .png
               |— url String /u/cms/www/201909/10110857atq7.png
            |— multiImageUpload_YpzamX Array 多图集合实例
               |— resourcesSpaceData Object 多图集合中单图实例
                  |— dimensions String 1440*900
                  |— resourceDate Null null
                  |— resourceType Number 1
                  |— suffix String .jpg
                  |— url String /u/cms/www/201911/221814154zs0.jpg
         |— modelId Number 912 内容模型
         |— multiImageUploads Array ["multiImageUpload_YpzamX"] 多图集合的key集合
            |— 0 String multiImageUpload_YpzamX
         |— publishTime String 15小时前 发布时间简叙
         |— ups Number 0 点赞数
         |— url String http://192.168.0.200/c/www/gn/2702 内容浏览url
         |— videoJson Object 视频对象集合JSON
            |— videoUpload_J50J3x Object 视频对象实例
               |— dimensions String 资源尺寸:如图片100X300
               |— resourceDate Number 40 时长,单位:秒(仅限音频及视频)
               |— resourceType Number 2 文件类型(1图片 2视频 3音频 4附件)
               |— suffix String .mp4 后缀名(如.js)
               |— url String /u/cms/www/201911/22181350p62n.mp4 资源URL
         |— views Number 34 浏览量
      |— createDate String 2019-09-28 内容创建时间(无小时分钟秒)
      |— createTime String 2019-09-28 11:48:15 内容创建时间
      |— id Number 147 收藏ID
      |— title String 教师节将至 教育部部长陈宝生撰文谈“尊师重教” 内容标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 7
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-23 10:04:52
token String

微博第三方登录

API地址 : /thirdParty/sina/pc

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 微博登录,前台点击后会返回用户的信息,通过bind判断是否绑定,绑定过后,会返回登录需要的token,前台可通过该token直接登录。没有绑定则需要弹框;

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
nickname String 用户昵称
loginType String 第三方登陆标识(QQ WECHAT WEIBO )
uid String 用户第三方ID
bind Boolean true绑定false未绑定

QQ第三方登录

API地址 : /thirdParty/qq/pc

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: QQ第三方登录,前台点击后会返回用户的信息,通过bind判断是否绑定,绑定过后,会返回登录需要的token,前台可通过该token直接登录。没有绑定则需要弹框;

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
bind Boolean true已绑定false未绑定
loginType String 登录类型
uid String 第三方ID
nickname String 用户昵称

微信第三方登录

API地址 : /thirdParty/wechat/pc

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 微信第三方登录

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
nickname String 用户昵称
bind Boolean true已绑定false未绑定
loginType String 登录类型
uid String 第三方ID
JEECMS-Auth-Token String token

绑定会员或直接登录

API地址 : /thirdParty/bind

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 绑定会员或直接登录,用户昵称与用户名默认相同,直接登录密码可不传;

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
loginWay Number 1 登录方式 1.直接登录 2.绑定会员登录
loginType String WEIBO 登录类型QQ WECHAT WEIBO
thirdId String 2434378661 用户第三方ID
nickname String tom_jxnc 用户第三方昵称
username String tom_jxnc 用户名
psw String 密码(加密)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— JEECMS-Auth-Token String 登录token
   |— redirectUrl String 跳转地址
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-23 10:10:49
token String

微博手机登录

API地址 : /thirdParty/sina/mobile

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述: 微博登录,前台点击后会返回用户的信息ID,前台需要再调接口得到信息,通过bind判断是否绑定,绑定过后,会返回登录需要的token,前台可通过该token直接登录。没有绑定则需要弹框;

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明

QQ手机登录

API地址 : /thirdParty/qq/mobile

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述: QQ登录,前台点击后会返回用户的信息ID,前台需要再调接口得到信息,通过bind判断是否绑定,绑定过后,会返回登录需要的token,前台可通过该token直接登录。没有绑定则需要弹框;

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明

登录

API地址 : /login

请求方式: post

请求参数类型: form-data

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
identity String system 用户名
desStr String EwSSctvjsSzm8sZN2B5mecOcSAGZeGEZ 加密的密码参数名和参数值JSON串加密后的值, {"pStr":"123456"} 这是加密之前的JSON串 pStr固定 123456是用户输入的密码 采用3DES加密算法得到字符串 EwSSctvjsSzm8sZN2B5mecOcSAGZeGEZ 前端这个参数名可配置(服务端是可配置的,方便变更调整)
captcha String 验证码
rememberMe Boolean true 下次自动登录
sessionId String 验证码获取接口的sessionId (在有验证码的情况下该参数必填)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— nextNeedCaptcha Boolean true 需要显示验证码,false不需要
   |— JEECMS-Auth-Token String eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiIsImNyZWF0ZWQiOjE1MzE0NTA0MTc0NTQsInVzZXJTb3VyY2UiOiJwbGF0Zm9ybSIsImV4cCI6MTUzMjA1NTIxN30.bha4cjbU-Pj1Rg-kHEhaotWZ4H4JrpxjDbKV2cMDvsLZmjHn-j1PkJIAe5VPdXLekPb6YQ5t9eedJRwqJvYAkg 授权token
message String Successful!
redirectUrl String 登录跳转返回URL
requestUrl String
timestamp Number 1531450417558

退出

API地址 : /logout

请求方式: post

请求参数类型: form-data

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
token String

响应参数

名称 类型 初始值 说明
code Number 200
data Object null
message String Successful!
redirectUrl String
requestUrl String
timestamp Number 1531993092435

上传

API地址 : /member/upload/o_upload

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
uploadFile File 上传文件
typeStr String 类型 File文件 Flash Flash Image图片 Media视频 Audio音频 为空则默认Image
mark String 是否使用水印 (true则使用,否则根据站点配置决定是否使用水印)
modelId String 模型ID(如果是内容管理使用上传,则是内容模型ID,如果是栏目管理使用上传,则使用栏目模型ID)在栏目和内容管理上则必填
fieldName String 模型字段名称(在栏目、内容管理功能上此字段必填,以检查字段上设置的上传校验)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— dimensions String 1368*599 图片的尺寸
   |— fileSize Number 56 文件大小(单位kb)
   |— fileUrl String /u/gou/www/201806/211453580wtv.png 路径
   |— origName String QQ图片20180621140542.png 原名
   |— resourceId String 8
message String 操作成功!
redirectUrl String
requestUrl String
timestamp Number 1529564038299

验证邮箱

API地址 : /register/mail/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证邮箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mail String 邮箱

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true验证通过false不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563355417224
token String

验证手机号

API地址 : /register/phone/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证手机号

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
phone String 手机号

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 验证通过 false 验证不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563355417224
token String

验证用户名

API地址 : /register/username/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证用户名

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true验证通过 false验证不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563355417224
token String

前台新增会员动态字段

API地址 : /register/addition/model

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 前台新增会员动态字段

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— enableJson Object 启用字段
      |— formListBase Array
         |— preview String DPasswordPreview
         |— editor String DPasswordEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 4
         |— groupIndex Number 4
         |— type String password
         |— disableFields Array ["label","name","isRequired","isRegister"]
            |— 0 String label
         |— hiddenFields Array ["placeholder","defaultValue","isSmsVerification","isSmsFindPassword"]
            |— 0 String placeholder
         |— dragable Boolean true
         |— name String 密码
         |— isCustom Boolean false 是否扩展字段
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean true 是否必填
            |— defaultValue String 默认值
            |— name String password 字段名称
            |— isSmsVerification Boolean false 是否应用于手机验证
            |— tip String 帮助信息
            |— label String 密码 标签
            |— placeholder String 请输入内容 默认提示文字
            |— isSmsFindPassword Boolean false 是否应用于手机找回密码
            |— isRegister Boolean true 是否应用于注册
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563356466939
token String

PC注册会员

API地址 : /register

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: PC注册会员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 张学友1 用户名
email String 7889797@qq.com 邮箱
telephone String 电话
password String Kh2+07MaeeQ= 密码(加密)
realname String Siri 真实姓名
mobileCode String 579480 手机验证码
emailCode String 邮箱验证码
json Object 自定义对象
captcha String 图形验证码
sessionId String 验证码获取接口的sessionId (在有验证码的情况下该参数必填)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563416976572
token String

下载附件

API地址 : /download/o_accessory

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 下载附件

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [8402] 资源ID集合
 |-0 Number 8402

响应参数

名称 类型 初始值 说明

下载文库文档

API地址 : /download/o_doc_download

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id

响应参数

名称 类型 初始值 说明

获取图片

API地址 : /register/getImage

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String /u/1.jpg 图片资源路径
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-26 10:18:37
token String

静默获取微信用户-获取访问微信授权访问地址

API地址 : /weChat/getWxCode

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String https://open.weixin.qq.com/connect/oauth2/authorize?response_type=code&scope=snsapi_base&state=jeecms&appid=wxc596191fde33119f&component_appid=wx9325b66ca913be2e&redirect_uri=http://x1.11077.net/weChat/setOpenId#wechat_redirect 访问地址,接着访问该地址就可以访问到openid
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-26 18:01:18
token String

获取验证码

API地址 : /common/kaptcha

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— img String /9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAjAH0DASIA AhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQA AAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3 ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm p6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA AwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx BhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK U1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3 uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3quS1 74haT4c8QJpV/HOAYldp413KhJPBHXoM8Z611tea/F/UI/7KstHigSa9vJQUyoLKoI6ehJwPwNGG hGpUUJK9znxE5QpuUXsd5pms6brNv5+m3sNynfy2yV+o6j8avV4s3wj8Q6btu9K1aE3KLuARmicH HRWGf1IqofiT4x0DzNO1OGNrlOA11Dhx+RAYe/f1rd4OM/4Ek/zMVinD+NGx7oTgZNICCMgg9uK+ fItf1zxTdtDf+KItOGcFJnaJf0GOw6mt/wAG6lq+iXzQyXsVxYsp/eu+UDeT5vPoAoOffipngpQi 23qug4YuMmrLQ9lorxsfETUdM8RvbyTNdWjv8pYknaTw4GP4lwVHTDDqTXo+s+ILfT/DUmps6qrK Qo3r97ByBlgCeDwDn0zWE8PODSa32No1oSvZ7Gy08ShiZF+U4YA5IOM4+uOabFdW8/8AqZo3yqsN rZyrDII9jzz7V87S6jqmp6ggsmFqqo1zHv2IyAD5mBVV7Ak4HIGTnGa6m/8ACGteHTHew+IUF3GP 3aOSSw37QBx6yqP+Bmt5YPkspS1ZjHFc13GOiPZqK808EeJdcbT7m91yQtZwo5O9QrArhVx3O4h1 x6qfWsnXPjBdGZ4tItEWLJAmlBJYZ6gVCwlWU3CKvYt4mnGKlLS57DRXl/hHx34j163mhtNIS9uY 8F5nmEUce4nGe56HgV0n9geJNV51jxCbWI9bbSk8sf8AfxstUzw7pytNpFRrqavBNnWUVBZWkdhZ Q2kTSNHEoVTI5ZiPcnrU9c78jZBXOX3g2y1DxdZ+Ipp5mmtgAsLYKcZ2kdxgnP1ro6KqM5Q1iyZQ UtGFeMfGiQf25pKEZCwM2AcE5b/61ez15B8UNjeMdJklYxiIKq5GdxzuB+mcA104J2rJ+v5GGLV6 TXp+ZzHiHVdf1q1jmv8ASoLSz4CyG0BfBOM73BY9+h5xWnoHgK31XQHv7PWZYrjy2wijG44ZSpBI 69OvcivYr3TRqmjm2u1XzWiAJHQPwfyyK83sdH1TR9TvbaGzmmtirHKkAhSecF8jKthhjrmuiOLc ocsPda/rqYvDJT5p+9f+uhw0On391qKBbuKcpMkJcA4UKoALYxgAAD6itrUtQ197KHRLiS3Nq67I TEsoDjGP4TkhQMYIx6g9a0PDdjNqWp6hGYGxF8yeZtO30Xk7gM5II6Hg+lGg2cutePYkngZo4AZJ A8YIB9+GHbrxn1reVVN6291XMVTstL6sxtKttYG7RYxp6srF3aSQgLvQqQSMgBQTn0zWhe6n4g1r U57c2trNPKNq7ZG2xlmRgBnGD+7zjrV/T9MvI/iReQywIVlkKRO5DbQOchCMsAMeijjOeK1vDel3 kXi6b7VbOVjkZkkcjOc/fYkck9gP0rKpVipOTSva5pCk3FR13sXoPh9eX9uE1zWX8sksbawQRrku X5c5ZhuOai1ay8O+BdL8vT7CGW/kKopfDS/MSAQT7+ldfr+rjRNMa6Kb23BVX1JP+Ga8TtPF9g/i GbV9YilvmG828CjCqxfIPP51lQVWsm38K6LqaVnTpWXV9X0PTfhv4cbQtAEsqlLi7VWlRhgqRu/x rs65XwX4pu/FUNzczWP2SGMhUByS2c9CeD0rqq5Kzk6jc9zppKKglHYKKKKyNAooooAKz73RtN1G 8guLyyhuJYVIjaRd23kHjP0oopptbA1fc0KCM9aKKQFOCxtbe/nmht445HUF2VcFsk5z+Qrm/D1r bp4gmnSCNZZDPvZVAJxIQP0ooq4vRktao65UVWZgOWOSfWlwPQUUVBRXv7O3vbVobmFJY24KsM9e K5rw74T0C2xPHpVt5mFIZ134+RDxnOOSfzooqlKSTSYnFN3aOtACjAAA9qWiipGFFFFAH//Z 验证码base64
   |— sessionId String FF629522555E82B3B7C135B30F076498 当前会话标识ID
message String 操作成功
redirectUrl String
timestamp String 2019-08-07 14:18:03

统计pv,uv,ip

API地址 : /index/flow

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— pvTotal String 累计pv
   |— uvTotal String 累计uv
   |— ipTotal String 累计ip
   |— todayPv String 今日pv
   |— todayUv String 今日uv
   |— todayIp String 今日ip
   |— yesterdayPv String 昨日pv
   |— yesterdayUv String 昨日uv
   |— yesterdayIp String 昨日ip
   |— peakPv String 峰值pv
   |— peakUv String 峰值uv
   |— peakIp String 峰值ip
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-31 14:24:25
token String

百度语音转化

API地址 : /yuyin/ajax.jspx

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 百度语音转化

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
text String 需要转化的内容

响应参数

名称 类型 初始值 说明
code Number 200
data String http://tsn.baidu.com/text2audio?tex=%25E4%25BD%25A0%25E5%25A5%25BD&cuid=1&ctp=1&lan=zh&tok=24.30bd9319a5e7e91b6cc24808321b11d6.2592000.1570785483.282335-2327519 语音地址
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-09-11 17:18:09
token String

获取会员功能开启状态

API地址 : /systemInfo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— memberRegisterOpen String 是否开启会员注册
   |— MemberRegisterCaptcha String 会员注册是否需要图形验证码
   |— memberOpen String 会员功能是否开启
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-31 14:24:25
token String

检查权限

API地址 : /permCheck

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容id
channelId Number 栏目id

响应参数

名称 类型 初始值 说明
code Number 200
data Number 1 ( 正常 data =1 为2则是未登录 为3则是无权限浏览4用户密级不足)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 16:18:36
token String

附录1:响应状态码

CODE 公共 说明
10100 上传文件错误
10102 上传IO错误
10103 上传非图片
10104 上传文件格式错误
10105 上传超出限制
10106 上传错误
10107 上传OSS失败
10108 上传文件文件夹错误
10126 水印图片不存在
10144 上传设置水印错误
10537 内容状态不是暂存不能修改
10544 评论ID传入错误
11011 栏目id传入错误
11513 点赞需要登录
13162 后台未设置模型
14001 邮箱已经存在
14002 电话号码已经存在
14010 账户已经存在
14013 验证码未通过
14017 手机号未绑定会员
14018 邮箱未绑定会员
14033 该内容不允许评论
14034 该内容不允许游客评论
14035 传入的内容id错误
14036 该评论包含敏感词无法发布
14037 不允许在XX秒内连续评论
14038 评论包含链接无法发布
14040 该用户不允许评论
14041 该ip禁止评论
14042 该用户未登录