待办

API地址 : /cmsmanager/task/toDeal

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 内容标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array 内容集合
      |— lastActionCode String submit提交审核 agree通过 disagree不通过 sysdisagree 系统自动驳回
      |— actions Array 当前支持的动作
         |— code String pass 动作编号(agree通过 disagree不通过 )
         |— id Number 572 动作Id
         |— name String 通过 动作名称
      |— autoRevokeTime Number null 自动驳回时间
      |— channelName String 新闻 栏目名称
      |— contentId Number 2 内容id
      |— displayRemainTime String -- 流转剩余时间
      |— lastActionName String 提交审核 上次动作
      |— lastActionUsers Array ["test1"]
         |— 0 String test1
      |— previewUrl String /www/m/news/20190517/2.html 内容预览URL
      |— title String 测试2 内容标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563589135521
token String

已办

API地址 : /cmsmanager/task/handle

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array 内容集合
      |— allowRevoke Boolean false 是否允许撤回
      |— channelName String 新闻 栏目名称
      |— contentId Number 2 内容ID
      |— flowTime Number 1563519896000 流转时间
      |— nodeName String 审核2 当前节点名称
      |— previewUrl String /www/m/news/20190517/2.html 预览url
      |— title String 测试2 标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563593589478
token String

逾期未办

API地址 : /cmsmanager/task/overDue

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array 内容集合
      |— allowRevoke Boolean false 是否允许撤回
      |— channelName String 新闻 栏目名称
      |— contentId Number 2 内容ID
      |— flowTime Number 1563585907000 逾期时间
      |— nodeName String 审核1 逾期节点名称
      |— previewUrl String /www/m/news/20190517/2.html 预览url
      |— title String 测试2 标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563589129406
token String

设置国际化

API地址 : /cmsmanager/person/changeLocal

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
lang String en_US 英文 zh_CN 简体中文 zh_TW 繁体中文

响应参数

名称 类型 初始值 说明
code Number 200
data String en_US
message String success
redirectUrl String
requestUrl String
timestamp Number 1559727295624
token String

首页今日统计和累计统计

API地址 : /cmsmanager/index/statistics

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— todayComment Number 0 今日评论
   |— todayContent Number 0 今日内容
   |— todaySubmission Number 0 今日投稿数
   |— todayUser Number 0 今日新增会员数
   |— totalComment Number 41 累计评论数
   |— totalContent Number 0 累计内容发布数
   |— totalSubmission Number 0 累计投稿数
   |— totalUser Number 2 累计新增会员数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-09 14:04:12
token String

待办事项

API地址 : /cmsmanager/index/upcoming

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— toDealLetterCount Number 待处理信件
   |— totalUser Number 0 待审用户
   |— totalComment Number 0 待审评论
   |— toDealCount Number 41 待审内容
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-09 14:04:12
token String

关联相关内容

API地址 : /cmsmanager/contentrelation

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentIds Array [922,932] 关联相关内容id数组(必须最小有一个)
 |-0 Number 922 内容id
contentId Number 942 主内容id

响应参数

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

查询内容的相关内容

API地址 : /cmsmanager/contentrelation/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— content Object 内容对象
         |— channel Object 栏目对象
            |— name String 领导视察12138 栏目名称
         |— title String 你好我的世界 内容标题
      |— id Number 43 相关内容id
      |— relationContent Object 相关内容对象
         |— channel Object 栏目对象
            |— name String 领导视察12138 栏目名称
         |— title String 你好我的世界121389 内容标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561355704721
token String

排序

API地址 : /cmsmanager/contentrelation/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentRelationIds Array [42] 除正在排序的相关内容id
 |-0 Number 42
contentRelationId Number 43 排序的相关内容id
location Boolean false 排序在集合之前还是之后:true之前,false之后

响应参数

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

删除

API地址 : /cmsmanager/contentrelation/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [43] 相关内容id数组
 |-0 Number 43 相关内容id

响应参数

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

清空内容回收站

API地址 : /cmsmanager/contentext/clearAll

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 清空内容回收站

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

用户使用模型记录(优化)

API地址 : /cmsmanager/content/model/record

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 模型ID

响应参数

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

新增一个版本

API地址 : /cmsmanager/contentVersion

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentId Number 932 内容id值
remark String 备注 备注

响应参数

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

分页查询版本

API地址 : /cmsmanager/contentVersion/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentId Number 1 内容id值
page Number 1 页码
size Number 1 每页最大的容纳条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime Number 1561365162000 创建时间
      |— createUser String 创建人
      |— id Number 1052 版本id
      |— remark String 版本备注
      |— versionCode String 327848449771438240 版本code号
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561365203508
token String

查询单个版本

API地址 : /cmsmanager/contentVersion/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->版本id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— versionCode String 11555555 版本号
   |— createTime Number 1561085990000
   |— createUser String
   |— id Number 1043
   |— jsonTxt Object
      |— test4 String 那么PHP怎么想,如果Java不是世界上最好的语言
      |— contxt String 如果有一天,Java是世界上最好的语言
      |— test3 String 那么就很绝望了
   |— remark String 测试修改
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561365382801
token String

文档版本对比

API地址 : /cmsmanager/contentVersion/compare

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
versionIds Array 772,773 版本id数组, 表示需要对比的两个版本 0代表当前版本
contentId Number 332 内容id值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— contxt Object
      |— sortNum Number 1 排序值
      |— list1 Array 版本1中每行内容的对比结果
         |— rowNo Number 1 行号
         |— modified String 1 1 两个版本相同; 2 相较于另一个版本, 该版本中这一行是新增; 3 相较于另一个版本, 该版本中这一行被删除; 4 相较于另一个版本, 该版本中这一行被修改;
         |— type String 1 内容类型: 1文本; 2图片
         |— line String 白日依山尽  这一行的内容
      |— list2 Array 版本2中每行内容的对比结果
         |— rowNo Number 1
         |— modified String 1
         |— type String 1
         |— line String 白日依山尽 
   |— test2 Object
      |— list1 Array
         |— rowNo Number 1
         |— modified String 1
         |— type String 1
         |— line String 那么PHP怎么想,如果Java不是世界上最好的语言
      |— list2 Array
         |— rowNo Number 1
         |— modified String 1
         |— type String 1
         |— line String 那么PHP怎么想,如果Java不是世界上最好的语言
   |— test3 Object
      |— list1 Array
         |— rowNo Number 1
         |— modified String 1
         |— type String 1
         |— line String OD
      |— list2 Array
         |— rowNo Number 1
         |— modified String 1
         |— type String 1
         |— line String OD
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563777903727
token String

修改版本

API地址 : /cmsmanager/contentVersion

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1086 版本id
remark String 测试修改 备注信息

响应参数

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

删除版本

API地址 : /cmsmanager/contentVersion/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1042,1043] 版本id集合
 |-0 Number 1042 版本id

响应参数

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

回复版本

API地址 : /cmsmanager/contentVersion/recovery

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

分页查询

API地址 : /cmsmanager/contentrecord/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentId Number 1 内容id值
startTime String 2019-6-20 00:00:00 初始时间
endTime String 2019-6-20 00:00:00 截止时间
userName String sys 创建用户名称
page Number 1 页码
size Number 1 每页的最大容纳数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime Number 1561002608000 创建时间
      |— operateType String 修改 操作类型
      |— opreateRemark String 修改附件上传(删除test) 操作备注
      |— userName String system23 创建用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561363483743
token String

查看内容审核记录

API地址 : /cmsmanager/task/actions

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— actionName String 通过 节点通过动作名称
   |— actionRecords Array 节点操作记录
      |— actionCode String 动作编号(submit提交审核 agree通过 disagree不通过 sysdisagree 系统自动驳回)
      |— actionName String 通过 动作名称
      |— actionTime Number 1563593664000 操作时间
      |— id Number 746
      |— reason String 通过 意见
      |— userRealName String 小红 真实姓名
      |— username String ljw 用户名
   |— flowTime Number 1563593664000 节点流转时间
   |— node Object 节点
      |— id Number 686
      |— jointlySign Boolean false 是否会签
      |— name String 审核3 节点名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563611016654
token String

查看流程图信息

API地址 : /cmsmanager/task/processDiagram

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同工作流详情接口flow对象
   |— edges Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actionCode String
         |— allowRevoke Boolean true
         |— autoRevoke Boolean false
         |— autoRevokeHour Number 48
         |— autoRevokeTime Null null
         |— id String nmVd
         |— infoNotify Boolean true
         |— mailNotify Boolean true
         |— name String 动作
         |— notifyNextUsers Boolean true
         |— overTimeReminder Boolean false
         |— reasonMust Boolean false
         |— reasonOpen Boolean false
         |— reminderBegin Number 24
         |— reminderBeginTime Null null
         |— reminderInterval Number 4
         |— smsNotify Boolean true
      |— id String nmVd
      |— idCode String nmVd
      |— label String 动作
      |— labelCfg Null null
      |— nodeType String
      |— shape String edge
      |— source String uRR8
      |— target String 3yYF
   |— errors Array []
   |— flow Object
      |— autoPublish Boolean true
      |— flowCate Number 1
      |— flowJson String
      |— id Number 132
      |— name String 20190803
      |— remark String
      |— siteId Number 1
   |— nodes Array
      |— activity Boolean 是否当前任务节点
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actions Array []
         |— id String uRR8
         |— jointlyPassRatio Null null
         |— jointlySign Boolean false
         |— jointlyType Null null
         |— name String 开始
         |— orgIds Array []
         |— orgOptions Array []
         |— roleIds Array []
         |— roleOptions Array []
         |— userIds Array []
         |— userOptions Array []
      |— id String uRR8
      |— idCode String uRR8
      |— label String 开始
      |— nodeType String begin
      |— shape String beginNode
      |— x String 566
      |— y String 98
   |— tips Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-03 15:12:08
token String

流程操作(通过、驳回、自定义动作)

API地址 : /cmsmanager/task/audit

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
actionId Number 动作ID
contentId Number 内容ID
reason String 处理意见

响应参数

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

撤回审核操作

API地址 : /cmsmanager/task/revoke

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String Process configuration This action is not allowed to be withdrawn
redirectUrl String
requestUrl String /admin/task/revoke
timestamp Number 1563619220075
token String

查看当前内容审核节点

API地址 : /cmsmanager/task/currWorkflowNode

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 957
   |— label String 审核
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-23 16:23:00
token String

内容搜索列表

API地址 : /cmsmanager/contentext/page

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 内容搜索列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
orderType Number 1 排序方式
status Number 1 内容状态(1:草稿; 2-初稿 3:流转中; 4:已审核; 5:已发布; 6:驳回; 7:下线 9:暂存; 10:智能审核中; 11:审核成功; 12:审核失败 99-归档;)
contentType Number 1 内容类型,取内容类型集合
myself Boolean true 是否我创建的true 是 false 否
update Boolean true 是否重新编辑的true 是 false 否
createStartTime String 2018-05-05 起始创建开始时间
createEndTime String 2018-05-05 起始创建结束时间
releaseStartTime String 2018-05-05 起始发布开始时间
releaseEndTime String 2018-05-05 起始发布结束时间
createType Number 1 创建方式(1:直接创建 2:投稿 3:站群推送 4:站群采集 5:复制 6:链接型引用 7:镜像型引用)8 外部采集
modelId Number 1 内容模型
keyType Number 1 搜索关键字类型1.标题2.作者3.来源4.描述5.创建人
key String 关键字key
channelIds Array 1 栏目ID
contentSecretIds Array 1 内容密级ID
issueOrg Number 1 发文字号-机关代字
issueYear Number 1 发文字号-年份
issueNum String 发文字号-顺序号
contentId Number 内容id(不查询出内容id为该值的数据)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— viewData Object 内容扩展数据
         |— readCount Number 阅读量
         |— peopleCount Number 阅读人数
         |— likeCount Number 点赞数
         |— commentCount Number 评论数
      |— channelId Number 内容栏目ID
      |— createType Number 引用内容创建方式(1:直接创建 2:投稿 3:站群推送 4:站群采集 5:复制 6:链接型引用 7:镜像型引用
      |— quoteChannelName String 引用栏目名称
      |— quote Boolean true引用内容false原内容
      |— status Number 内容状态(1:草稿; 2-初稿 3:流转中; 4:已审核; 5:已发布; 6:退回; 7:下线 8-归档 )
      |— cmsContent Object 内容对象
         |— quoteChannelIds Array 引用栏目ID数组
         |— urlWhole String 浏览地址
         |— previewUrl String 预览地址
         |— copyName String 复制来源栏目名称
         |— quoteChannel Array 引用栏目名称
            |— name String 引用栏目名称
            |— createType Number 创建方式(1:直接创建 2:投稿 3:站群推送 4:站群采集 5:复制 6:链接型引用 7:镜像型引用
         |— channelName String 原栏目名称
         |— topEndTime Number 置顶结束时间
         |— topStartTime Number 置顶开始时间
         |— top Boolean 是否置顶
         |— channelId Number 栏目ID
         |— releaseTime Number 发布时间
         |— status Number 内容状态(1:草稿; 2-初稿 3:流转中; 4:待发布; 5:已发布; 6:退回; 7:下线 8-归档 )
         |— copyName String 复制来源栏目名称
         |— contentTypes Array 内容拥有类型
            |— typeName String 类型名称
            |— id Number 类型ID
         |— createTime Number 1558418820000 创建时间
         |— createUser String system 创建人
         |— id Number 162 内容ID
         |— model Object 内容模型对象
            |— id Number 4 内容模型ID
            |— modelName String 新闻 模型名称
         |— title String 你好我的世界 内容标题
      |— operations Object 操作权限
         |— CONTENTTYPE String false 内容类型
         |— SORT Boolean false 排序
         |— ADD Boolean false 新增(true 有权限,false 无权限)
         |— QUOTE Boolean false 引用
         |— SITE Boolean false 推送到站群
         |— PIGEONHOLE Boolean false 归档
         |— WECHAT Boolean false 推送到微信
         |— STICK Boolean false 置顶
         |— COPY Boolean false 复制
         |— PUBLISH Boolean false 发布
         |— VIEW Boolean false 浏览
         |— SINA Boolean false 推送到微博
         |— DELETE Boolean false 删除
         |— MOVE Boolean false 移动
         |— UPDATE Boolean false 修改
         |— PREVIEW Boolean false 预览
         |— OFFLINE Boolean false 下线
      |— types Array 类型操作
         |— id Number 53 类型ID
         |— operation Boolean false true 有权限 false 无权限
         |— typeName String 热点 类型名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 5
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558431548794
token String

排序列表

API地址 : /cmsmanager/contentext/orders

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 排序列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— 1 String 创建时间降序
   |— 2 String 创建时间升序
   |— 3 String 总访问数降序
   |— 4 String 总访问数升序
   |— 5 String 月访问数降序
   |— 6 String 月访问数升序
   |— 7 String 周访问数降序
   |— 8 String 周访问数升序
   |— 9 String 日访问数降序
   |— 10 String 日访问数升序
   |— 11 String 总评论数降序
   |— 12 String 总评论数升序
   |— 13 String 月评论数降序
   |— 14 String 月评论数升序
   |— 15 String 周评论数降序
   |— 16 String 周评论数升序
   |— 17 String 日评论数降序
   |— 18 String 日评论数升序
   |— 19 String 总点赞数降序
   |— 20 String 总点赞数升序
   |— 21 String 月点赞数降序
   |— 22 String 月点赞数升序
   |— 23 String 周点赞数降序
   |— 24 String 周点赞数升序
   |— 25 String 日点赞数降序
   |— 26 String 日点赞数升序
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558492981290
token String

改变内容状态

API地址 : /cmsmanager/contentext/status

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 改变内容状态,如果提示没有权限,将Type修改成2可继续操作,

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2,3] 实体IDs集合
 |-0 Number 1
status Number 2 内容状态(1:草稿; 2-初稿 3:流转中; 4:待发布; 5:已发布; 6:退回; 7:下线 8-归档 )

响应参数

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

回收站列表分页

API地址 : /cmsmanager/contentext/recycle

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 回收站列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID
startTime String 删除开始时间
endTime String 删除结束时间
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 2 内容ID
      |— status Number 1 状态
      |— title String 测试2 内容标题
      |— updateTime Number 1558083703000 删除时间
      |— updateUser String admin 删除人
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558342602410
token String

删除内容(逻辑删除)

API地址 : /cmsmanager/contentext/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除内容(逻辑删除)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1

响应参数

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

还原内容

API地址 : /cmsmanager/contentext

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 还原内容

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1

响应参数

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

出档

API地址 : /cmsmanager/contentext/file

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 出档

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1

响应参数

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

归档列表分页

API地址 : /cmsmanager/contentext/pigeonhole

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 归档列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentType String 内容类型,取内容类型集合
fileStartTime String 归档开始时间
fileEndTime String 归档结束时间
keyType String 搜索关键字类型1.标题2.作者3.来源4.描述5.创建人
key String 关键字key
channelIds Array 原栏目IDs
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— copyName String 复制来源栏目名称
      |— channelId Number 1322 栏目ID
      |— channelName String 栏目0819 栏目名称
      |— contentTypes Array 内容类型
         |— id Number 147 内容类型ID
         |— typeName String 推荐 内容类型名称
      |— createTime String 2019-08-19 14:10:53 创建时间
      |— createUser String system 创建人
      |— id Number 1664 内容ID
      |— model Object 模型
         |— id Number 704 模型ID
         |— modelName String 测试内容模型0819 模型名称
      |— quoteChannel Array 引用栏目数据
         |— name String 图片 图片22 引用栏目名称
         |— createType Number 6 创建方式(1:直接创建 2:投稿 3:站群推送 4:站群采集 5:复制 6:链接型引用 7:镜像型引用)8 外部采集
      |— releaseTime String 2019-08-19 14:10:52 发布时间
      |— status Number 8 内容状态(1:草稿; 2-初稿 3:流转中; 4:已审核; 5:已发布; 6:退回; 7:下线; 8:归档; 9:暂存 )
      |— title String 手机运存越大越好?别扯了,4G比12G更流畅! 标题
      |— top Boolean false 是否置顶
      |— topEndTime Null null 置顶结束时间
      |— topStartTime Null null 置顶开始时间
      |— updateTime String 2019-08-20 11:21:38 归档时间
      |— updateUser String system 归档人
   |— 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-20 14:27:16
token String

内容操作

API地址 : /cmsmanager/contentext/operation

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 内容操作

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 实体IDs集合
 |-0 Number 1
contentTypeId Number 53 内容类型ID(内容类型操作必传)
add Boolean false 是否新增内容类型,true 新增 false 取消(内容类型操作必传)

响应参数

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

置顶

API地址 : /cmsmanager/contentext/top

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 置顶

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1
startTime String 2018-08-05
endTime String 2019-05-30
workType Number 1 类型(1正常操作2.继续操作)

响应参数

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

取消置顶

API地址 : /cmsmanager/contentext/notop

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 取消置顶

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1
workType Number 1 类型(1正常操作2.继续操作)

响应参数

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

移动

API地址 : /cmsmanager/contentext/move

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 移动

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 内容ID集合
 |-0 Number 2
workType Number 1 类型(1正常操作2.继续操作)
channelId Number 1 栏目ID

响应参数

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

排序

API地址 : /cmsmanager/contentext/sort

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 排序

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 内容ID集合
 |-0 Number 1
contentId Number 162 被排序内容ID
location Boolean false 排序true之前,false之后

响应参数

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

删除内容(加入回收站)

API地址 : /cmsmanager/contentext/rubbish

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除内容(加入回收站)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 内容ID集合
 |-0 Number 2
workType Number 1 类型(1正常操作2.继续操作)

响应参数

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

引用内容

API地址 : /cmsmanager/contentext/quote

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 引用内容

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 内容ID集合
 |-0 Number 2
workType Number 1 类型(1正常操作2.继续操作)
channelIds Array [52] 栏目集合ID
 |-0 Number 52
createType Number 1 创建方式 1.链接型引用 2.镜像型引用

响应参数

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

取消引用

API地址 : /cmsmanager/contentext/noquote

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 取消引用

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 内容ID集合
 |-0 Number 2
channelIds Array [52] 栏目集合ID
 |-0 Number 52

响应参数

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

查询所有的内容模型(优化)

API地址 : /cmsmanager/content/model/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询所有的内容模型(全局的+改站点的)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 4 模型Id
   |— modelName String 新闻 模型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558947277134
token String

查询模板列表

API地址 : /cmsmanager/content/template/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询所有的PC端模板、手机模板(模型之下)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 2 模型id
type Number 1 1:PC模板,2:手机模板

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— tplPath String /content/index.html
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558947880304
token String

内容/附件密级列表

API地址 : /cmsmanager/content/secret/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
secretType Number 1 1-内容密级,2-附件密级

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 13 密级id
   |— name String 公开 密级名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558948078437
token String

来源列表

API地址 : /cmsmanager/content/source/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 1. 如果修改了返回来源列表中的来源名称则是执行了新增来源列表操作 2. 如果修改了返回来源列表中的来的链接则是执行了修改来源列表操作 3. 如果只是选择而不进行操作,则只在内容中添加来源列表,不对来源对象进行其它操作。

Header参数

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

请求参数

名称 类型 必填 初始值 说明
sourceName String 来源名称进行模糊查询

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— sourceLink String www.hao123.com1 来源链接
   |— sourceName String 百度 来源名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558948741626
token String

发文字号列表

API地址 : /content/mark/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
markType Number 1 1-机关代号,2-年份

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 发文字号id值
   |— markName String 2010 机关代号、年份
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558949135024
token String

新增时渲染内容结构

API地址 : /cmsmanager/content/plus/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->模型id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— basic Array
      |— content String {} 字段详细参数,json格式
      |— dataType Number 1 数据类型(1文本2多行文本 3单选 4多选 5下拉 6日期 7单图上传 8多图上传 9视频上传 10音频上传 11附件上传 12富文本 13组织 14地址 15城市)
      |— defValue String 默认值
      |— field String shortTitle 字段
      |— isCustom Boolean false 是否自定义字段
      |— isRequired Boolean true 是否必填项
      |— itemLabel String 副标题 名称
      |— placeholder String 默认提示文字
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558949248211
token String

新增内容

API地址 : /cmsmanager/content

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 底下除模型id,栏目id,title固定必填,其它是否必填根据"新增时渲染内容结构"该接口判断哪些字段必填,哪些字段不必填

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 332 模型id
channelId Number 732 栏目id
title Object 标题对象
 |-title String 正式测试新增 标题
 |-titleIsBold Boolean true 标题是否加粗
 |-titleColor String #99999 标题颜色
shortTitle String HelloWord 短标题
contentTag String 幸福,文明,明主,和谐 内容tag词
description String 在新的一年中我们必将完成一个新的变化 摘要
offlineTime String 2019-7-29 12:26:36 下线时间
releaseTime String 2019-7-28 12:26:36 上线时间
author String admin 作者
allowComment Number 1 评论设置:1, "允许游客评论", 2, "登录后评论", 3, "不允许评论"
tplMobile String default 手机模板
tplPc String default PC模板
outLink Object 外部链接对象
 |-outLink String www.baidu.com 外部链接
 |-isNewTarget Boolean true 外部链接是否新窗口点击
keyword String hello 关键词
releaseTerrace Array ["releasePc","releaseWap","releaseApp","releaseMiniprogram"] 发布平台传入的对象
 |-0 String releasePc
contentSecretId Number 12 内容密级(是否设置内容密级读取全局配置,如果没有全局配置的接口联系全局配置开发人员)
viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
contentSourceId Object 来源对象(如果来源对象存在,来源名称必填,来源链接非必填)
 |-sourceName String 百度 来源名称
 |-sourceLink String www.hao123.com 来源链接
type Number 1 内容状态(1:草稿; 2-初稿 3:流转中; 4:待发布; 5:已发布; 6:退回; 7:下线 8-归档 ) ,部分不可设置,请对应设计和工作流等场景自行判断按钮的显示
resource Number 98 单图上传id
postContent Object 发文字段对象
 |-issueOrg Number 1 发文字号-机关代字
 |-issueYear Number 1 发文字号-年号
 |-issueNum String 这个发文顺序号 发文字号-顺序号
json Object 自定义字段传入的对象
 |-checkbox_bwAEHk Array [1,5] 多选框传入的案例
  |-0 Number 1
 |-textarea_7fkMkY String 这是多行文本 多行文本传入案例
 |-imageUpload_Xr5hoS Number 98 单图上传传入案例
 |-fileUpload_ro9rlX Array 附件上传传入案例
  |-resId Number 99 附件id
  |-secretId Number 5 附件密级id(可能不存在,请对应全局配置,设置密级是否可以设置)
 |-multiImageUpload_VcAFlD Array 多图上传传入案例
  |-resId Number 101 资源对象id
  |-description String 图片描述1 图片描述
 |-videoUpload_ixNN8O Number 261 视频上传案例
 |-content1 String 正文2 正文信息案例
 |-orgid Number 1 组织案例
 |-city_9y8PrT Object 城市信息案例
  |-provinceCode Number 1001 省级code
  |-cityCode Number 1002 城市code
 |-address_wjTLIH Object 地址信息案例
  |-provinceCode Number 1001 省级code
  |-cityCode Number 1002 城市code
  |-areaCode Number 1003 区域code
  |-address String 西湖区观洲阳光小区 详细地址

响应参数

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

查询单个内容

API地址 : /cmsmanager/content/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->内容id值

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— checkErrorContent String 参数错误 内容审核失败原因
   |— banJson Object 违禁内容JSON对象
      |— title Object 字段对象JSON
         |— isAllTxt Boolean true true->该字段全部文本为违禁词,false->
         |— img Array [ "http://x1test.jeecms.com/u/cms/www/202002/13105043akdv.jpg" ] 字段的违禁图片集合
         |— txt Array [ "法轮功" ] 字段的文本违禁内容集合
   |— top Boolean 是否置顶
   |— purview Object 该内容权限对象
      |— weiboPushContentAble Boolean false 是否可以微信推送
      |— wechatPushContentAble Boolean true 是否可以微信推送
      |— sitePushContentAble Boolean false 是否可站群推送
      |— publishContentAble Boolean false 是否可以发布
      |— typeContentAble Boolean false 是否可操作内容类型
      |— quoteContentAble String false 是否可以引用
      |— copyContentAble Boolean false 是否可以复制
      |— sortContentAble Boolean false 是否可以排序
      |— moveContentAble Boolean false 是否可以移动
      |— topContentAble Boolean false 是否可以置顶
      |— fileContentAble Boolean true 是否可以归档
      |— deleteContentAble Boolean false 是否可以删除
      |— editContentAble Boolean false 是否可以修改
   |— revokeSupport Boolean 内容是否可撤回审核操作
   |— actions Object 当前支持的审核类操作
      |— reasonMust Boolean 意见是否必填
      |— reasonNeed Boolean 是否需要输入意见
      |— actionName String 动作名称
      |— actionId Number 动作ID
   |— contentTypes Array 内容类型关联实体类集合
      |— typeName String 推荐 内容类型名称
      |— logoResource Object 内容类型图标login对象
         |— url String
         |— suffix String
         |— resourceType Number
         |— id Number
         |— aliase String
      |— id Number 内容类型id值
   |— previewUrl String /content?content 内容预览URL
   |— url String /contnte?11 内容浏览URL
   |— dataField Object 返回的渲染字段对应的数据
      |— status Number 1 内容状态(1:草稿; 2-初稿 3:流转中; 4:已审核; 5:已发布; 6:驳回; 7:下线 8-归档; 9:暂存;10-审核中,11-违禁内容;12-审核失败)
      |— channelId Number 322 栏目id
      |— releaseTerrace Array ["releasePc"] 发布平台返回数据
         |— 0 String releasePc 发布到PC
      |— releaseTime String 2019-07-28 12:26:36 发布时间
      |— checkbox_bwAEHk Array ["1","5"] 复选框返回数据
         |— 0 String 1
      |— videoUpload_ixNN8O Object 视频上传返回数据
         |— alias String favicon 资源别名
         |— id Number 261 资源id
         |— resourceType Number 4 文件类型(1图片 2视频 3音频 4附件)
         |— suffix String .ico 资源后缀
         |— url String /u/cms/www/201907/081535114fvz.ico 资源url
      |— contentTag String 文明,明主,和谐,幸福 内容tag词
      |— postContent Object 发文对象返回数据
         |— issueYear Number 1 发文年份
         |— issueNum String 这个发文顺序号 发文顺序号
         |— issueOrg Number 1 发文机关代码
      |— address_wjTLIH Object 所在地返回对象
         |— areaCode String 1003 区域code
         |— address String 西湖区观洲阳光小区 详细地址
         |— provinceCode String 1001 省份code
         |— cityCode String 1002 城市code
      |— shortTitle String HelloWord 短标题
      |— title Object 标题对象
         |— titleColor String #99999 标题颜色
         |— titleIsBold Boolean true 标题是否加粗
         |— title String 正式测试新增 标题
      |— multiImageUpload_VcAFlD Array 多图上传返回的对象
         |— description String 图片描述1 图片的描述
         |— resourcesSpaceData Object 资源对象
            |— alias String 5ac1eae4Nce7c8b00
            |— id Number 101
            |— resourceType Number 1
            |— suffix String .jpg
            |— url String /u/cms/www/201907/03150535d1zd.jpg
         |— secret Null null 当为多图上传时此值必定为空(为空无法处理前端自行判断)
      |— orgid Array [1] 组织返回的list集合(父节点->自身节点)
         |— 0 Number 1
      |— fileUpload_ro9rlX Array 附件返回的对象
         |— description String 图片的描述此值不存在
         |— resourcesSpaceData Object
            |— alias String 5b601e78Na283a60d
            |— id Number 99
            |— resourceType Number 1
            |— suffix String .jpg
            |— url String /u/cms/www/201907/03150441l8cd.jpg
         |— secret Null null 当为附件是此值可能为空
      |— imageUpload_Xr5hoS Object
         |— alias String view
         |— id Number 98
         |— resourceType Number 1
         |— suffix String .png
         |— url String /u/cms/www/201907/03150423xuxr.png
      |— content2 String null 内容返回的结构
      |— content1 String null
      |— city_9y8PrT Object
         |— provinceCode String 1001
         |— cityCode String 1002
      |— offlineTime String 2019-07-29 12:26:36 下线时间
      |— textarea_7fkMkY String 这是多行文本
   |— id Number 1285 内容id
   |— modelId Number 332 内容模型id
   |— modelName String 测试内容模型 内容模型名称
   |— renderingField Object 字段的渲染结构
      |— formListTitle Array
         |— preview String DSubTitlePreview
         |— editor String DSubTitleEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 2
         |— groupIndex Number 2
         |— type String subTitle
         |— disableFields Array ["label","name"]
            |— 0 String label
         |— hiddenFields Array []
         |— dragable Boolean true
         |— name String 副标题
         |— isCustom Boolean false
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean false
            |— min Number 1
            |— max Number 50
            |— defaultValue String
            |— inputLimit String
            |— name String shortTitle
            |— tip String
            |— isInputLimit Boolean false
            |— label String 副标题
            |— placeholder String 请输入内容
            |— isLengthLimit Boolean true
      |— formListExtend Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563269549971
token String

修改内容

API地址 : /cmsmanager/content

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 下方部分的值必填值为业务必填和模型必填无关,请对应模型设置对应的值

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 932 内容id
channelId Number 732 内容栏目id
title Object 内容标题对象
 |-title String 正式测试新增 标题
 |-titleIsBold Boolean true 是否加粗
 |-titleColor String #99999 标题颜色
shortTitle String HelloWord 短标题
contentTag String 幸福,文明,明主,和谐 tag词
description String 在新的一年中我们必将完成一个新的变化 描述
offlineTime String 2019-7-29 12:26:36 下线时间
releaseTime String 2019-7-28 12:26:36 发布时间
author String admin 作者
allowComment Number 1 评论设置:1, "允许游客评论", 2, "登录后评论", 3, "不允许评论"
tplMobile String default 手机模板
tplPc String default PC模板
outLink Object 外部链接对象
 |-outLink String www.baidu.com 外部链接
 |-isNewTarget Boolean true 外部链接是否新窗口点击
keyword String hello 关键词
releaseTerrace Array ["releasePc","releaseWap","releaseApp","releaseMiniprogram"] 发布平台传入的对象
 |-0 String releasePc
contentSecretId Number 12 内容密级(是否设置内容密级读取全局配置,如果没有全局配置的接口联系全局配置开发人员)
viewControl Number 1 浏览设置(1-允许游客访问 2-登录后访问)
contentSourceId Object 来源对象(如果来源对象存在,来源名称必填,来源链接非必填)
 |-sourceName String 百度 来源名称
 |-sourceLink String www.hao123.com 来源链接
type Number 1 内容状态(1:草稿; 2-初稿 3:流转中; 4:待发布; 5:已发布; 6:驳回; 7:下线 8-归档 ) ,部分不可设置,请对应设计和工作流等场景自行判断按钮的显示
resource Number 98 单图上传id
postContent Object 发文字段对象
 |-issueOrg Number 1 发文字号-机关代字
 |-issueYear Number 1 发文字号-年号
 |-issueNum String 这个发文顺序号 发文字号-顺序号
json Object 自定义字段传入的对象
 |-checkbox_bwAEHk Array [1,5] 多选框传入的案例
  |-0 Number 1
 |-textarea_7fkMkY String 这是多行文本 多行文本传入案例
 |-imageUpload_Xr5hoS Number 98 单图上传传入案例
 |-fileUpload_ro9rlX Array 附件上传传入案例
  |-resId Number 99 附件id
  |-secretId Number 5 附件密级id(可能不存在,请对应全局配置,设置密级是否可以设置)
 |-multiImageUpload_VcAFlD Array 多图上传传入案例
  |-resId Number 101 资源对象id
  |-description String 图片描述1 图片描述
 |-videoUpload_ixNN8O Number 261 视频上传案例
 |-content1 String 正文2 正文信息案例
 |-orgid Number 1 组织案例
 |-city_9y8PrT Object 城市信息案例
  |-provinceCode Number 1001 省级code
  |-cityCode Number 1002 城市code
 |-address_wjTLIH Object 地址信息案例
  |-provinceCode Number 1001 省级code
  |-cityCode Number 1002 城市code
  |-areaCode Number 1003 区域code
  |-address String 西湖区观洲阳光小区 详细地址

响应参数

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

复制内容

API地址 : /cmsmanager/content/duplication

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array 332 内容id
channelId Number 1 栏目id数组

响应参数

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

微博推送接口

API地址 : 转到微博推送记录下查看

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 转到微博推送记录下查看

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明

推送到站群

API地址 : /cmsmanager/content/push/sites

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentIds Array 1 内容id集合
siteId Number 1 站点id
pushSecret String wext 推送到站群秘钥
channelId Number 1 站点下栏目id

响应参数

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

校验内容标题是否可以使用

API地址 : /cmsmanager/content/title/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 震惊13亿中国人,xxxx 内容标题
channelId Number 1 栏目树形列表中选中的栏目ID值
contentId String 1 内容ID

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true->该内容标题可用,false->该内容标题不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556244191115
token String

内容提交审核

API地址 : /cmsmanager/content/submit

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: id不传是新增,id传是修改

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 932
channelId Number 732
title Object
 |-title String 正式测试新增
 |-titleIsBold Boolean true
 |-titleColor String #99999
shortTitle String HelloWord
contentTag String 幸福,文明,明主,和谐
description String 在新的一年中我们必将完成一个新的变化
offlineTime String 2019-7-29 12:26:36
releaseTime String 2019-7-28 12:26:36
author String admin
allowComment Number 1
tplMobile String default
tplPc String default
outLink Object
 |-outLink String www.baidu.com
 |-isNewTarget Boolean true
keyword String hello
releaseTerrace Array ["releasePc","releaseWap","releaseApp","releaseMiniprogram"]
 |-0 String releasePc
contentSecretId Number 12
viewControl Number 1
contentSourceId Object
 |-sourceName String 百度
 |-sourceLink String www.hao123.com
type Number 1
resource Number 98
postContent Object
 |-issueOrg Number 1
 |-issueYear Number 1
 |-issueNum String 这个发文顺序号
json Object
 |-checkbox_bwAEHk Array [1,5]
  |-0 Number 1
 |-textarea_7fkMkY String 这是多行文本
 |-imageUpload_Xr5hoS Number 98
 |-fileUpload_ro9rlX Array
  |-resId Number 99
  |-secretId Number 5
 |-multiImageUpload_VcAFlD Array
  |-resId Number 101
  |-description String 图片描述1
 |-videoUpload_ixNN8O Number 261
 |-content1 String 正文2
 |-orgid Number 1
 |-city_9y8PrT Object
  |-provinceCode Number 1001
  |-cityCode Number 1002
 |-address_wjTLIH Object
  |-provinceCode Number 1001
  |-cityCode Number 1002
  |-areaCode Number 1003
  |-address String 西湖区观洲阳光小区

响应参数

名称 类型 初始值 说明

新增内容查看默认值

API地址 : /cmsmanager/channel/defaults/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->栏目ID值 新增内容页面,切换栏目查看默认值,当前仅有:浏览设置、评论设置

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— allowComment Number 1 评论设置
   |— viewControl Number 3 浏览设置
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-09-04 14:36:05
token String eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzeXN0ZW0iLCJjcmVhdGVkIjoxNTY3NTc4OTY0OTYwLCJ1c2VyU291cmNlIjoiYWRtaW4iLCJleHAiOjE1Njc1OTYxNjR9.CJkbCDtIlYleAxQQ9RBFLHbkipZXpZ07OKdvLeaKwLvwV1VUezkWWImEOLcL8qRGtYqWdVK79BxNsNh8TTukMg

内容审核列表

API地址 : /cmsmanager/contentext/chack/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 测试 内容标题
channelId Number 1 栏目id
status Number 10 10:智能审核中; 11:审核成功; 12:审核失败
page Number 1 页码
size Number 1 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— channelId Number 2212 栏目id
      |— cmsContent Object 内容对象
         |— channelId Number 2212 栏目id
         |— channelName String 测试栏目误删 栏目名称
         |— createTime String 2020-01-13 09:40:52 内容创建时间
         |— createUser String system 内容创建人
         |— id Number 36942 内容id
         |— model Object 模型对象
            |— id Number 912 模型id
            |— modelName String 新闻 模型名称
         |— previewUrl String http://cm.ngrok2.xiaomiqiu.cn/preview?contentId=36942&type=content 预览URL
         |— status Number 12 内容状态:10:智能审核中; 11:审核成功; 12:审核失败
         |— title String 1. 买毒品请联系10086 内容标题
         |— urlWhole String http://cm.ngrok2.xiaomiqiu.cn/cslmws/36942 获取url绝对路径
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-01-18 15:17:44
token String

审核中内容数量

API地址 : /cmsmanager/contentext/chack/amount

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Number 0 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-01-18 15:29:06
token String

控制强制发布按钮显示

API地址 : /cmsmanager/content/force/button

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true->显示,false->不显示
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-15 21:26:34
token String

内容获取按钮

API地址 : /cmsmanager/content/button

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
status Number 11 1-新增内容、2-内容详情
id Number 1 内容id,当status=2,此值必填
channelId Number 1 栏目id,当status=1,此值必填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— dtos Array 按钮dto集合
      |— icon String baocun 前台图标标识
      |— key String dropdown 前端按钮块的key,dropdown-下拉框,link-点击按钮
      |— subset Array 二级按钮(有且有2级)
         |— click Boolean true 该按钮是否可以点击
         |— contentTypeIcon Object 内容类型icon资源标识
            |— alias String /u/cms/www/201911/风景1.jpg 资源别名
            |— id Number 1 资源id
            |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
            |— suffix String .jpg 后缀名
            |— url String /u/cms/www/201911/22173609efvz.jpg 资源url地址
         |— contentTypeStatus Boolean false 该内容是否存在该"内容类型"类型,该标识只有内容类型按钮有用
         |— icon String baocun 按钮前端图标标识
         |— key String 1 前端按钮块的key,第二层为前端需要的数字
         |— port Object 按钮调用的api对象
            |— apiUrl String /admin/content api的url
            |— requestMethod String PUT api的请求方式
         |— subset Array [] 子集按钮
         |— text String 存为初稿 按钮提示文本
      |— text String 保存 按钮提示文本
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-03-03 21:50:03
token String

重置内容密级

API地址 : /cmsmanager/content/reset/secret

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 重置内容密级接口->在内容模型中删除密级字段使用、在站内信重置按钮使用 1. 有两种可能 moduleId必填 或 secretIds、type、requestStatus必填 2. 具体那些值必填哪些不填请严格对照需求来

Header参数

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

请求参数

名称 类型 必填 初始值 说明
secretIds Array [275] 密级id集合
 |-0 Number 275
type Number 2 密级类型(1内容密级 2附件密级类型)
requestStatus Number 2 请求状态:1-删除密级、2-删除内容密级和修改内容(必须传2)
moduleId Number 1 模型id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— code String 481028566915088544 内容重置标识(校验内容重置是否完成)
   |— predictionTimeConsuming Number 29 预测耗时(单位:秒,用于进度条使用)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-08-20 09:15:47
token String

校验重置内容密级是否完成

API地址 : /cmsmanager/content/execute/result

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
code String 480803253249507488 校验内容重置code标识

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true->重置完成,false->重置未完成
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-08-20 09:21:43
token String

查询栏目模型

API地址 : /cmsmanager/channel/model/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询所有的未被禁用,未被删除的栏目模型(站点+全局)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
tplType Number 1 模型类型(1-栏目模型 2-内容模型)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 模型Id
   |— modelName String 新闻 模型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556241815775
token String

查询PC、手机端模板

API地址 : /cmsmanager/channel/template/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询该站点,该模型下所有的PC端模板、手机模板

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 2 模型Id
type Number 1 1:PC模板,2:手机模板

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— tplPath String content/news.html 模板路径
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562917163948
token String

查询栏目列表(可查询的树形结构)

API地址 : /cmsmanager/channel/term/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询该站点下,所有拥有查看权限的栏目列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 新闻 栏目名称

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— permAssignAble Boolean true 是否可分配权限
   |— editAble Boolean true 是否拥有修改权限
   |— deleteAble Boolean true 是否拥有删除权限
   |— viewAble Boolean true 是否拥有可查看的权限
   |— mergeAble Boolean true 是否拥有可合并栏目的权限
   |— children Array 该栏目的子集栏目
      |— permAssignAble Boolean true 是否可分配权限
      |— editAble Boolean true
      |— deleteAble Boolean true
      |— viewAble Boolean true
      |— mergeAble Boolean true
      |— name String 图片22
      |— id Number 1331
      |— staticAble Boolean true
      |— createChildAble Boolean true
      |— parentId Number 1325
   |— name String 图片 栏目名称
   |— id Number 1325 栏目ID
   |— staticAble Boolean true 是否拥有可静态化得权限
   |— createChildAble Boolean true 是否拥有可创建子集的栏目
   |— parentId Null null 该栏目的父节点ID值
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-29 09:14:05
token String

校验栏目名称或者路径

API地址 : /cmsmanager/channel/element/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 校验栏目名称或者路径,如果校验栏目名称则path不可以传,如果校验路径则name不可以传

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 新闻 校验的栏目名称
path String news 栏目访问路径
id Number 1 新增时校验此字段不可填,修改是校验此字段必填

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true说明该栏目名称或者路径可用,false说明该栏目名称或者路径不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556244191115
token String

新增栏目

API地址 : /cmsmanager/channel

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增单个栏目

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelParentId Null null 栏目父级id
channelName String 领导视察 栏目名称
channelPath String ldsc10 栏目路径
modelId Number 2 模型id

响应参数

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

删除栏目

API地址 : /cmsmanager/channel/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 在列表中删除栏目(加入回收站),当列表中选中父级节点时,其子集节点必须对应选中

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2,440,483] 栏目Id数组
 |-0 Number 1 栏目Id

响应参数

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

彻底删除栏目(清空回收站)

API地址 : /cmsmanager/channel/thorough/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 回收站删除栏目,删除栏目,如果选中父级,子集有且必须选中

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2,440,483] 栏目Id数组
 |-0 Number 1 栏目Id

响应参数

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

还原栏目

API地址 : /cmsmanager/channel/reduction

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 将回收站的栏目还原

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [152,153,162] 栏目Id数组
 |-0 Number 152 栏目标识
isContent Boolean true 是否还原内容,true->还原内容+栏目,false->仅还原栏目

响应参数

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

批量新增子集栏目

API地址 : /cmsmanager/channel/multiple

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelParentId Number 1122 需要新增的子集的第一级父类id
channelNames Array [" 中国图片"," 北京图片","国外图片"] 栏目名称集合
 |-0 String 中国图片
modelId Number 471 模型id

响应参数

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

查询单个栏目详情

API地址 : /cmsmanager/channel/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->选择的栏目Id值,注意:当contentTpls此字段的value值为空,查询此值时,必须调用"查询内容模型模板"进行查询显示

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 栏目Id值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— previewUrl String /?channel=6.html 栏目预览URL
   |— url String /channel?channelId = 9 栏目浏览URL
   |— dataField Object 字段值数据对象
      |— link Object 字段对象(当默认字段为外部链接时使用)
         |— linkTarget Boolean true 新窗口打开外部链接
         |— link String www.jeecms.com 外部链接
      |— address_ppio5P Object 字段对象(当自定义字段为所在地的数据格式)
         |— areaCode String 1003 区域code
         |— address String 西湖区观洲阳光小区 详细地址
         |— provinceCode String 1001 省级code
         |— cityCode String 1002 城市code
      |— ueditor_ztCFrR String 字段对象
      |— input_shnELy String 这是单行文本
      |— multiImageUpload_3BQU7e Array 字段对象(字段类型为多图上传或附件上传的数据格式)
         |— description String 图片描述1 图片描述
         |— resourcesSpaceData Object 资源对象
            |— suffix String .jpg 资源后缀
            |— alias String 5ac1eae4Nce7c8b00 资源别名
            |— id Number 101 资源id
            |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
            |— url String /u/cms/www/201907/03150535d1zd.jpg 资源路径
         |— secret Null null 密级对象
      |— channelParentId Number 1 栏目父类id
      |— channelName String 领导视察12138 栏目名称
      |— channelPath String ldsc1001 栏目路径
      |— fileUpload_iEBpEY Array 附件上传
         |— description String
         |— resourcesSpaceData Object
            |— suffix String .jpg 资源后缀名
            |— alias String 5b601e78Na283a60d
            |— id Number 99
            |— resourceType Number 1
            |— url String /u/cms/www/201907/03150441l8cd.jpg
         |— secret Object null
            |— name String 绝密 密级名称
            |— id Number 11 附件密级id
      |— city_iepQFa Object 字段对象(字段类型为城市时的数据格式)
         |— provinceCode String 1001 省级code
         |— cityCode String 1002 城市code
      |— orgid Array 1 自身和父级id值(父级->自身)
   |— id Number 802 栏目id
   |— modelId Number 311 改栏目模型id
   |— modelName String 测试栏目新增 模型名称
   |— renderingField Object 前台渲染字段的具体结构
      |— formListBase Array
         |— preview String DAddressPreview
         |— editor String DAddressEditor
         |— groupType Number 1
         |— icon String dizhi
         |— index Number 10
         |— groupIndex Number 7
         |— type String address
         |— dragable Boolean true
         |— prop String address_1562672026898_618900
         |— name String 地址
         |— isCustom Boolean true
         |— canDelete Boolean true
         |— value Object
            |— country String
            |— isRequired Boolean false
            |— province String
            |— isSetDefault Boolean false
            |— city String
            |— defaultValue String
            |— name String address_ppio5P
            |— detailAddress String
            |— tip String
            |— label String 地址
      |— formListSeo Array []
      |— formListExtend Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562745288128
token String

查询内容模型模板

API地址 : /cmsmanager/channel/content/model

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询该站点拥有的内容模型模板

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— mobileTplPaths Array
      |— tplPath String index/index.htm
   |— modelName String 新闻
   |— modelId Number 4
   |— tplMobile String index/index.htm
   |— tplPc String index/index.htm
   |— pcTplPaths Array
      |— tplPath String index/index.htm
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556611629356
token String

修改栏目主体(优化)

API地址 : /cmsmanager/channel

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改栏目主体

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 802 栏目id
channelParentId Number 1 上级栏目id
channelName String 领导视察12138 栏目名称
channelPath String ldsc1001 栏目路径
display Boolean false 显示在栏目循环列表
tplPc String PC模板1 栏目PC端模板
tplMobile String 手机端模板1 栏目手机端模板
contentTpls Array 内容型模板
 |-select Boolean 是否勾选,true勾选,false不勾选
 |-modelId Number 4 模型id
 |-tplMobile String 1.html 手机端模板
 |-tplPc String 2.html PC端模板
commentControl Number 1 评论设置
viewControl Number 1 浏览设置
workflowId Number 1 工作流id
resourceId Number 98 图片id(默认字段为栏目字段)
txt String 这是栏目描述 栏目描述
contribute Boolean true 是否允许投稿
pageSize Number 10 分页大小
isListChannel Boolean false 栏目页是否包含分页
seoTitle String SEO标题 SEO标题
seoKeywork String SEO关键字 SEO关键字
seoDescription String SEO描述 SEO描述
link Object 新窗口打开外部链接
 |-linkTarget Boolean true 新窗口打开链接
 |-link String www.jeecms.com 链接
json Object 自定义字段传递对象
 |-imageUpload_Xr5hoS Number 11 当元素为(单图上传、音频、视频)时传入格式
 |-input_shnELy String 这是单行文本
 |-fileUpload_iEBpEY Array 当元素类型为附件上传时传递的对象
  |-resId Number 99 资源id
  |-secretId Number 5 密级id(如果没有开启此值不传)
 |-multiImageUpload_3BQU7e Array 当元素类型为多图上传时传递的对象
  |-resId Number 101 资源id
  |-description String 图片描述1 描述(具体的长度限制根据模型配置的处理)
 |-ueditor_ztCFrR String 这是测试富文本
 |-orgid Number 1
 |-city_iepQFa Object 当元素类型为城市时传递的对象
  |-provinceCode String 1001 省级code
  |-cityCode String 1002 城市code
 |-address_ppio5P Object 当元素类型为所在地是传递的对象
  |-provinceCode String 1001 省级code
  |-cityCode String 1002 城市code
  |-areaCode String 1003 区域code
  |-address String 西湖区观洲阳光小区 详细地址
groupType String formListBase 分组详情:formListBase->主体,formListSeo->SEO扩展,formListExtend->扩展

响应参数

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

应用工作流

API地址 : /cmsmanager/channel/claim/workflow

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 当all为true时,ids不需要传,传了也不取值

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [633,1,2] 目标栏目Id数组
 |-0 Number 633
channelId String 1 源栏目id值
all Boolean true 是否选择全部

响应参数

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

移动栏目

API地址 : /cmsmanager/channel/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 同级移动栏目 onId不传则说明移动到该同层栏目的最上方

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 1822 需要移动栏目的id值
onId Number 1842 移动到该栏目的下方
nextId Number 1888 移动在该栏目的上方

响应参数

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

查询栏目列表(树形结构)

API地址 : /cmsmanager/channel/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 新增、修改调用树形结构使用必须判断createChildAble权限是否存在,存在才可以勾选,不存在不可勾选,合并调用树形结构展示必须判断mergeAble权限是否存在,存在才可以勾选,不存在不可勾选

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— editAble Boolean true 是否拥有修改权限
   |— deleteAble Boolean true 是否拥有删除权限
   |— viewAble Boolean true 是否拥有可查看的权限
   |— mergeAble Boolean true 是否拥有可合并栏目的权限
   |— children Array 该栏目的子集栏目
      |— editAble Boolean true
      |— deleteAble Boolean true
      |— viewAble Boolean true
      |— mergeAble Boolean true
      |— permAssignAble Boolean true
      |— name String 图片22
      |— id Number 1331
      |— staticAble Boolean true
      |— createChildAble Boolean true
      |— parentId Number 1325
   |— permAssignAble Boolean true 是否可分配权限
   |— name String 图片 栏目名称
   |— id Number 1325 栏目ID
   |— staticAble Boolean true 是否拥有可静态化得权限
   |— createChildAble Boolean true 是否拥有可创建子集的栏目
   |— parentId Null null 该栏目的父节点ID值
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-29 14:22:32
token String

发布静态页

API地址 : /cmsmanager/content/staticPage/channel

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID
op String 操作选项(channel 生成栏目静态页 channelChild 生成子栏目静态 channelContent 生成内容静态页) 英文逗号可拼接这些字符串 合并动作

响应参数

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

合并栏目

API地址 : /cmsmanager/channel/merge

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 合并栏目目标id
ids Array 栏目id数组

响应参数

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

查询可静态化栏目树

API地址 : /cmsmanager/channel/staticChannelTree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— hasStaticChannel Boolean 是否已生成栏目静态化页面
   |— name String 领导视察
   |— id Number 714
   |— childs Array
      |— hasStaticChannel Boolean 是否已生成栏目静态化页面
      |— name String 领导视察
      |— id Number 732
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556617627172
token String

可发布内容的栏目树

API地址 : /cmsmanager/channel/publicContentChannelTree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— name String 领导视察
   |— id Number 714
   |— children Array
      |— name String 领导视察
      |— id Number 732
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556617627172
token String

栏目树(忽略权限)

API地址 : /cmsmanager/channel/getAllTree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— urlWhole String URL
   |— children Object 子栏目对象
   |— isOpenIndex Boolean true 是否开启了查询索引
   |— name String 领导视察
   |— id Number 714
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562640994575
token String

设置栏目开启关闭查询索引

API地址 : /cmsmanager/channel/setOpenIndex

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelOpens Array
 |-channelId Number 1 栏目ID
 |-open Boolean false 是否开启

响应参数

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

回收站栏目树结构

API地址 : /cmsmanager/channel/recycle/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 该栏目的子集
      |— name String 领导视察2
      |— recycle Boolean true
      |— id Number 773
      |— parentId Number 772
   |— name String 领导视察1 栏目名称
   |— recycle Boolean true 是否删除
   |— id Number 772 栏目id
   |— parentId Null null 栏目父节点
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563413006335
token String

查询已加入回收站的所有栏目的id数组

API地址 : /cmsmanager/channel/recycle/ids

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array [1,713,714,726,727,732,763,772,773,774,775,782,783,792,802,812,813,814,815,822,832,842,843,852,862,863]
   |— 0 Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563420911917
token String

查询该栏目是否拥有工作流

API地址 : /cmsmanager/channel/workflow/being/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->栏目id值

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true->拥有工作流,false->不拥有工作流
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-15 17:07:19
token String

内容通用权限树形结构列表

API地址 : /cmsmanager/channel/content/common/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
operator Number 1-内容查看、2-内容创建、3-内容修改、4-内容发布、5-内容归档、6-内容删除、7-置顶、8-移动、9-排序、10-复制、11-引用、12-内容类型操作、13-内容站群推送、14-内容微博推送、15-内容微信推送
siteId Number 1 站点id(填写则用填写的站点id作为筛选条件,如果不填则用当前站点作为筛选条件)
permOut Boolean false 是否输出内容权限,即:值为true->输出viewContentAble,typeContentAble。。。值为false->不输出viewContentAble。。。(除非业务场景需要否则值为false)
name String 新闻 栏目名称,模糊查询

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— isBottom Boolean 是否根节点
   |— viewContentAble Boolean true 是否可查看内容
   |— typeContentAble Boolean true 是否可操作内容类型
   |— moveContentAble Boolean true 是否可以移动
   |— weiboPushContentAble Boolean true 是否可微博推送
   |— copyContentAble Boolean true 是否可以复制
   |— wechatPushContentAble Boolean true 是否可以微信推送
   |— fileContentAble Boolean true 是否归档
   |— topContentAble Boolean true 是否可置顶
   |— quoteContentAble Boolean true 是否可引用
   |— publishContentAble Boolean true 是否可发布内容
   |— parentId Null null 父级ID
   |— createContentAble Boolean true 是否创建内容
   |— deleteContentAble Boolean true 是否删除内容
   |— sortContentAble Boolean true 是否排序内容
   |— children Array 栏目的子集
      |— isBottom Boolean false 是否根节点
      |— viewContentAble Boolean true
      |— typeContentAble Boolean true
      |— moveContentAble Boolean true
      |— weiboPushContentAble Boolean true
      |— copyContentAble Boolean true
      |— wechatPushContentAble Boolean true
      |— fileContentAble Boolean true
      |— topContentAble Boolean true
      |— quoteContentAble Boolean true
      |— publishContentAble Boolean true
      |— parentId Number 1325
      |— createContentAble Boolean true
      |— deleteContentAble Boolean true
      |— sortContentAble Boolean true
      |— editContentAble Boolean true
      |— name String 图片22
      |— id Number 1331
      |— sitePushContentAble Boolean true
   |— editContentAble Boolean true 是否可以修改内容
   |— name String 图片 栏目名称
   |— id Number 1325 栏目ID
   |— sitePushContentAble Boolean true 是否可以站群推送
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-29 10:33:26
token String

通过模型Id查询渲染字段

API地址 : /cmsmanager/channel/plus/{modelId}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {modelId}->模型id值

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— enableJson Object
      |— formListBase Array
         |— preview String DParentColumnPreview
         |— editor String DParentColumnEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 1
         |— groupIndex Number 1
         |— type String parentColumn
         |— disableFields Array ["label","name","isRequired"]
            |— 0 String label
         |— hiddenFields Array ["options"]
            |— 0 String options
         |— dragable Boolean true
         |— name String 上级栏目
         |— isCustom Boolean false
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean true
            |— isOtherOption Boolean false
            |— isOtherOptionRequired Boolean false
            |— defaultValue String
            |— name String channelParentId
            |— options Array []
            |— tip String
            |— label String 上级栏目
            |— otherOption Object
               |— label String 其他
               |— value Number 999
      |— formListSeo Array []
      |— formListExtend Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-31 09:08:08
token String

发布首页

API地址 : /cmsmanager/content/staticPage/index

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID(为空则默认当前访问站点)

响应参数

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

首页静态化删除

API地址 : /cmsmanager/content/staticPage/index/delete

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID(为空则默认当前访问站点)

响应参数

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

批量栏目静态化

API地址 : /cmsmanager/content/staticPage/channelBatch

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelIds Array 栏目ID数组

响应参数

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

查看栏目静态化进度

API地址 : /cmsmanager/content/staticPage/channel/process

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— currPage Number 10 当前生成的页面数量
   |— totalPage Number 10 需要生成的总页面数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560934085513
token String

删除栏目静态化

API地址 : /cmsmanager/content/staticPage/channel/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelIds Array 栏目ID数组

响应参数

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

批量内容静态化

API地址 : /cmsmanager/content/staticPage/contentBatch

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelIds Array 栏目ID数组

响应参数

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

批量删除内容静态页

API地址 : /cmsmanager/content/staticPage/content/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelIds Array 栏目ID数组

响应参数

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

内容静态化进度

API地址 : /cmsmanager/content/staticPage/content/process

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— currPage Number 7 当前已生成内容数
   |— totalPage Number 7 当前需要生成总内容数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560935868172
token String

设置栏目查询索引开关

API地址 : /cmsmanager/channel/setOpenIndex

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelOpens Array 长度必须大于1
 |-channelId Number 1 栏目ID
 |-open Boolean false 开启 true 关闭false

响应参数

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

修改站点扩展配置

API地址 : /cmsmanager/sites/ext

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改站点扩展配置(默认是传1,否传0)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 站点ID
newContentResourceId Number 1 新内容图标id
watermarkResourceId Number 1 水印图片id
staticPageOssId Number 1 静态页OSS
staticPageFtpId Number 1 静态页FTP
uploadOssId Number 1 上传资源OSS
uploadFtpId Number 1 上传资源FTP
cfg Object 配置对象(键值对形式)
 |-contentLikeLogin String 点赞是否需要登录
 |-commentCycle String 评论周期
 |-contentCommitAllowUpdate String 已发布内容允许编辑
 |-commentAudit String 评论是否需要审核
 |-contentNewFlagDefinition String 新内容标志,资源ID
 |-openMobileStatic String 是否开启手机静态化
 |-openPcStatic String 是否开启PC静态化
 |-uploadAttachmentSuffixType String 允许上传的附件类型1.不限制2.设置允许类型3.设置禁止类型
 |-urlRelative String 是否采用相对路径
 |-commentLink String 链接替换为
 |-staticAutoChannelPage String 发布内容时自动生成栏目静态页-列表页数
 |-staticAutoChannel String 发布内容时自动生成栏目静态页
 |-staticAutoIndex String 发布内容时自动生成首页静态页
 |-watermarkPicture String 水印图片(传资源ID)
 |-contentSaveVersion String 保存内容时自动保存版本
 |-uploadDocumentSuffix String 允许上传的的文档文件类型
 |-uploadDocumentSizeType String 单个文档文件大小限制1.KB,2.MB
 |-uploadDocumentSize String 单个文档文件大小限制
 |-uploadAttachmentSizeType String 单附件文件大小限制1.KB,2.MB
 |-uploadAudioSizeType String 单个音频文件文件大小限制1.KB,2.MB
 |-uploadVideoSizeType String 单视频文件大小限制单位1.KB,2.MB
 |-uploadPicSizeType String 单张图片文件大小限制单位1.KB,2.MB
 |-uploadFileMemory String 上传文件存储服务器
 |-uploadFileMemoryType String 上传文件存储服务器类型local 本地服务器、ftp FTP服务器、oss 云存储
 |-staticServerMemory String 静态文件存储服务器
 |-staticServerMemoryType String 静态文件存储服务器类型 local 本地服务器、ftp FTP服务器、oss 云存储
 |-loginSuccessVisitSite String 1 登录后才能访问站点
 |-channelDisplayContentNumber String 10 内容列表每页默认显示内容数
 |-channelNormalLimitContribute String 栏目默认允许投稿
 |-channelVisitLimitType String 栏目及内容浏览限制类型(1.都不需要登录2.仅内容页需登录 3.都需要登录)
 |-mobileHomePageTemplates String 手机端首页模板
 |-pcHomePageTemplates String PC端首页模板
 |-mobileSolution String 手机端模板方案
 |-pcSolution String PC模板方案
 |-titleRepeat String 1 文档标题重复设置 1允许重复 2站点内不允许重复 3同一栏目下不允许重复
 |-contentAutoSave String 1 是否开启内容自动保存
 |-openContentNewFlag String 1 是否开启新内容标记
 |-contentNewFlagType String 10 新内容定义-单位 1天 2小时
 |-contentNewFlag String 1 新内容定义
 |-watermarkSet String 1 水印设置 1使用图片水印 2使用文字水印 3不使用水印
 |-watermarkPosition String 1 水印位置 1左上 2上 3右上 4左 5中 6右 7左下 8下 9右下
 |-watermarkTxt String jeecms 水印文字
 |-watermarkTxtSize String 15 文字大小
 |-watermarkTxtColour String ###### 文字颜色
 |-watermarkTxtTransparency String 30 文字透明度
 |-channelDisplayList String 1 栏目默认显示在循环列表
 |-channelNameRepeat String 1 栏目名称允许重复
 |-openStatic String 1 是否开启静态化
 |-staticHtmlSuffix String 1 静态文件类型
 |-commentSet String 1 评论设置 1允许游客评论 2允许登录后评论 3不允许评论
 |-commentAllowedLink String 1 评论是否是否允许输入链接
 |-serviceProviders String **** 服务商1.阿里云2.腾讯云
 |-accesskeyId String 213132132112 AccessKeyID / AppID
 |-accesskeySecret String 6546998789sadaewafs6a4f4aerfad4f5a6 AccessKeySecret/AppKey
 |-messageSignatures String 549649a87498d98as98da98w46f56a 短信签名
 |-SMTPService String 127.0.0.1 SMTP 服务器
 |-SMTPPort String 26 SMTP 端口
 |-sendAccount String 1785845785@qq.com 发件账号
 |-emailPassword String 4654654654654 邮箱密码
 |-sslUse String 1 是否使用SSL协议(1使用 0不使用)
 |-memberRedirectAssign String 1 是否指定会员登录成功后跳转至指定地址
 |-memberRedirectUrl String www.baidu.com 会员登录成功后跳转至指定地址
 |-sitePushOpen String 1 是否接受网站群推送
 |-sitePushSecret String 46465465456465qwreqewqe 接受网站群推送密钥
 |-siteAcquOpen String 1 是否允许网站群采集
 |-siteAcquSecret String 588997989sasa5465 网站群采集密钥
 |-openSiteStatistic String 1 是否开启站内统计
 |-openThirdStatistic String 1 是否使用第三方统计
 |-thirdStatisticCode String 第三方统计代码
 |-uploadPicSize String 0 单张图片文件大小限制
 |-uploadPicSuffix String jpg 允许上传的图片文件类型
 |-uploadVideoSize String 0 单视频文件大小限制
 |-uploadVideoSuffix String avi 允许上传的视频文件类型
 |-uploadAudioSize String 0 单的音频文件文件大小限制
 |-uploadAudioSuffix String mp3 允许上传的的音频文件类型
 |-uploadAttachmentSize String 0 单附件文件大小限制
 |-uploadAttachmentSuffix String xml,txt 允许上传的附件类型,多个类型与逗号隔开

响应参数

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

站点详情基本信息

API地址 : /cmsmanager/sites/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 站点详情基本信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— permAssignAble Boolean 是否可权限分配
   |— viewAble Boolean 是否可预览
   |— staticAble Boolean 是否可静态化
   |— openCloseAble Boolean 是否可开启关闭
   |— newChildAble Boolean 是否可新建
   |— editAble Boolean 是否可修改
   |— deleteAble Boolean 是否可删除
   |— previewUrl String 预览地址
   |— url String 浏览地址
   |— alias Array 别名集合
      |— herf String 键值对名称
   |— description String 描述
   |— domain String www.cms3.com 域名
   |— domainAlias String 域名别名
   |— iconPath String 图片地址
   |— id Number 84 站点ID
   |— isOpen Boolean true 站点状态(0未发布1已发布)
   |— name String jeecms子站3 站点名称
   |— nodeSiteIds Array 84 站点结点值(不包含自身)
      |— 0 Number 1
   |— parentId Number 1 父结点
   |— path String path5 资源目录
   |— protocol String http:// 访问协议
   |— seoDescription String seo描述
   |— seoKeyword String seo关键字
   |— seoTitle String seo标题
   |— siteLanguage String zh_cn 语言
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562134342435
token String

新增站点

API地址 : /cmsmanager/sites

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增站点

Header参数

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

请求参数

名称 类型 必填 初始值 说明
parentId Number null 上级站点
name String jspgou主站 站点名称
path String path46798 目录
protocol String http:// 协议
domain String www.sad.com 域名
description String 描述
isOpen Boolean true 站点状态1开启0关闭
seoDescription String SEO描述
seoKeyword String SEO关键字
seoTitle String SEO标题
domainAlias String 域名别名

响应参数

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

修改站点基本信息

API地址 : /cmsmanager/sites

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改站点

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 42 站点ID
parentId Number null 上级站点
name String jspgou主站 站点名称
path String path46798 目录
protocol String http:// 协议
domain String www.jjjj.com 域名
siteLanguage String zh_cn 语言
iconId Number 14 图片ID
description String 描述
isOpen Boolean true 是否开启true开启false关闭
seoDescription String SEO描述
seoKeyword String SEO关键字
seoTitle String SEO标题
domainAlias String 域名别名

响应参数

名称 类型 初始值 说明
code Number 11504
data Null null
message String 站点域名重复或者为空错误
redirectUrl String
requestUrl String
timestamp Number 1555124742286
token String

验证目录

API地址 : /cmsmanager/sites/path/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证目录

Header参数

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

请求参数

名称 类型 必填 初始值 说明
path String 目录
id Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true通过,反之相反
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555125160660
token String

站点回收站

API地址 : /cmsmanager/sites/recycle

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 站点回收站

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 站点ID
   |— name String jspgou主站 站点名称
   |— updateTime Number 1555127205000 删除时间
   |— updateUser String admin 删除人
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555127581202
token String

查询可查看站点全部(树形结构)

API地址 : /cmsmanager/sites/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询全部(树形结构)

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— previewUrl String 预览地址
   |— path String www 站点目录
   |— isOpen Boolean true 是否启用true启用false不启用
   |— children Array
      |— path String path46798 站点目录
      |— isOpen Boolean true 是否启用true启用false不启用
      |— domain String www.jjjj.com 域名
      |— name String jspgou主站22222 站点名称
      |— id Number 52 站点ID
      |— parentId Number 1 父结点ID
   |— domain String www.jeecms.com 域名
   |— name String jeecms主站 站点名称
   |— id Number 1 站点ID
   |— parentId Null null 父结点
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561096360245
token String

扩展配置详情

API地址 : /cmsmanager/sites/ext

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— uploadVideoSuffix Array 视频类型
   |— uploadPicSuffix Array 图片类型
   |— uploadDocumentSuffix Array 文档类型
   |— uploadAudioSuffix Array 音频类型
   |— uploadAttachmentSuffix Array 附件类型
   |— cfg Object 扩展信息
      |— contentLikeLogin String 点赞是否需要登录
      |— watermarkPictureUrl String 水印图片地址
      |— contentNewFlagDefinitionUrl String 新内容标志,资源URL
      |— commentCycle String 评论周期
      |— contentCommitAllowUpdate String 已发布内容允许编辑
      |— commentAudit String 评论是否需要审核
      |— contentNewFlagDefinition String 新内容标志,资源ID
      |— openMobileStatic String 是否开启手机静态化
      |— openPcStatic String 是否开启PC静态化
      |— uploadAttachmentSuffixType String 允许上传的附件类型1.不限制2.设置允许类型3.设置禁止类型
      |— urlRelative String 是否使用相对路径
      |— loginSuccessVisitSite String 登录后才能访问站点
      |— commentLink String 链接替换为
      |— staticAutoChannelPage String 发布内容时自动生成栏目静态页-列表页数
      |— staticAutoChannel String 发布内容时自动生成栏目静态页
      |— watermarkPicture String 水印图片(传资源ID)
      |— staticAutoIndex String 发布内容时自动生成首页静态页
      |— channelVisitLimitType String 栏目及内容浏览限制类型(1.都不需要登录2.仅内容页需登录 3.都需要登录)
      |— contentSaveVersion String 保存内容时自动保存版本
      |— uploadDocumentSuffix Array 允许上传的的文档文件类型
      |— uploadDocumentSizeType String 单个文档文件大小限制1.KB,2.MB
      |— uploadDocumentSize String 单个文档文件大小限制
      |— uploadAttachmentSizeType String 单附件文件大小限制1.KB,2.MB
      |— uploadAudioSizeType String 单个音频文件文件大小限制1.KB,2.MB
      |— uploadVideoSizeType String 单视频文件大小限制单位1.KB,2.MB
      |— uploadPicSizeType String 单张图片文件大小限制单位1.KB,2.MB
      |— channelDisplayList String 1 栏目默认显示在循环列表
      |— uploadPicSuffix Array 允许上传的图片文件类型
      |— emailPassword String emmdatmgppddbjfb 邮箱密码
      |— uploadAttachmentSize String 0 单附件文件大小限制
      |— accesskeySecret String accesskeySecret(测试) AccessKeySecret/AppKey
      |— siteAcquSecret String 网站群采集密钥
      |— uploadAudioSuffix Array 允许上传的的音频文件类型
      |— watermarkSet String 3 水印设置 1使用图片水印 2使用文字水印 3不使用水印
      |— openContentNewFlag String 0 是否开启新内容标记
      |— commentSet String 评论设置 1允许游客评论 2允许登录后评论 3不允许评论
      |— siteAcquOpen String 1 是否允许网站群采集
      |— sendAccount String 321992685@qq.com 发件账号
      |— commentAllowedLink String 0 评论是否允许输入链接
      |— channelNameRepeat String 1 栏目名称允许重复
      |— sslUse String 1 是否使用SSL协议(1使用 0不使用)
      |— memberRedirectAssign String 0 是否指定会员登录成功后跳转至指定地址
      |— watermarkTxt String 水印文字
      |— memberRedirectUrl String 会员登录成功后跳转至指定地址
      |— openThirdStatistic String 0 是否使用第三方统计
      |— watermarkPosition String 水印位置 1左上 2上 3右上 4左 5中 6右 7左下 8下 9右下
      |— contentNewFlag String 新内容定义
      |— uploadFileMemory String 七牛 上传文件存储服务器
      |— pcHomePageTemplates String PC端首页模板
      |— openSiteStatistic String 1 是否开启站内统计
      |— contentNewFlagType String 新内容定义-单位 1天 2小时
      |— uploadFileMemoryType String 1 上传文件存储服务器类型 local 本地服务器、ftp FTP服务器、oss 云存储
      |— serviceProviders String 1 服务商1.阿里云2.腾讯云
      |— channelDisplayContentNumber String 10 内容列表每页默认显示内容数
      |— uploadVideoSuffix Array 允许上传的视频文件类型
      |— uploadVideoSize String 0 单视频文件大小限制
      |— thirdStatisticCode String 第三方统计代码
      |— messageSignatures String 金磊科技(测试) 短信签名
      |— SMTPPort String 465 SMTP 端口
      |— contentAutoSave String 1 是否开启内容自动保存
      |— uploadAttachmentSuffix Array 允许上传的附件类型,多个类型与逗号隔开
      |— titleRepeat String 文档标题重复设置 1允许重复 2站点内不允许重复 3同一栏目下不允许重复
      |— staticServerMemory String local 静态文件存储服务器
      |— watermarkTxtTransparency String 100 文字透明度
      |— uploadPicSize String 0 单张图片文件大小限制
      |— openStatic String 1 是否开启静态化
      |— uploadAudioSize String 0 单个音频文件文件大小限制
      |— watermarkTxtSize String 14 文字大小
      |— mobileSolution String 手机端模板方案
      |— pcSolution String default PC模板方案
      |— watermarkTxtColour String 白色 文字颜色
      |— accesskeyId String accessKey(测试) AccessKeyID / AppID
      |— mobileHomePageTemplates String 手机端首页模板
      |— sitePushSecret String 接受网站群推送密钥
      |— SMTPService String smtp.qq.com SMTP 服务器
      |— staticHtmlSuffix String htm 静态文件类型
      |— sitePushOpen String 1 是否接受网站群推送
   |— cmsSiteExt Object 扩展对象
      |— commentFlowId Number 1 评论工作流id
      |— newContentResourceId Number 1 新内容图标id
      |— staticPageFtpId Number 2 静态页FTP
      |— staticPageOssId Number 2 静态页OSS
      |— uploadFtpId Number 2 上传资源FTP
      |— uploadOssId Number 2 上传资源OSS
   |— id Number 84 站点ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562134470577
token String

默认模板设置详情

API地址 : /cmsmanager/sites/model

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 默认模板设置详情

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 84 站点ID
   |— mobileHomePageTemplates String 手机首页模板
   |— mobileSolution String 手机模板方案
   |— modelTpls Array 模板数据
      |— mobileTplPath String index/index.htm 手机端模板
      |— model Object 模型对象
         |— id Number 2 模型ID
         |— modelName String 视频 模型名称
         |— tplType Number 1 模型类型(1-栏目模型 2-内容模型 3-会员模型)
      |— modelId Number 2 模型ID
      |— pcTplPath String index/index.htm pc端模板
   |— pcHomePageTemplates String 电脑首页模板
   |— pcSolution String 电脑模板方案
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562149236017
token String

修改模板配置

API地址 : /cmsmanager/sites/model

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改模板配置

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 84
cfg Object 扩展信息
 |-mobileHomePageTemplates String 手机端首页模板
 |-pcHomePageTemplates String PC端首页模板
 |-mobileSolution String 手机端模板方案
 |-pcSolution String PC模板方案
modelTpls Array 模型模板数据
 |-mobileTplPath String index/index.htm 手机模板
 |-modelId Number 2 模型ID
 |-pcTplPath String index/index.htm PC模板

响应参数

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

可管理上级站点树

API地址 : /cmsmanager/sites/childs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 可管理上级站点树

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 子节点名称
      |— name String jspgou主站22222 站点名称
      |— id Number 52 站点ID
      |— parentId Number 1 父ID
   |— name String jeecms主站 站点名称
   |— id Number 1 站点ID
   |— parentId Null null 父ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562219320506
token String

模板方案列表

API地址 : /cmsmanager/sites/solutions

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 模板方案列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array ["default"]
   |— 0 String default 方案名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562219420155
token String

首页模板列表

API地址 : /cmsmanager/sites/tpl/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 首页模板列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
solution String 模板方案

响应参数

名称 类型 初始值 说明
code Number 200
data Array ["/default/index/index.html","/default/index/index2.html"]
   |— 0 String /default/index/index.html 模板路径名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562220829976
token String

模板列表

API地址 : /cmsmanager/sites/models

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
solution String 模板方案名称

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— modelId Number 2 模型ID
   |— modelName String 视频 模型名称
   |— tplPath String content/news.html 路径
   |— type Number 2 1栏目模型2内容模型
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562219548780
token String

还原站点

API地址 : /cmsmanager/sites/restore

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 还原站点

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 站点ID集合
 |-0 Number 1

响应参数

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

获取有站群权限的站点树

API地址 : /cmsmanager/sites/getOwnerTree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 获取有站群权限的站点树

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— name String jspgou主站22222
      |— id Number 52
      |— parentId Number 1
   |— name String jeecms主站
   |— id Number 1
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562219320506
token String

可管理站点列表

API地址 : /cmsmanager/sites/ownsite

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 可管理站点列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 站点ID
   |— name String jeecms主站 站点名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563157488971
token String

开启站点

API地址 : /cmsmanager/sites/on

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 开启站点

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [242] 站点ID
 |-0 Number 242

响应参数

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

关闭站点

API地址 : /cmsmanager/sites/off

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 关闭站点

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [242] 站点ID集合
 |-0 Number 242

响应参数

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

可站群推送站点树

API地址 : /cmsmanager/sites/ownsitepush

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 可站群推送站点树

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 子结点数据
      |— name String jeecms子站13 站点名称
      |— id Number 294 站点ID
      |— parentId Number 1 父结点
   |— name String jeecms主站
   |— id Number 1
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-19 14:31:47
token String

站点排序

API地址 : /cmsmanager/sites/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 站点排序

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 573 需要移动站点的id值
toId Number 574 移动到该站点的下方
nextId Number 移动到该站点的上方

响应参数

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

无视权限站点树

API地址 : /cmsmanager/sites/noauth/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 无视权限站点树

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— name String jspgou主站22222 站点名称
      |— id Number 52 id
      |— parentId Number 1 父结点ID
   |— name String jeecms主站
   |— id Number 1
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561096360245
token String

添加目录

API地址 : /cmsmanager/template/dir

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
dirName String channel22 目录名
root String /WEB-INF/t/cms/www 存放路径

响应参数

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

添加模板

API地址 : /cmsmanager/template

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
filename String testwaa 模板名称
root String /WEB-INF/t/cms/www/default/channel 模板路径
source String 在中问 模板内容
models Object [1,2] 模型id数组
 |-0 String 1

响应参数

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

上传模板

API地址 : /cmsmanager/template/upload

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
uploadFile File 模板文件
root String 路径
isCover Boolean true 替换 false 保留

响应参数

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

修改模板

API地址 : /cmsmanager/template

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
filename String testwaa 模板名
root String /WEB-INF/t/cms/www/default 原模板完整路径(包含名称后缀)
source String 在中问111 模板内容
models Array [1,2] 模型数组id
 |-0 Number 1

响应参数

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

删除

API地址 : /cmsmanager/template/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
names Array ["/WEB-INF/t/cms/www/default/channel"] 文件路径数组
 |-0 String /WEB-INF/t/cms/www/default/channel 文件路径

响应参数

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

导入

API地址 : /cmsmanager/template/import

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
uploadFile File 导入的压缩文件
isCover Boolean 是否覆盖(true删除 false保留)

响应参数

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

导出

API地址 : /cmsmanager/template/export

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
solution String default 模板方案

响应参数

名称 类型 初始值 说明

路径下所有文件(树形结构)

API地址 : /cmsmanager/template/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 文件夹下文件数组
      |— directory Boolean true true 文件夹, false 不是文件夹
      |— filename String org 文件名
      |— lastModifiedDate Number 1558339750134 最后修改时间
      |— name String /WEB-INF/t/cms/www/default/org 完整路径
      |— path String /WEB-INF/t/cms/www/default 所在路径
      |— size Number 1 大小
   |— directory Boolean true true 文件夹, false 不是文件夹
   |— filename String default 文件名
   |— lastModifiedDate Number 1558339750134 最后修改时间
   |— name String /WEB-INF/t/cms/www/default 完整路径
   |— root String /WEB-INF/t/cms/www 所在路径
   |— size Number 1 大小
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558340006481
token String

列表文件

API地址 : /cmsmanager/template/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
root String 路径

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— quote Number 1 栏目引用 2内容引用 3首页引用 空没有引用
   |— channels Array
      |— id Number 1312 栏目id
      |— name String 栏目0817 栏目名称
   |— directory Boolean false true 文件夹 false 不是文件夹
   |— filename String news.html 文件名
   |— lastModifiedDate Number 2019-08-17 12:12:15 最后修改时间
   |— name String /WEB-INF/t/cms/www/default/channel/news.html 完整路径
   |— root String /WEB-INF/t/cms/www/default/channel 所属路径
   |— size Number 1 大小
   |— sizeUnit String 1KB 大小
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-17 16:21:18
token String

获取模板内容

API地址 : /cmsmanager/template

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 文件完整路径

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— filename String index.htm 文件名
   |— models Array 1,2
      |— 0 Number 5 模型id
   |— root String /WEB-INF/t/cms/www/defalue/channel/index 所在路径
   |— source String 文件内容
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561604120253
token String

校验文件夹名称

API地址 : /cmsmanager/template/unique/dirName

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
dirName String 文件名
root String 文件路径

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true文件名不存在 false文件名已存在
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561516213246
token String

校验模板方案名

API地址 : /cmsmanager/template/unique/name

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 模板方案名

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 方案名不存在 false 方案名存在
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561516213246
token String

新建目录

API地址 : /cmsmanager/resource/dir

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
dirName String test 文件名
root String www 路径

响应参数

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

新增资源文件

API地址 : /cmsmanager/resource

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fileName String test.css 文件名
source String title{width:50%} 文件内容
root String www 路径

响应参数

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

列表

API地址 : /cmsmanager/resource/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
root String 路径

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— sizeUnit String 大小(带单位)
   |— directory Boolean true true 是文件夹 false 不是文件夹
   |— filename String test 文件名
   |— lastModifiedDate Number 1558341334225 最后修改时间
   |— name String /r/cms/www/test 完整路径
   |— path String /r/cms/www 所在路径
   |— size Number 1 大小
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558342515070
token String

所有文件

API地址 : /cmsmanager/resource/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— child Array
      |— child Array []
      |— directory Boolean false true 是文件夹 false 不是文件夹
      |— filename String test.css 文件名
      |— lastModifiedDate Number 1558343627295 最后修改时间
      |— name String /r/cms/www/aa/test.css 完整路径
      |— path String /r/cms/www/aa 所在路径
      |— size Number 1 大小 (kb)
   |— directory Boolean true true 是文件夹 false 不是文件夹
   |— filename String aa 文件名
   |— lastModifiedDate Number 1558343813331 最后修改时间
   |— name String /r/cms/www/aa 完整路径
   |— path String /r/cms/www 所在路径
   |— size Number 1 大小 (kb)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558343815108
token String

修改

API地址 : /cmsmanager/resource

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fileName String test.css 文件名
source String title{width:50%} 文件内容
root String 原文件全路径

响应参数

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

删除

API地址 : /cmsmanager/resource/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
names Array ["ff","ss"] 文件路径数组
 |-0 String ff

响应参数

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

上传资源文件

API地址 : /cmsmanager/resource/upload

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
uploadFile File 文件
root String 路径
isCover Boolean true 替换 false 保留

响应参数

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

获取文件内容

API地址 : /cmsmanager/resource

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— filename String index.htm 文件名
   |— root String /WEB-INF/t/cms/www/defalue/channel/index 文件所在路径
   |— source String 文件内容
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561604120253
token String

文件夹名称是否唯一

API地址 : /cmsmanager/resource/unique/dir

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
dirName String 文件夹名称
root String 文件夹路径

响应参数

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

分页查询内容类型信息

API地址 : /cmsmanager/contentType/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 分页查询内容类型信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeName String 类型名称
page Number 1 页码
size Number 10 每页条数

响应参数

名称 类型 初始值 说明
code Number 200 返回的装药吗
data Object 返回的数据
   |— content Array 返回的内容
      |— logoResource Object 类型图标资源对象
         |— url String /u/gou/www/201903/08183341elrk.jpg 地址
         |— id String 1 类型图标资源对象ID
      |— logoId Number 1 类型图标资源对象ID
      |— createTime Number 1557035185000 创建时间
      |— createUser String anonymousUser 创建人
      |— id Number 2 内容类型对象ID
      |— typeName String 文本 类型名称
   |— first Boolean true 第一条
   |— last Boolean true 最后一条
   |— size Number 10 大小
   |— totalElements Number 2 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557038081704 时间戳
token String 系统验证token

查询内容类型信息详情

API地址 : /cmsmanager/contentType/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— logoResource Object 类型图标资源对象
      |— url String /u/gou/www/201903/08183341elrk.jpg 地址
      |— id Number 1 类型图标资源对象ID
   |— logoId Number 1 类型图标
   |— createTime Number 1557035185000 创建时间
   |— createUser String anonymousUser 创建人
   |— id Number 2 内容对象ID
   |— typeName String 文本 内容类型名称
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557038788274 时间戳
token String 系统验证token

添加内容类型信息

API地址 : /cmsmanager/contentType

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeName String 新闻 内容类型名称
logoId Number 1 图片资源对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557044494780 时间戳
token String 系统验证token

修改内容类型信息

API地址 : /cmsmanager/contentType

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 45 内容类型对象ID
typeName String 新闻2 内容类型名称
logoId Number 1 图片资源对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557044494780 时间戳
token String 系统验证token

删除内容类型对象信息

API地址 : /cmsmanager/contentType/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [4,5] 内容类型对象ID集合
 |-0 Number 4 内容类型对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557044494780 时间戳
token String 系统验证token

校验类型名称是否可用

API地址 : /cmsmanager/contentType/typeName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeName String 新闻 类型名称
id Number 内容类型id,非必填,在编辑模式下使用为必填项

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Boolean false 返回的信息true表示可用、false表示不可用
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557047359375 时间戳
token String 系统验证token

内容类型列表

API地址 : /cmsmanager/contentType/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— logoResource Object 资源对象
         |— url String /u/gou/www/201903/08183341elrk.jpg 路径
         |— id String 1 资源ID
      |— logoId String 1 资源ID
      |— id Number 2 类型ID
      |— typeName String 文本 类型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557038081704
token String

添加来源管理信息

API地址 : /cmsmanager/sysSource

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
sourceName String 阿里 来源名称
sourceLink String www.alibaba.com 来源链接
isOpenTarget String 1 是否新窗口打开
isDefault String 1 是否默认

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557131736998 时间戳
token String 系统验证token

修改来源信息

API地址 : /cmsmanager/sysSource

请求方式: update

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
sourceName String 阿里update 来源名称
sourceLink String www.alibaba.com 来源链接
isOpenTarget String 1 是否新窗口打开
isDefault String 1 是否默认
id Number 4 来源对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557131736998 时间戳
token String 系统验证token

分页查询来源信息

API地址 : /cmsmanager/sysSource/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 分页查询来源信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
sourceName String 来源名称
page Number 1 页数
size Number 10 每页条数

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的数组
      |— createTime Number 1557131737000 创建时间
      |— createUser String anonymousUser 创建人
      |— id Number 4 来源对象ID
      |— isDefault Boolean true 是否默认
      |— isOpenTarget Boolean true 是否新窗口打开
      |— sourceLink String www.alibaba.com 来源链接
      |— sourceName String 阿里update 来源名称
   |— first Boolean true 第一条
   |— last Boolean true 最后一条
   |— size Number 10 大小
   |— totalElements Number 1 总页数
   |— totalPages Number 1 总条数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557134099285 时间戳
token String 系统验证token

获取来源信息详情

API地址 : /cmsmanager/sysSource/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— createTime Number 1557131632000 创建时间
   |— createUser String anonymousUser 创建人
   |— id Number 2 来源对象ID
   |— isDefault Boolean false 是否默认
   |— isOpenTarget Boolean true 是否新窗口打开
   |— sourceLink String www.jeecms.com 来源链接
   |— sourceName String JEECMS 来源名称
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557134467455 时间戳
token String 系统验证token

删除来源信息

API地址 : /cmsmanager/sysSource/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [2,4] 来源对象ID集合
 |-0 Number 2 来源对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557134634341 时间戳
token String 系统验证token

校验来源名称是否可用

API地址 : /cmsmanager/sysSource/sourceName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
sourceName String 百度 来源名称

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Boolean false 返回的信息(false表示不可用、true表示可用)
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557134776122 时间戳
token String 系统验证token

查询消息模板详情

API地址 : /cmsmanager/messageTpl/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— tplType Number 模板类型(1.会员验证 2.用户消息)
   |— details Array 详细模板对象集合
      |— tplName String 1 短信消息模板id
      |— extendedField String 模板内容支持动态占位符替换,${code}为验证码 扩展字段
      |— id Number 33 详细模板对象ID
      |— isOpen Boolean true 是否开启
      |— mesContent String 尊敬的用户,您申请的会员注册验证码为:${code},5分钟内有效,请勿泄漏于他人! 消息内容
      |— mesTitle String 欢迎您注册JEECMS用户 消息标题
      |— mesTplId Number 33 模型消息对象ID
      |— mesType Number 1 消息类型 1、站内信 2、邮件 3、手机
      |— tplId String 模板id,对手机消息模板设置时需要填的值
   |— id Number 33 模型消息对象ID
   |— mesCode String userLoginValidateCodeTplq 模板唯一标识
   |— mesTitle String 会员注册邮箱验证 模板标题
   |— remark String 会员注册邮箱验证 模板备注
   |— siteId Number 1 站点ID
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1556248397785 时间戳
token String 系统验证token

查询消息模板分页信息

API地址 : /cmsmanager/messageTpl/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
page Number 1 页数
size Number 10 每页的大小
tplType Number 模板类型(1.会员验证 2.用户消息)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的集合
      |— detailsMap Object 消息类型和详情队形的map
         |— letter Object 消息类型(消息类型 letter-站内信、 mail-邮件 、phone-手机)
            |— extendedField String 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 扩展字段
            |— mesContent String 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 消息内容
            |— mesTitle String 12345678901234567890123456789012345678901234567890 标题
            |— tplId String 短信标识
            |— tplName String 短信标识名称
      |— id Number 652 消息模板id
      |— mesCode String 12345618901234567890123456789012345678901234567890 模板唯一标识
      |— mesTitle String 12345678901234567890123456789012345678901234567890 模板标题
      |— openLetter Boolean true 是否开启站内信
      |— openMail Boolean true 是否开启邮箱
      |— openPhone Boolean false 是否开启短信
      |— remark String 12345678901234567890123456789012345678901234567890 模板备注
      |— tplName String 手机模板名称
      |— tplType Number 2 模板类型(1.会员验证 2.用户消息)
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 21
   |— totalPages Number 3
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-28 09:46:38
token String

修改消息模板信息

API地址 : /cmsmanager/messageTpl

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 33 消息模板对象ID
mesCode String userLoginValidateCode 模板唯一标识
mesTitle String 会员注册邮箱验证修改 模板标题
remark String 会员注册邮箱验证 模板备注
details Array 模板详情对象集合
 |-tplName String 模板A 手机模板名称,当消息类型是3时,此值必填
 |-extendedField String 模板内容支持动态占位符替换,${code}为验证码 扩展字段
 |-id Number 33 模板详情对象ID
 |-isOpen Boolean true 是否开启
 |-mesContent String 尊敬的用户,您申请的会员注册验证码为:${code},5分钟内有效,请勿泄漏于他人! 消息内容(邮件消息时必填)
 |-mesTitle String 欢迎您注册JEECMS用户修改 消息标题(邮件消息时必填)
 |-mesTplId Number 33 消息模板对象ID
 |-mesType Number 1 消息类型 1、站内信 2、邮件 3、手机
 |-tplId String 手机模板id,手机消息时必填
tplType Number 模板类型(1.会员验证 2.用户消息

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1556248519241 时间戳
token String 系统验证token

添加消息模板信息

API地址 : /cmsmanager/messageTpl

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
mesCode String userLoginValidateCodeTpl 模板唯一标识
mesTitle String 会员注册邮箱验证 模板标题
remark String 会员注册邮箱验证 模板备注
details Array 模板详情对象集合
 |-tplName String 模板A 手机模板名称,当消息类型是3时,此值必填
 |-tplId String 12312 手机模板id(手机消息时必填)
 |-isOpen Number 1 是否开启
 |-mesType Number 1 消息类型 1、站内信 2、邮件 3、手机
 |-mesTitle String 欢迎您注册JEECMS用户 消息标题(邮件消息时必填)
 |-mesContent String 尊敬的用户,您申请的会员注册验证码为:${code},5分钟内有效,请勿泄漏于他人! 消息内容(邮件消息时必填)
 |-extendedField String 模板内容支持动态占位符替换,${code}为验证码 扩展字段
tplType Number 模板类型(1.会员验证 2.用户消息)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1556248519241 时间戳
token String 系统验证token

校验模板标识是否可用

API地址 : /cmsmanager/messageTpl/mesCode/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
mesCode String userLoginValidateCoderr 模板唯一标识
id Number 模版id,在修改模式下id必填

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Boolean true true表示可用、false表示不可用
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1556250672522 时间戳
token String 系统验证token

查询单个模板详细信息

API地址 : /cmsmanager/messageTpl/mesType/detail

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 消息模板id
mesType Number 1 消息类型(消息类型 1、站内信 2、邮件 3、手机)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— extendedField String 扩展字段
   |— isOpen Boolean true 是否开启 false 不开启 ;true 开启
   |— mesContent String 3 消息内容
   |— mesTitle String 3 标题
   |— mesType Number 2 消息类型(消息类型 1、站内信 2、邮件 3、手机)
   |— tplId String 手机模板id
   |— tplName String 手机模板名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 08:51:28
token String

修改单个模板详情

API地址 : /cmsmanager/messageTpl/details/status

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 261 模板id
mesType Number 2 消息类型(消息类型 1、站内信 2、邮件 3、手机)
open Boolean true 是否开启 false 不开启 ;true 开启
tplDetails Object 消息模板对象
 |-tplId String ABC 短信模板id(当消息类型为短信时此值必填)
 |-tplName String 模板A 短信模板名称(当消息类型为短信时此值必填)
 |-mesTitle String 模板标题 消息标题
 |-mesContent String 模板内容 消息内容
 |-extendedField String 消息模板扩展内容 消息扩展对象

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 10:09:23
token String

是否显示同步子站按钮

API地址 : /cmsmanager/messageTpl/synch/button

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true->显示。false->不显示
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 10:18:31
token String

当前站点的子站树形

API地址 : /cmsmanager/sites/getAllTree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 子站集合
      |— name String 41
      |— id Number 121
      |— parentId Number 112
   |— name String 4 站点名称
   |— id Number 112 站点id
   |— parentId Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 10:53:44
token String

当前短信模板是否有关联的

API地址 : /cmsmanager/messageTpl/have/related

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
tplId String A模板 短信模板id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true->该短信模板有关联无法被删除,false->该短信模板没有关联可以删除
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 11:09:48
token String

短信模板集合

API地址 : /cmsmanager/messageTpl/phone/tpl/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 0 模板id
   |— name String 模板名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 11:09:48
token String

短信是否有余量

API地址 : /cmsmanager/messageTpl/have/number

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true->有数量,false->没数量弹窗提示
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-17 11:09:48
token String

消息模板同步子站

API地址 : /cmsmanager/messageTpl/synch/child/site/tpl

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
childSiteList Array 子站对象集合
 |-siteId Number 91 站点id
 |-siteName String 1 站点名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-20 17:43:22
token String

获取所有站点(所有子站+自身)的id集合

API地址 : /cmsmanager/sites/getAllId

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array [1,91,101,111,112,121]
   |— 0 Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-22 16:44:11
token String

重置索引

API地址 : /cmsmanager/content/resetIndex

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID
siteId Number 站点ID(为空则默认当前访问站点)
releaseTimeStart String 发布时间开始(格式 例如2019-06-05)
releaseTimeEnd String 发布时间结束(格式 例如2019-06-05)

响应参数

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

分页

API地址 : /cmsmanager/jobs/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
cronName String 任务名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime Number 1560396188000 创建时间
      |— createUser String anonymousUser 创建人
      |— cronName String test24 任务名称
      |— cronType Number 4 任务类型(1-发布首页静态页 2-发布栏目静态页 3-发布内容静态页 4-定时数据库备份)
      |— id Number 24 任务id
      |— status Boolean false 任务状态(true 启用 false 不启用)
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 5
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560405828582
token String

新建

API地址 : /cmsmanager/jobs

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 执行方式为执行周期时 间隔周期和间隔时间必填,执行周期为cron表达式时 cron表达式必填

Header参数

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

请求参数

名称 类型 必填 初始值 说明
cronType Number 4 任务类型1-发布首页静态页 2-发布栏目静态页 3-发布内容静态页 4-定时数据库备份)
cronName String test24 任务名称
startTime String 2019-06-13 12:30:00 开始时间
execCycleType Number 1 执行方式(1执行周期2cron表达式)
intervalType Number 1 间隔类型 1-分钟 2-小时 3-天
intervalNum Number 2 间隔时间
status Number true 状态(true 启用 false 不启用)
remark String 备注
channelIds Array 栏目id数组
cron String cron表达式
isAll Boolean 是否所有栏目

响应参数

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

修改

API地址 : /cmsmanager/jobs

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 执行方式为执行周期时 间隔周期和间隔时间必填,执行周期为cron表达式时 cron表达式必填

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 24 任务id
cronType Number 4 任务类型类型(1-发布首页静态页 2-发布栏目静态页 3-发布内容静态页 4-定时数据库备份)
cronName String test24 任务名称
startTime String 2019-06-13 12:30:00 开始时间
execCycleType Number 1 执行方式(1执行周期2cron表达飒飒)
intervalType Number 1 间隔类型 1-分钟 2-小时 3-天
intervalNum Number 2 执行间隔
status Boolean true 状态 true 启用 false 不启用
remark String 备注
channelIds Array 栏目id数组
cron String cron表达式
isAll Boolean 是否所有栏目

响应参数

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

详情

API地址 : /cmsmanager/jobs/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— remark String 备注
   |— channelIds Array [1,2,3,4] 栏目id数组
   |— cron String 0 0/1 * * * ? * cron表达式
   |— cronName String test22 任务名称
   |— cronType Number 4 任务类型类型(1-发布首页静态页 2-发布栏目静态页 3-发布内容静态页 4-定时数据库备份)
   |— execCycleType Number 1 执行类型 1-设置类型 2-cron表达式
   |— id Number 23 任务id
   |— intervalNum Number 1 执行周期
   |— intervalType Number 1 间隔类型 1-分钟 2-小时 3-天
   |— startTime Number 1560389400000 开始时间
   |— status Boolean false 状态(true 启用 false 不启用)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560407481920
token String

取消

API地址 : /cmsmanager/jobs/disabledJobs

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

删除

API地址 : /cmsmanager/jobs/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

启用

API地址 : /cmsmanager/jobs/enabledJobs

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

校验任务名称

API地址 : /cmsmanager/jobs/jobName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
cronName String 任务名称
id String 任务id

响应参数

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

友情链接类别分页

API地址 : /cmsmanager/linkTypes/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 1 友情链接分类id
      |— sortNum Number 1 排序
      |— typeName String 测试用分类 友情链接分类名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560225656883
token String

友情链接类别获取详情

API地址 : /cmsmanager/linkTypes/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}填友情链接类别

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 1 友情链接类别
   |— typeName String 测试用分类 友情链接类别名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560232869421
token String

友情链接类别校验名称是否唯一

API地址 : /cmsmanager/linkTypes/typeName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeName String 测试用分类名称
id Number 测试用分类id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一(可以适用) false 不是唯一的
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560233144233
token String

友情链接类别添加

API地址 : /cmsmanager/linkTypes

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeName String 测试用分类 测试用分类名称

响应参数

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

友情链接类别修改

API地址 : /cmsmanager/linkTypes

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 类别id
typeName String 测试用 类别名称

响应参数

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

友情链接类别删除

API地址 : admin/linkTypes/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

友情链接类别拖动排序

API地址 : /cmsmanager/linkTypes/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 2 拖动元素ID
toId Number 3 拖拽至目标ID

响应参数

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

添加

API地址 : /cmsmanager/links

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
linkTypeId Number 1 友情链接类别id
linkName String 友情链接 友情链接名称
linkUrl String www.friendUri.com 友情链接地址
isEnable Boolean true true 启用 false 不启用
linkLogo String 1 资源id

响应参数

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

修改

API地址 : /cmsmanager/links

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 22 友情链接id
linkTypeId Number 1 友情链接类别id
linkName String 友情链接 友情链接名称
linkUrl String www.friendUri.com 友情链接地址
isEnable Boolean true true 启用 false 不启用
linkLogo String 1 资源id

响应参数

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

分页

API地址 : /cmsmanager/links/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— linkType String test 分类名称
   |— links Object
      |— content Array
         |— id Number 62 友情链接id
         |— isEnable Boolean true ture 启用
         |— linkName String 3213 友情链接名称
         |— linkTypeName String test 分类名称
         |— linkUrl String 321 地址
         |— resourcesSpaceData Object
            |— dimensions String 768*454 分辨率
            |— id Number 11608 资源id
            |— url String /u/cms/www/201908/13160117e4w1.png 资源地址
         |— sortNum Number 2 排序
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 2
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-13 17:38:41
token String

详情

API地址 : /cmsmanager/links/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— linkTypeId String 友情链接分类id
   |— id Number 22 友情链接id
   |— isEnable Boolean true true 启用 false 不启用
   |— linkName String 友情链接 友情链接名称
   |— linkUrl String www.friendUri.com 友情链接地址
   |— resourcesSpaceData Object 资源空间数据
      |— id Number 资源id
      |— dimensions String 1 分辨率
      |— url String /u/cms/test.css 资源路径
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560239388216
token String

删除

API地址 : /cmsmanager/links/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 友情链接id数组
 |-0 Number 1 友情链接id

响应参数

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

拖动排序

API地址 : /cmsmanager/links/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 2 拖动元素ID
toId Number 3 拖拽至目标ID

响应参数

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

启用

API地址 : /cmsmanager/links/enable

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 2 友情链接id

响应参数

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

取消启用

API地址 : /cmsmanager/links/unEnable

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 2 友情链接id

响应参数

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

移动

API地址 : /cmsmanager/links/move

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 需要移动的友情链接id数组
 |-0 Number 1 需要移动的友情链接id
linkTypeId Number 1 类别id

响应参数

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

友情链接类别列表

API地址 : /cmsmanager/linkTypes/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 类别id
   |— typeName String 测试用分类 类别名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560242742301
token String

修改

API地址 : /cmsmanager/iptables

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
isEnable String true true 开启 false 不开启
limitInNetworkModel Number 2 限制内网ip模式(1-不限制 2-设置白名单 3-设置黑名单)
inNetworkIpJsons Array [{ "startIp":"192.168.0.10", "endIp": "192.168.0.30" },{ "startIp":"192.168.1.10", "endIp": "192.168.2.30" }] 内网模式限制号段集,json格式,格式为 [{"startIp":"开始号段","endIp":"结束号段"}]
 |-startIp String 192.168.0.10 开始号段
 |-endIp String 192.168.0.30 结束号段
limitDomain String www.baidu.com 限制访问域名
allowLoginHours String 1,2,3,4,5,6,7,8 允许后台登录时间点,多个用逗号分隔,如:0,1,2,3
allowLoginWeek String 1,2,3,4,5,6 允许后台登录星期,多个是用逗号分隔,如:1,2,3,4,5,6,7

响应参数

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

详情

API地址 : /cmsmanager/iptables

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— allowLoginHours String 1,2,3,4,5,6,7,8 允许后台登录时间点,多个用逗号分隔,如:0,1,2,3
   |— allowLoginWeek String 1,2,3,4,5,6 允许后台登录星期,多个是用逗号分隔,如:1,2,3,4,5,6,7
   |— inNetworkIpJson String [{"endIp":"192.168.0.30","startIp":"192.168.0.10"},{"endIp":"192.168.2.30","startIp":"192.168.1.10"}] 内网模式限制号段集,json格式,格式为 [{"startIp":"开始号段","endIp":"结束号段"}]
   |— isEnable Boolean true 是否开启(0-否 1-是)
   |— limitDomain String www.baidu.com 限制访问域名
   |— limitInNetworkModel Number 2 限制内网ip模式(1-不限制 2-设置白名单 3-设置黑名单)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560417454425
token String

创建工作流

API地址 : /cmsmanager/workflow

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
flow Object 同流程检查接口说明
 |-autoPublish Boolean true
 |-flowCate Number 1
 |-flowJson Object
 |-name String 一票通过会签工作流3
 |-remark String 工作流备注
nodes Array
 |-actions Object
  |-code String
  |-name String
 |-label String 开始
 |-nodeType String begin
 |-shape String beginNode
 |-x Number 180
 |-y Number 135
 |-id String 1
 |-form Object
  |-orgIds String
  |-roleIds String
  |-userIds String
  |-jointlySign Boolean false
  |-jointlyType String
  |-jointlyPassRatio String
edges Array
 |-targetAnchor Number 连线目标锚点
 |-sourceAnchor Number 连线原始锚点
 |-label String 提交审核
 |-source String 1
 |-target String 2
 |-shape String line
 |-nodeType String beginline
 |-id String 1
 |-form Object
  |-allowRevoke Boolean true
  |-autoRevokeHour String
  |-overtimeReminder String
  |- reminderBegin String
  |-reminderInterval String
  |-actionCode String agree
  |-mailNotify Boolean true
  |-smsNotify Boolean true
  |-infoNotify Boolean true
  |-reasonOpen Boolean true
  |-reasonMust Boolean true
 |-labelCfg Object
  |-autoRotate Boolean true
  |-position String top
  |-refY Number 10
  |-refX Number -20

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同流程检查说明
   |— edges Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actionCode String agree
         |— allowRevoke Boolean true
         |— autoRevoke Boolean false
         |— autoRevokeHour Number 48
         |— autoRevokeTime Null null
         |— id String 1
         |— infoNotify Boolean true
         |— mailNotify Boolean true
         |— name String 提交审核
         |— notifyNextUsers Boolean true
         |— overTimeReminder Boolean false
         |— reasonMust Boolean true
         |— reasonOpen Boolean false
         |— reminderBegin Number 24
         |— reminderBeginTime Null null
         |— reminderInterval Number 4
         |— smsNotify Boolean true
      |— id String 1
      |— label String 提交审核
      |— labelCfg Object
         |— autoRotate Boolean true
         |— position String top
         |— refX String -20
         |— refY String 10
      |— nodeType String beginline
      |— shape String line
      |— source String 1
      |— target String 2
   |— errors Array ["存在缺少不通过类型连线的节点"]
      |— 0 String 存在缺少不通过类型连线的节点
   |— flow Object
      |— autoPublish Boolean true
      |— flowCate Number 1
      |— flowJson String {"a":1}
      |— name String 一票通过会签工作流6调整
      |— remark String 工作流备注
      |— siteId Null null
   |— nodes Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actions Array []
         |— id String 1
         |— jointlyPassRatio Null null
         |— jointlySign Boolean false
         |— jointlyType Null null
         |— name String 开始
         |— orgIds Array []
         |— orgOptions Array []
         |— roleIds Array []
         |— roleOptions Array []
         |— userIds Array []
         |— userOptions Array []
      |— id String 1
      |— label String 开始
      |— nodeType String begin
      |— shape String beginNode
      |— x String 180
      |— y String 135
   |— tips Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:03:29
token String

修改工作流

API地址 : /cmsmanager/workflow

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
flow Object 同流程检查接口说明
 |-id Number 工作流id
 |-autoPublish Boolean true
 |-flowCate Number 1
 |-flowJson Object
 |-name String 一票通过会签工作流3
 |-remark String 工作流备注
nodes Array
 |-actions Object
  |-code String
  |-name String
 |-label String 开始
 |-nodeType String begin
 |-shape String beginNode
 |-x Number 180
 |-y Number 135
 |-id String 1
 |-form Object
  |-orgIds String
  |-roleIds String
  |-userIds String
  |-jointlySign Boolean false
  |-jointlyType String
  |-jointlyPassRatio String
edges Array
 |-targetAnchor Number 连线目标锚点
 |-sourceAnchor Number 连线原始锚点
 |-label String 提交审核
 |-source String 1
 |-target String 2
 |-shape String line
 |-nodeType String beginline
 |-id String 1
 |-form Object
  |-allowRevoke Boolean true
  |-autoRevokeHour String
  |-overtimeReminder String
  |- reminderBegin String
  |-reminderInterval String
  |-actionCode String agree
  |-mailNotify Boolean true
  |-smsNotify Boolean true
  |-infoNotify Boolean true
  |-reasonOpen Boolean true
  |-reasonMust Boolean true
 |-labelCfg Object
  |-autoRotate Boolean true
  |-position String top
  |-refY Number 10
  |-refX Number -20

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同流程接口说明
   |— edges Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actionCode String agree
         |— allowRevoke Boolean true
         |— autoRevoke Boolean false
         |— autoRevokeHour Number 48
         |— autoRevokeTime Null null
         |— id String 1
         |— infoNotify Boolean true
         |— mailNotify Boolean true
         |— name String 提交审核
         |— notifyNextUsers Boolean true
         |— overTimeReminder Boolean false
         |— reasonMust Boolean true
         |— reasonOpen Boolean false
         |— reminderBegin Number 24
         |— reminderBeginTime Null null
         |— reminderInterval Number 4
         |— smsNotify Boolean true
      |— id String 1
      |— label String 提交审核
      |— labelCfg Object
         |— autoRotate Boolean true
         |— position String top
         |— refX String -20
         |— refY String 10
      |— nodeType String beginline
      |— shape String line
      |— source String 1
      |— target String 2
   |— errors Array ["存在缺少不通过类型连线的节点"]
      |— 0 String 存在缺少不通过类型连线的节点
   |— flow Object
      |— autoPublish Boolean true
      |— flowCate Number 1
      |— flowJson String {"a":1}
      |— name String 一票通过会签工作流6调整
      |— remark String 工作流备注
      |— siteId Null null
   |— nodes Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actions Array []
         |— id String 1
         |— jointlyPassRatio Null null
         |— jointlySign Boolean false
         |— jointlyType Null null
         |— name String 开始
         |— orgIds Array []
         |— orgOptions Array []
         |— roleIds Array []
         |— roleOptions Array []
         |— userIds Array []
         |— userOptions Array []
      |— id String 1
      |— label String 开始
      |— nodeType String begin
      |— shape String beginNode
      |— x String 180
      |— y String 135
   |— tips Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 15:03:29
token String

流程检查

API地址 : /cmsmanager/workflow/validateRule

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
flow Object 工作流信息
 |-autoPublish Boolean true 终审后自动发布内容
 |-flowCate Number 1 应用场景(1内容)
 |-flowJson Object 流程绘图信息(预留)
 |-name String 一票通过会签工作流3 名称
 |-remark String 工作流备注 备注
nodes Array 节点信息
 |-label String 开始 节点名称
 |-nodeType String begin 节点类型( "begin",开始节点"audit"审核节点"end"结束节点
 |-shape String beginNode 形状
 |-x Number 180 x轴坐标
 |-y Number 135 y轴坐标
 |-id String 1 节点编号
 |-form Object 表单数据
  |-actions Object 节点支持动作
   |-code String 编号(agree通过 disagree不通过 这俩编号类型不可删除)
   |-name String 名称
  |-jointlyPassRatio Number 会签比例
  |-jointlyType Number 会签类型(1一票通过 2一票否决 3比例通过)
  |-jointlySign Boolean false 是否会签节点
edges Array 线条信息
 |-label String 提交审核 线条名称
 |-source String 1 起始节点编号
 |-target String 2 目标节点编号
 |-shape String line 形状
 |-nodeType String beginline "line"其他的线"beginline"连接开始节点的线)
 |-sourceAnchor Number 0 线条起始锚点
 |-targetAnchor Number 1 线条目标锚点
 |-id String 1 线条编号
 |-form Object 线条表单数据
  |-autoRevoke Boolean 开启超时自动驳回
  |-autoRevokeHour Number 流转时长(小时)只能输入0~120之间的正整数
  |-overtimeReminder Boolean 开启超时提醒
  |-reminderBegin Number 开始提醒时间(小时)只能输入0~120之间的正整数;
  |-reminderInterval Number 提醒间隔(小时)只能输入0~120之间的正整数;
  |-actionCode String agree 线条动作编号
  |-allowRevoke Boolean true 是否允许撤回
  |-mailNotify Boolean true 邮件通知
  |-smsNotify Boolean true 短信通知
  |-infoNotify Boolean true 站内消息通知
  |-reasonOpen Boolean true 是否需要输入意见
  |-reasonMust Boolean true 是否意见必填
 |-labelCfg Object 连线配置
  |-autoRotate Boolean true 是否自动旋转
  |-position String top 线条位置标示
  |-refY Number 10 线条位置x轴
  |-refX Number -20 线条位置y轴

响应参数

名称 类型 初始值 说明
code Number 10157
data Object
   |— edges Array
      |— error Boolean false 汇总是否有错误
      |— errors Array [] 汇总错误提示信息
      |— form Object
         |— actionCode String agree
         |— allowRevoke Boolean true
         |— autoRevoke Boolean false
         |— autoRevokeHour Number 48
         |— autoRevokeTime Null null
         |— id String 1
         |— infoNotify Boolean true
         |— mailNotify Boolean true
         |— name String 提交审核
         |— notifyNextUsers Boolean true
         |— overTimeReminder Boolean false
         |— reasonMust Boolean true
         |— reasonOpen Boolean false
         |— reminderBegin Number 24
         |— reminderBeginTime Null null
         |— reminderInterval Number 4
         |— smsNotify Boolean true
      |— id String 1
      |— idCode String 1
      |— label String 提交审核
      |— labelCfg Object
         |— autoRotate Boolean true
         |— position String top
         |— refX String -20
         |— refY String 10
      |— nodeType String beginline
      |— shape String line
      |— source String 1
      |— target String 2
   |— errors Array ["存在缺少不通过类型连线的节点","存在孤立节点"] 线条错误信息
   |— flow Object
      |— autoPublish Boolean true
      |— flowCate Number 1
      |— flowJson String {"a":1}
      |— id Null null
      |— name String 一票通过会签工作流3
      |— remark String 工作流备注
      |— siteId Null null
   |— nodes Array
      |— error Boolean false 节点是否错误
      |— errors Array [] 节点错误信息
      |— form Object
         |— actions Array []
         |— id String 1
         |— jointlyPassRatio Null null
         |— jointlySign Boolean false
         |— jointlyType Null null
         |— name String 开始
         |— orgIds Array []
         |— roleIds Array []
         |— roleOptions Array []
         |— userIds Array []
         |— userOptions Array []
      |— id String 1
      |— idCode String 1
      |— label String 开始
      |— nodeType String begin
      |— shape String beginNode
      |— x String 180
      |— y String 135
   |— tips Array []
message String 工作流规则错误
redirectUrl String
requestUrl String /admin/workflow/validateRule
timestamp String 2019-08-01 17:15:32
token String

工作流分页

API地址 : /cmsmanager/workflow/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
flowCate Number 场景(1内容)
name String 工作流名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— autoPublish Boolean true 是否自动发布内容
      |— flowCate Number 1 场景分类
      |— id Number 132 id
      |— name String 20190803 名称
      |— remark String 备注
      |— updateTime String 2019-08-03 13:42:43 修改时间
      |— updateUser String system 修改人
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 6
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-06 08:32:35
token String

查看详情

API地址 : /cmsmanager/workflow/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object 数据基本同创建说明
   |— edges Array
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actionCode String agree
         |— allowRevoke Boolean true
         |— autoRevoke Boolean false
         |— autoRevokeHour Number 48
         |— autoRevokeTime Null null
         |— id String 1
         |— infoNotify Boolean true
         |— mailNotify Boolean true
         |— name String 提交审核
         |— notifyNextUsers Boolean true
         |— overTimeReminder Boolean false
         |— reasonMust Boolean true
         |— reasonOpen Boolean false
         |— reminderBegin Number 24
         |— reminderBeginTime Null null
         |— reminderInterval Number 4
         |— smsNotify Boolean true
      |— id String 1
      |— idCode String 1
      |— label String 提交审核
      |— labelCfg Null null
      |— nodeType String
      |— shape String line
      |— source String 1
      |— sourceAnchor Number 0
      |— target String 2
      |— targetAnchor Number 1
   |— errors Array []
   |— flow Object
      |— autoPublish Boolean true
      |— flowCate Number 1
      |— flowJson String {"a":1}
      |— id Number 152
      |— name String 一票通过会签工作流6
      |— remark String 工作流备注
      |— siteId Number 1
   |— nodes Array
      |— activity Boolean false
      |— error Boolean false
      |— errors Array []
      |— form Object
         |— actions Array []
         |— id String 1
         |— jointlyPassRatio Null null
         |— jointlySign Boolean false
         |— jointlyType Null null
         |— name String 开始
         |— orgIds Array []
         |— orgOptions Array []
         |— roleIds Array []
         |— roleOptions Array []
         |— userIds Array []
         |— userOptions Array []
      |— id String 1
      |— idCode String 1
      |— label String 开始
      |— nodeType String begin
      |— shape String beginNode
      |— x String 180
      |— y String 135
   |— runTaskCount Number 3
   |— tips Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-06 08:36:02
token String

删除工作流

API地址 : /cmsmanager/workflow//delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [343] id数组
 |-0 Number 343

响应参数

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

工作流不分页列表

API地址 : /cmsmanager/workflow/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 名称
flowCate Number 场景分类
first Number 取值开始值
max Number 取多少条
page_sort_dir String 排序(ASC升序 DESC降序)
page_sort String 排序字段(没有值默认ID降序)
siteId Number 站点id

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— autoPublish Boolean true 是否自动发布内容
   |— flowCate Number 1 分类
   |— id Number 132 id
   |— name String 20190803 名称
   |— remark String 备注
   |— updateTime String 2019-08-03 13:42:43 修改时间
   |— updateUser String system 修改人
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-06 08:32:26
token String

检测工作流名称是否重复

API地址 : /cmsmanager/workflow/exist

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 工作流名称
id Number 工作流ID(修改的时候必填)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true 不存在 false存在
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-23 11:26:48
token String

创建

API地址 : /cmsmanager/auditStrategy

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 文本审核场景1.色情识别2.暴恐识别3.政治敏感4.恶意推广5.低俗辱骂6.低质灌水 图片审核场景1.暴恐违禁2.文本色情3.政治人物识别4.官方违禁库

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 策略名称 策略名称
textScenes Array [1,2] 文本审核场景
 |-0 Number 1
pictureScenes Array [1,2] 图片审核场景
 |-0 Number 1
status Boolean true true开启 false 关闭

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 11:51:29
token String

分页列表

API地址 : /cmsmanager/auditStrategy/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 13
      |— name String 策略名称 策略名称
      |— pictureAuditScene String 色情识别,暴恐识别 图片审核策略详情
      |— status Boolean true true 开启 false 关闭
      |— textAuditScene String 暴恐违禁,文本色情 文本审核策略详情
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 11:54:16
token String

校验名称是否可用

API地址 : /cmsmanager/auditStrategy/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 策略名称
id Number qaX DCRNJM

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true 有效 false 无效
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 13:38:22
token String

获取审核场景

API地址 : /cmsmanager/auditStrategy/scene

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
type Number 1 文本审核场景 2图片审核场景

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— 6 String 低质灌水
   |— 5 String 低俗辱骂
   |— 1 String 色情识别/暴恐违禁
   |— 2 String 暴恐识别/文本色情
   |— 3 String 政治敏感/政治人物识别
   |— 4 String 恶意推广/官方违禁库
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 13:39:37
token String

开启

API地址 : /cmsmanager/auditStrategy/open

请求方式: 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-12-19 11:07:58
token String

关闭

API地址 : /cmsmanager/auditStrategy/close

请求方式: 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-12-19 11:07:58
token String

修改审核策略名称

API地址 : /cmsmanager/auditStrategy/name

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 修改后名称 策略名称
id Number 2

响应参数

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

修改文本审核场景

API地址 : /cmsmanager/auditStrategy/scene/text

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 2
scene Number 1 1.色情识别2.暴恐识别3.政治敏感4.恶意推广5.低俗辱骂6.低质灌水

响应参数

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

修改图片审核场景

API地址 : /cmsmanager/auditStrategy/scene/picture

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 2
scene Number 1 1.暴恐违禁2.文本色情3.政治人物识别4.官方违禁库

响应参数

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

删除

API地址 : /cmsmanager/auditStrategy/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

栏目设置列表

API地址 : /cmsmanager/auditchannelset/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 栏目设置列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— channelSets Array 栏目设置
      |— channelId Number 1753 栏目ID
      |— channelName String 国内 栏目名称
      |— id Number 3 栏目设置ID
      |— isCompel Boolean true 是否强制(true是false不是)
      |— status Boolean true 是否开启(true开启false关闭)
   |— strategyId Number 1 策略ID
   |— strategyName String 测试策略 策略名称
   |— strategyString String 文本:暴恐违禁、文本色情、政治人物识别、恶意推广、低俗辱骂、低质灌水、| 图片:暴恐违禁、文本色情、政治人物识别、恶意推广 策略场景
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:02:37
token String

强制通过

API地址 : /cmsmanager/auditchannelset/pass

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 强制通过

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:18:53
token String

强制不通过

API地址 : /cmsmanager/auditchannelset/nopass

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 强制不通过

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:18:53
token String

开启状态

API地址 : /cmsmanager/auditchannelset/on

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 开启状态

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:18:53
token String

关闭状态

API地址 : /cmsmanager/auditchannelset/off

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 关闭状态

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:18:53
token String

选择栏目详情

API地址 : /cmsmanager/auditchannelset

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 选择栏目详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明
strategyId Number 策略ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— channelId Number 1747 栏目ID
   |— channelName String 新闻 栏目名称
   |— children Array 子集
      |— channelId Number 1752 栏目ID
      |— channelName String 要闻 栏目名称
      |— children Array [] 子集
      |— gray Boolean false 是否置灰,true是,false否
      |— parentId Number 1747 父结点
      |— select Boolean false 是否选中,true是,false否
   |— gray Boolean false 是否置灰,true是,false否
   |— parentId Null null 父结点
   |— select Boolean false 是否选中,true是,false否
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:22:55
token String

保存选择栏目

API地址 : /cmsmanager/auditchannelset

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 保存选择栏目

Header参数

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

请求参数

名称 类型 必填 初始值 说明
strategyId Number 1 策略ID
channels Array [1752,1753,1754] 栏目IDs
 |-0 Number 1752

响应参数

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

删除栏目设置

API地址 : /cmsmanager/auditchannelset/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除栏目设置

Header参数

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

请求参数

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

响应参数

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

内容模型设置列表

API地址 : /cmsmanager/auditmodelset/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容模型设置列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 2 模型设置ID
   |— itemsName String 标题、副标题 模型字段名称
   |— modelId Number 1091 模型ID
   |— modelName String 模型2 模型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:36:32
token String

选择内容模型下拉列表

API地址 : /cmsmanager/auditmodelset/models

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 选择内容模型下拉列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— gray Boolean false 是否置灰
   |— modelId Number 1103 模型ID
   |— modelName String 33333 模型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:45:26
token String

模型设置获取详情

API地址 : /cmsmanager/auditmodelset/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 模型设置获取详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 2 模型设置ID
   |— items Array 字段集合
      |— id Number 2 字段设置ID
      |— modelItemId Number 25472 模型字段ID
   |— modelId Number 1091 模型ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:46:04
token String

添加/修改模型设置

API地址 : /cmsmanager/auditmodelset

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 说明:模型字段ID跟模型字段设置ID需要弄清楚,这里传模型字段ID

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 1091 模型ID
items Array [25472,25473] 模型字段IDs
 |-0 Number 25472

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:55:02
token String

选择内容模型ID查询字段

API地址 : /cmsmanager/auditmodelset/items

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 选择内容模型ID查询字段

Header参数

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

请求参数

名称 类型 必填 初始值 说明
modelId Number 模型ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— field String title 模型字段
   |— id Number 25472 模型字段ID
   |— itemLabel String 标题 模型字段名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-19 09:56:05
token String

评论首页分页列表

API地址 : /cmsmanager/usercomment/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
page Number 1 页码
size Number 每页显示的条数
status Number 1 状态(0-待审核 1-审核通过 2-审核未通过)
isReply Boolean false 回复状态(false-否 true-是)
channelId Number 1 栏目Id
startTime Number 2019-05-11 00:00:00 起始评论时间
endTime Number 2019-05-11 00:00:00 截止评论时间
replyStartTime Number 2019-05-11 00:00:00 起始回复时间
replyEndTime Number 2019-05-11 00:00:00 截止回复时间
fuzzySearch String 192.168 模糊搜索值
userName String sys 评论人名称模糊查询
ip String 192.168.0.4 评论ip模糊查询
commentText String 新闻节点必须好好的对应着 评论内容模糊查询
replytText String 不能如何了解 回复内容模糊查询
title String 股价暴跌 内容标题
isTop Boolean true 是否推荐

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— urlWhole String http://www.jeecms 浏览URL
      |— allNum Number 9 该内容的评论数量
      |— commentText String 你好我这是评论1-1-2 评论内容
      |— content Object 内容对象
         |— channel Object 栏目对象
            |— name String 领导视察12138 栏目名称
         |— id Number 1285 内容id值
         |— title String 正式测试新增 内容标题
      |— createTime Number 1563603487000 发布评论时间
      |— errorReview Number 0 审核失败的数量
      |— id Number 56 评论id值
      |— ip String 0:0:0:0:0:0:0:1 评论ip值
      |— isIpDisable Boolean false ip是否被禁止
      |— reply Boolean true 是否回复
      |— isReport Boolean false 是否被举报
      |— isTop Boolean false 是否推荐
      |— isUserDisable Boolean false 会员是否被禁止
      |— pendingReview Number 0 待审核评论的数量
      |— replyAdminComment Object 回复对象
         |— allNum Null null
         |— commentText String 你好我这是评论1-1
         |— content Object
            |— channel Object
               |— name String 领导视察12138
            |— id Number 1285
            |— title String 正式测试新增
         |— createTime Number 1563603424000
         |— errorReview Null null
         |— id Number 54
         |— ip String 0:0:0:0:0:0:0:1
         |— isIpDisable Boolean false
         |— reply Boolean false
         |— isReport Boolean false
         |— isTop Boolean false
         |— isUserDisable Boolean false
         |— pendingReview Null null
         |— replyComment Null null
         |— replyTime Null null
         |— status Number 1
         |— successReview Null null
         |— user Object
            |— id Number 352
            |— username String Hello
      |— replyTime Number 1563603424000 回复时间
      |— status Number 1 0-待审核 1-审核通过 2-审核未通过
      |— successReview Number 9 审核成功评论的数量
      |— user Object 评论用户对象
         |— id Number 342 用户id值
         |— username String 郭富城 用户的用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563760180853
token String

特定条件分页列表

API地址 : /cmsmanager/usercomment/specific/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 因为是精准查询分页列表所以contentId或者userId,或者precisionIp必须选填一个,否则此分页无价值,返回的参数包括几乎所有的参数,请对应列表页数据进行对应的渲染

Header参数

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

请求参数

名称 类型 必填 初始值 说明
page Number 1 页码
size Number 每页显示的条数
status Number 1 状态(0-待审核 1-审核通过 2-审核未通过)
isReply Boolean false 回复状态(false-否 true-是)
channelId Number 1 栏目Id
startTime Number 2019-05-11 00:00:00 起始评论时间
endTime Number 2019-05-11 00:00:00 截止评论时间
replyStartTime Number 2019-05-11 00:00:00 起始回复时间
replyEndTime Number 2019-05-11 00:00:00 截止回复时间
fuzzySearch String 192.168 模糊搜索值
userName String sys 评论人名称模糊查询
ip String 192.168.0.4 评论ip模糊查询
commentText String 新闻节点必须好好的对应着 评论内容模糊查询
replytText String 不能如何了解 回复内容模糊查询
title String 股价暴跌 内容标题
contentId Number 1 内容Id
userId Number 1 对象Id值
precisionIp String 192.168.0.1 精准查询Ip值
isTop Boolean true 是否推荐

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— urlWhole String http://www.jeecms 浏览URL
      |— commentText String 测试评论1 评论信息
      |— content Object 内容对象
         |— channel Object 栏目对象
            |— name String 领导视察12138 栏目名称
         |— id Number 1285 内容id值
         |— title String 正式测试新增 内容标题
      |— createTime Number 1563433045000 评论时间
      |— id Number 32 评论id值
      |— ip String 0:0:0:0:0:0:0:1 评论ip值
      |— isIpDisable Boolean false 该ip是否被禁止
      |— reply Boolean true 是否回复
      |— isReport Boolean false 是否被举报
      |— isTop Boolean false 是否被推荐
      |— isUserDisable Boolean false 是否被禁止
      |— replyAdminComment Object 回复对象
         |— commentText String 我在测试哦
         |— content Object
            |— channel Object
               |— name String 领导视察12138
            |— id Number 1285
            |— title String 正式测试新增
         |— createTime Number 1563610486000
         |— id Number 82
         |— ip String 0:0:0:0:0:0:0:1
         |— isIpDisable Boolean false
         |— reply Boolean true
         |— isReport Boolean false
         |— isTop Boolean false
         |— isUserDisable Boolean false
         |— replyComment Null null
         |— replyTime Number 1563611084000
         |— status Number 1
         |— user Object
            |— id Number 1
            |— username String system
      |— replyTime Number 1563610486000 回复时间
      |— status Number 1 0-待审核 1-审核通过 2-审核未通过
      |— user Object 评论用户对象
         |— id Number 332 用户id
         |— username String 刘德华 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 7
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563757680535
token String

修改审核状态

API地址 : /cmsmanager/usercomment/status

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [4,5] 评论Id集合
 |-0 Number 4 评论id
status Number 2 1. 审核通过,2. 审核不通过,3. 审核撤回

响应参数

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

回复、修改回复信息

API地址 : /cmsmanager/usercomment/reply

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 5 评论Id
replytText String OK哦 回复详情
isUpdate Boolean true 是否是修改,true->是修改,false->不是修改(说明是新增一个回复)

响应参数

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

删除评论

API地址 : /cmsmanager/usercomment/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [6] 评论Id数组
 |-0 Number 6 评论Id

响应参数

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

新增一个禁止黑名单

API地址 : /cmsmanager/usercomment/plus/stop

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 2 评论Id值
isIp Boolean false 是否是禁止Ip,true-禁止IP,false-禁止用户

响应参数

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

取消一个禁止黑名单

API地址 : /cmsmanager/usercomment/cancel/stop

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 5 评论Id
isIp Boolean true 是否是ip,true解除该评论的IP的禁止,false解除该评论的用户的禁止

响应参数

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

黑名单分页列表

API地址 : /cmsmanager/sysblacklist/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
status Boolean true 状态:true-禁言用户列表,false-禁言ip列表
userName String 数据 禁言用户名,当status为true,此项选填,status为false,此项不可填
ip String 192 禁止ip,当status为false,此项选填,status为true,此项不可填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— userId Number 1 被禁止用户的用户id
      |— createTime Number 1557394323000 被禁言时间
      |— createUser String anonymousUser 禁言操作人
      |— id Number 7 禁言对象id
      |— ip String 禁言ip
      |— user Object 禁言用户对象
         |— integral Number 0 积分
         |— userGroup Object 用户会员组对象
            |— groupName String 研发一组 会员组对象名称
         |— userLevel Object 用户会员等级对象
            |— levelName String 铜牌会员 用户会员等级名称
      |— userName String 大西瓜 用户名
      |— userSiteName String 来源注册站点
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557395767325
token String

查询该禁止用户(ip)的评论列表

API地址 : /cmsmanager/sysblacklist/comment/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->黑名单id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 1 禁言id
   |— createTime Number 1557369150000 禁言时间
   |— createUser String test4 操作人
   |— ip String 被禁言ip
   |— userComments Array 评论列表
      |— commentText String 新闻挺不错的 评论详情
      |— content Object 内容对象
         |— channel Object 栏目对象
            |— name String 新闻 栏目名称
         |— title String 五一假期后首期开盘暴跌 内容标题
      |— createTime Number 1557190815000 评论时间
   |— userName String system 操作人
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557396477481
token String

删除单个黑名单

API地址 : /cmsmanager/sysblacklist/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: ids有且必须只有一个值,填写多个值,也只会对第一个值进行操作

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [7] 黑名单id列表
 |-0 Number 7 黑名单Id

响应参数

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

举报列表

API地址 : /cmsmanager/usercomment/report/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 举报列表中的角标,直接读取userCommentReports集合的数量

Header参数

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

请求参数

名称 类型 必填 初始值 说明
page Number 1 页码
size Number 6 每页的最大条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentText String 测试你妹啊 评论内容
      |— content Object 内容对象
         |— channel Object 栏目对象
            |— name String 栏目名称 栏目名称
         |— title String 测试1 内容标题
      |— createTime Number 1560588255000 评论创建时间
      |— id Number 1 评论id
      |— ip String 192.168.0.1 评论ip
      |— isIpDisable Boolean false ip是否被禁止
      |— isReply Boolean true 是否回复
      |— isReport Boolean true 是否举报
      |— isTop Boolean false 是否推荐
      |— isUserDisable Boolean true 用户是否被禁止
      |— replyTime Number 1560588250000 回复时间
      |— replyUser Object null 回复用户对象
         |— name String 小白兔 用户名称
         |— id Number 1 用户id值
      |— replytText String 我就测试,你不爽打我啊 回复内容
      |— status Number 0 状态(0-待审核 1-审核通过 2-审核未通过)
      |— user Object 评论用户对象
         |— id Number 22 评论用户id
         |— username String 小白图 评论用户名称
      |— userCommentReports Array 举报用户集合
         |— createTime Number 41551111111 创建时间
         |— ip String 166.166.166.2 举报ip
         |— user Object 举报对象
            |— id Number 22 用户id值
            |— username String 小白图 用户名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560589711060
token String

清除评论的举报状态

API地址 : /cmsmanager/usercomment/report/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 评论id数组
 |-0 Number 1 评论id

响应参数

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

评论推荐与取消推荐

API地址 : /cmsmanager/usercomment/top

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 评论id
top Boolean true 是否推荐,true推荐false不推荐

响应参数

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

查询列表数量接口

API地址 : /cmsmanager/usercomment/count

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容id不填则是查举报列表数量

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— channelName String 股票证券 栏目名称,内容id为空时为null
   |— contentName String 美好的世界从证券说起 内容名称,内容id为空时为null
   |— allNum Number 0 全部评论数量
   |— pendingReviewNum Number 0 待审核评论数量
   |— successReviewNum Number 0 审核成功评论数量
   |— errorReviewNum Number 0 审核失败评论数量
   |— reportNum Number 0 举报列表数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563413006335
token String
channelName String 证券股票 栏目名称,内容ID为空时为null
channelName String

同步粉丝

API地址 : /cmsmanager/wechatfans/sync

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 微信公众号appid

响应参数

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

粉丝列表分页

API地址 : /cmsmanager/wechatfans/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 粉丝列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 微信公众号APPID
nickname String 昵称
tagid String 标签ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— fansExt Object 粉丝扩展
         |— topCommentCount Number 精选留言数
         |— mesCount Number 消息数
         |— commentCount Number 留言数
      |— sex Number 0未知1男2女
      |— subscribeTimes String 关注时间
      |— appId String wxc596191fde33119f 公众号APPID
      |— headimgurl String http://thirdwx.qlogo.cn/mmopen/GfXLqLjLcnBFwnZGBOMpLz1JrTYoiaGTBWDbbr1XVy16dunHveFaxPSJtuS4nFCOich5sib4opmVZ7O6St1o6ulvuv8twR8ZNK2/132 头像
      |— id Number 580 粉丝ID
      |— memberId Null null 会员ID
      |— nickname String \u91ca\u5c0f\u4e1c 昵称
      |— openid String owKPNwyVbDLV3tWeoqU8aa2GyCi0 开放ID
      |— subscribeTime Number 1559705983 关注时间
      |— tagidList String 标签名称
      |— username String 用户名
      |— wechatName String jeecms官网 微信名称
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 761
   |— totalPages Number 77
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559805404553
token String

同步多个粉丝

API地址 : /cmsmanager/wechatfans/syncFans

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 同步多个粉丝

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
ids Array [2,3] 粉丝ID集合
 |-0 Number 2

响应参数

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

黑名单

API地址 : /cmsmanager/wechatfans/black

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 黑名单

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
nickname String 用户昵称

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— subscribeTimes String 关注时间
   |— appId String wxc596191fde33119f 公众号APPID
   |— headimgurl String http://thirdwx.qlogo.cn/mmopen/OU2rqvx645vebQ5LnNdWI0Xex7K6aiaeEaan4XFj358osV51kH1zKOiatb9WRxCmX52M0X2YNYcY1QGspeTKtoujk3mk6Fa9t5/132 头像
   |— id Number 1071 粉丝ID
   |— memberId Null null 会员ID
   |— nickname String \u9ec4\u5c0f\u5f3a 昵称
   |— openid String owKPNw9ELFuuO1Tc-CwMw_BgjD6U 开放ID
   |— subscribeTime Number 1534312000 关注时间
   |— tagidList String 100,104,103,2,102, 标签ID集合
   |— username String 用户名
   |— wechatName String jeecms官网 公众号名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559810816377
token String

拉黑粉丝

API地址 : /cmsmanager/wechatfans/black

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 拉黑粉丝

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
ids Array [1316] 粉丝ID集合
 |-0 Number 1316

响应参数

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

取消拉黑粉丝

API地址 : /cmsmanager/wechatfans/cancelblack

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 取消拉黑粉丝

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
ids Array [1316] 粉丝ID集合
 |-0 Number 1316

响应参数

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

粉丝详情

API地址 : /cmsmanager/wechatfans

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 粉丝详情(粉丝开放ID)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
openId String 粉丝openId

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— fansExt Object
      |— commentCount Number 0 留言数
      |— mesCount Number 0 消息数
      |— topCommentCount Number 0 精选留言数
   |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 头像
   |— id Number 2855 粉丝ID
   |— nickname String \u5341\u4e09 昵称
   |— openid String owKPNw4fdTY_9zqlxCG5oMBks7tE 开放ID
   |— subscribeTime Number 1559806411 关注时间
   |— tagidList String 110, 标签ID
   |— username String 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559815008496
token String

发送消息

API地址 : /cmsmanager/wechatfans/send

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 发送消息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
touser String owKPNw4fdTY_9zqlxCG5oMBks7tE 发送用户的openid
msgtype String text 群发的消息类型,图文消息为mpnews,文本消息为text,语音为voice,音乐为music,图片为image,视频为video
content String Hello World 发送文本消息时文本的内容
media_id String 用于群发的消息的media_id

响应参数

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

同步黑名单

API地址 : /cmsmanager/wechatfans/syncblack

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 同步黑名单

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

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

公众号全部标签

API地址 : /cmsmanager/wechattags/app

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— tagList Array
      |— id Number 2 标签ID
      |— tagName String 星标组 标签名称
      |— userCount Number 5 人数
   |— fansSize Number 9 总的粉丝数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559808403601
token String

同步标签

API地址 : /cmsmanager/wechattags/syncTags

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 同步标签

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

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

新建标签

API地址 : /cmsmanager/wechattags

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新建标签

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
tagname String 咪星人 标签名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wxc596191fde33119f 公众号APPID
   |— createTime Number 1559809342199 创建时间
   |— createUser String anonymousUser 创建人
   |— id Number 136 标签ID
   |— tagName String 咪星人 标签名称
   |— updateTime Null 修改时间
   |— updateUser String 修改人
   |— userCount Number 0 人数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559809342204
token String

修改标签

API地址 : /cmsmanager/wechattags

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改标签

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
tagId Number 136 标签ID
tagname String 喵星人 标签名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wxc596191fde33119f 公众号APPID
   |— createTime Number 1559809342199 创建时间
   |— createUser String anonymousUser 创建人
   |— id Number 136 标签ID
   |— tagName String 咪星人 标签名称
   |— updateTime Null null 修改时间
   |— updateUser String 修改人
   |— userCount Number 0 人数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559809342204
token String

检查标签是否存在

API地址 : /cmsmanager/wechattags/check

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 检查标签是否存在

Header参数

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

请求参数

名称 类型 必填 初始值 说明
tagName String 标签名称
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 12531
data Boolean false
message String 标签名称已经存在
redirectUrl String
requestUrl String
timestamp Number 1559809606450
token String

删除标签

API地址 : /cmsmanager/wechattags/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除标签

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
tagId Number 136 标签ID

响应参数

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

设置标签

API地址 : /cmsmanager/wechattags/set

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 设置标签

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
tagids Array [110] 标签ID集合
 |-0 Number 110
ids Array [1316] 粉丝ID集合
 |-0 Number 1316

响应参数

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

粉丝汇总列表

API地址 : /cmsmanager/wechatfans/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 粉丝汇总列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 微信公众号APPID
nickname String 粉丝昵称
tagid String 标签ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— appId String wxc596191fde33119f 微信APPID
      |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 粉丝头像
      |— id Number 2855 粉丝ID
      |— memberId Null null 会员ID
      |— nickname String \u5341\u4e09 粉丝昵称
      |— openid String owKPNw4fdTY_9zqlxCG5oMBks7tE 开放ID
      |— subscribeTime Number 1559806411 关注时间
      |— tagidList String 110, 标签列表
      |— username String 会员账户
      |— wechatName String jeecms官网 公众号名称
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 761
   |— totalPages Number 77
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560137344288
token String

立即群发

API地址 : /cmsmanager/wechatsend/send

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 立即群发

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 微信公众号APPID
tagId Number 134 标签ID,不传发全部
materialId Number 197 素材ID(非微信)

响应参数

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

该公众号本月群发列表

API地址 : /cmsmanager/wechatsend/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 该公众号本月群发列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 34 群发设置ID
   |— material Object 素材对象
      |— mediaUrl String 素材URL
      |— mediaName String 素材名称
      |— tagId Number 标签ID
      |— id Number 197 素材ID
      |— materialId String b6Cd9Eto7paT0inQuta-YHGa1BUp0CdBpN9uKYdHaz4 素材微信ID
      |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
      |— objects Array 具体素材
         |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图片URL
         |— title String 你好世界1 标题
   |— sendDate Number 1560096000000 发送日期
   |— sendHour Number 15 发送小时
   |— sendMinute Number 45 发送分钟
   |— status Number 2 发送状态 1-未发送 2-发送成功 3-发送失败
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560163189866
token String

推送记录

API地址 : /cmsmanager/wechatsend/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 推送记录

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
year Number 年份
month Number 月份
title String 图文标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 34 群发ID
      |— material Object 素材
         |— id Number 197 素材ID
         |— materialId String b6Cd9Eto7paT0inQuta-YHGa1BUp0CdBpN9uKYdHaz4 素材微信ID
         |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
      |— sendDate Number 1560096000000 发送日期
      |— sendHour Number 15 发送小时
      |— sendMinute Number 45 发送分钟
      |— status Number 2 发送状态 1-未发送 2-发送成功 3-发送失败
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560163662298
token String

新增定时群发

API地址 : /cmsmanager/wechatsend

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增定时群发

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxc596191fde33119f 公众号APPID
sendDate String 2019-06-10 发送日期
sendHour Number 16 发送小时
sendMinute Number 55 发送分钟
tagId Number 134 标签ID,不传为全部
materialId Number 197 素材ID(非微信)

响应参数

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

修改群发

API地址 : /cmsmanager/wechatsend

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 53 群发ID
appId String wxc596191fde33119f 公众号APPID
sendDate String 2019-06-10 发送日期
sendHour Number 17 发送小时
sendMinute Number 15 发送分钟
tagId Number 134 标签ID
materialId Number 197 素材ID(非微信)

响应参数

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

删除群发

API地址 : /cmsmanager/wechatsend

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 删除群发

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [53] 群发ID集合
 |-0 Number 53

响应参数

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

推送汇总

API地址 : /cmsmanager/wechatsend/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 推送汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
year Number 年份
month Number 月份
title String 图文标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— appId String 公众号APPID
      |— id Number 34 群发ID
      |— material Object 素材对象
         |— id Number 197 素材ID
         |— materialId String b6Cd9Eto7paT0inQuta-YHGa1BUp0CdBpN9uKYdHaz4 微信素材ID
         |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
         |— objects Array 素材具体
            |— url String 原文地址
            |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图片URL
            |— title String 你好世界1 标题
      |— sendDate Number 1560096000000 发送日期
      |— sendHour Number 15 发送小时
      |— sendMinute Number 45 发送分钟
      |— status Number 2 发送状态 1-未发送 2-发送成功 3-发送失败
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560164466893
token String

群发详情

API地址 : /cmsmanager/wechatsend/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 群发详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wxc596191fde33119f 微信公众号APPID
   |— arrays Array 素材详情
      |— showCoverPic Number 0 是否开启封面
      |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 封面URL
      |— thumbMediaId String b6Cd9Eto7paT0inQuta-YP-lmpmTNT9DKhG0-c2WEWg 素材ID
      |— onlyFansCanComment Number 0 是否只有粉丝评论
      |— author String chenming 作者
      |— digest String 你好我的世界1 摘要
      |— contentSourceUrl String http://www.baicu.com 原文地址
      |— title String 你好世界1 标题
      |— needOpenComment Number 1 是否打开评论
      |— content String 你好的我的世界1 内容
      |— url String http://mp.weixin.qq.com/s?__biz=MzI4NTAzMzkyMA==&mid=500194657&idx=1&sn=f120e6f7aaea5fbc3b089a6fdfb32153&chksm=73d6a9ce44a120d86320d3932dddc0e2016b1c748d38dea7a71baf0a8947bd80851a5a410641#rd 微信内容地址
   |— dateString Number 1560152700000 推送时间
   |— id Number 34 群发ID
   |— pushName String 大富翁 发送对象便签名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-09 15:49:01
token String

群发文章列表

API地址 : /cmsmanager/wechatcomment/articles

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 群发文章列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
year Number 年份
month Number 月份
comment String true 有留言的文章,false 全部文章

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— comments Number 留言条数
   |— article Object 文章对象
      |— id Number 文章ID
      |— open String 是否开启留言,true开启,false关闭
      |— appId String wxc596191fde33119f 公众号APPID
      |— createTime Number 1560152729000 创建时间
      |— msgDataId String 2647678306 群发ID
      |— msgDataIndex Number 0 文章序号
      |— title String 你好世界1 标题
   |— unread Number 3 未读数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560223849738
token String

手动同步

API地址 : /cmsmanager/wechatcomment/hand

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 手动同步

Header参数

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

请求参数

名称 类型 必填 初始值 说明
year Number 年份
month Number 月份
appId String 公众号APPID

响应参数

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

留言列表分页

API地址 : /cmsmanager/wechatcomment/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 留言列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
msgDataId Number 群发ID
msgDataIndex Number 文章序号
commentType Boolean 是否精选评论,true是,false 不是
startTime String 评论开始时间
orderType Number 1.留言时间倒序2.留言时间顺序
comment String 留言内容
endTime String 评论结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array 留言内容
      |— id Number 留言ID
      |— commentTime Number 1560217286000 留言时间
      |— commentType Boolean true true 精选 false 非精选
      |— content String 这是留言 留言内容
      |— replyContent String 回复内容
      |— replyTime Null null 回复时间
      |— wechatFans Object 微信粉丝对象
         |— id Number 粉丝ID
         |— tagidList String 标签列表
         |— username String 用户名
         |— subscribeTimes String 关注时间
         |— openid String openID
         |— fansExt Object 粉丝扩展
            |— topCommentCount Number 精选留言数
            |— mesCount Number 消息数
            |— commentCount Number 留言数
         |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 头像
         |— nickname String \u5341\u4e09 昵称
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560232920813
token String

开启留言设置

API地址 : /cmsmanager/wechatcomment/on

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 开启留言设置

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
msgDataId String 群发ID
msgDataIndex Number 文章序号

响应参数

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

关闭留言设置

API地址 : /cmsmanager/wechatcomment/off

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 关闭留言设置

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
msgDataId String 群发ID
msgDataIndex Number 文章序号

响应参数

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

设为精选

API地址 : /cmsmanager/wechatcomment/markelect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 设为精选

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 留言ID
fansId Number 粉丝ID

响应参数

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

取消精选

API地址 : /cmsmanager/wechatcomment/unmarkelect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 取消精选

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id String 留言ID
fansId Number 粉丝ID

响应参数

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

回复留言

API地址 : /cmsmanager/wechatcomment/reply

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 回复留言

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 72 留言ID
reply String 很好 回复内容

响应参数

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

删除回复

API地址 : /cmsmanager/wechatcomment/reply/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除回复

Header参数

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

请求参数

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

响应参数

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

删除留言

API地址 : /cmsmanager/wechatcomment/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除留言

Header参数

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

请求参数

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

响应参数

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

文章列表

API地址 : /cmsmanager/wechatcomment/articles/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 留言汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
year Number 年份
month Number 月份
comment String 内容
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— article Object
      |— appId String wxc596191fde33119f 公众号APPID
      |— createTime Number 1560152729000 创建时间
      |— msgDataId String 2647678306 群发ID
      |— msgDataIndex Number 0 文章序号
      |— title String 你好世界1 标题
   |— unread Number 0 未读数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560219344068
token String

消息列表分页

API地址 : /cmsmanager/wechatfanssendlog/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 消息列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
startTime String yyyy-MM-DD 开始时间
endTime String 结束时间
black Boolean true 屏蔽黑名单,false 不屏蔽
title String 消息内容
openId String 粉丝openId

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— createUser String 创建人
   |— totalPages String
   |— totalElements Number
   |— size Number
   |— last Boolean
   |— first Boolean
   |— openId String 粉丝的openId
   |— id Number 消息ID
   |— createTime Number 1559720512000 创建时间
   |— fans Object 粉丝对象
      |— tagidList String 标签列表
      |— openid String 开放ID
      |— username String 用户名
      |— subscribeTimes String 关注时间
      |— fansExt Object 粉丝扩展
         |— topCommentCount Number 精选留言数
         |— mesCount Number 消息数
         |— commentCount Number 留言数
      |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 头像
      |— nickname String \u5341\u4e09 昵称
   |— madia Object 素材对象
      |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
      |— content String 力高滨江国际天郡B(南昌市西湖区)
   |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
   |— reply Boolean true 是否已回复
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560237941787
token String

手动刷新

API地址 : /cmsmanager/wechatfanssendlog

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 手动刷新

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
messageId Number 消息最大ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 消息ID
   |— createTime Number 1559720512000 创建时间
   |— fans Object 微信粉丝
      |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 头像
      |— nickname String \u5341\u4e09 昵称
   |— madia Object 素材JSON对象
      |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
      |— label String 力高滨江国际天郡B(南昌市西湖区)
   |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
   |— reply Boolean true 是否已回复
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560237941787
token String

删除消息

API地址 : /cmsmanager/wechatfanssendlog/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除消息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [247] 消息ID集合
 |-0 Number 247

响应参数

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

消息汇总

API地址 : /cmsmanager/wechatfanssendlog/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 消息汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
startTime String 开始时间
endTime String 结束时间
black Boolean 是否黑名单
title String 消息内容

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 消息ID
   |— createTime Number 1559720512000 创建时间
   |— fans Object 粉丝
      |— headimgurl String http://thirdwx.qlogo.cn/mmopen/DPhvPrc1z3dFfUnEyOcVzsEuf6QHJPj0YomHam7oPnhYIZrOWVHUdLOCllI4e0YlRDlQWUwTgDlLJ1oy65h4hbwWDw8n5xWa/132 头像
      |— nickname String \u5341\u4e09 昵称
   |— madia Object 素材json
      |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
      |— label String 力高滨江国际天郡B(南昌市西湖区)
   |— msgType String location 消息类型(text文本,news/mpnews图文,image图片,video视频,link链接,location位置)
   |— reply Boolean true 是否已回复
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560237941787
token String

用户增长

API地址 : /cmsmanager/statistics

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户增长

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— yesterday Object 昨日数据
      |— cancelUser Number 0 取消人数
      |— countUser Number 761 累计关注人数
      |— netGrowthUser Number 0 净关注人数
      |— newUser Number 0 新增人数
   |— today Object 今日数据
      |— cancelUser Number 0 取消人数
      |— countUser Number 761 累计关注人数
      |— netGrowthUser Number 0 净关注人数
      |— newUser Number 0 新增人数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560240809199
token String

趋势图

API地址 : /cmsmanager/statistics/map

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 趋势图

Header参数

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

请求参数

名称 类型 必填 初始值 说明
beginDate String yyyy-MM-dd 开始时间
endDate String yyyy-MM-dd 结束时间
appid String wxc596191fde33119f 公众号APPID
userSource Number 用户来源:0代表其他合计 1代表公众号搜索 17代表名片分享 30代表扫描二维码 43代表图文页右上角菜单 51代表支付后关注(在支付完成页) 57代表图文页内公众号名称 75代表公众号文章广告 78代表朋友圈广告

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— date String 2019-06-04 日期
   |— info Object
      |— cancelUser Number 0 取消关注人数
      |— countUser Number 0 累计人数
      |— netGrowthUser Number 0 净增人数
      |— newUser Number 0 新关注人数
      |— statisticsDate Number 1559577600000 统计日期
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560241118044
token String

用户属性性别

API地址 : /cmsmanager/statistics/sex

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户属性性别

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order Boolean true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion Number 占比
   |— name String 未知 性别名称
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302165057
token String

省份信息分页

API地址 : /cmsmanager/statistics/province

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 省份信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
page Number 页数
size String 数量
order Boolean true升序false降序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— 占比 Number 占比
   |— name String 未知 省份信息
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302165057
token String

城市信息分页

API地址 : /cmsmanager/statistics/city

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 城市信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order Boolean true升序false降序
provinceName String 省级名称
page Number 页数
size String 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion Number 占比
   |— name String 未知 城市信息
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302165057
token String

语言信息

API地址 : /cmsmanager/statistics/lga

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 语言信息

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order String true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion String 占比
   |— name String 未知 语言信息
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302165057
token String

下载表格

API地址 : /cmsmanager/statistics/download

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 下载表格

Header参数

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

请求参数

名称 类型 必填 初始值 说明
beginDate String yyyy-MM-dd 结束日期
endDate String 开始日期
appid String wxc596191fde33119f 公众号APPID

响应参数

名称 类型 初始值 说明

用户增长列表分页

API地址 : /cmsmanager/statistics/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户增长列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String appid
beginDate String 开始日期
endDate String 结束日期
sortType Number 1.日期 2.新关注人数 3.取消关注人数 4.净增关注人数 5.累计关注人数
order Boolean true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— cancelUser Number 1 取消关注
      |— countUser Number 1 累计数
      |— netGrowthUser Number 1 净增人数
      |— newUser Number 1 新关注人
      |— statisticsDates String 2019-08-17 日期
   |— 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-17 17:57:51
token String

省份列表

API地址 : /cmsmanager/statistics/province/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 省份列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— name String 上海 省份名称
   |— number Number 27 人数
   |— proportion Number 0.05 占比
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-09-06 09:35:36
token String

用户增长汇总

API地址 : /cmsmanager/statistics/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户增长汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— yesterday Object 昨日数据
      |— cancelUser Number 0 取消关注
      |— countUser Number 761 累计数
      |— name String jeecms官网 公众号名称
      |— netGrowthUser Number 0 净增人数
      |— newUser Number 0 新关注人数
   |— today Object 今日数据
      |— cancelUser Number 0 取消关注
      |— countUser Number 761 累计数
      |— name String jeecms官网 公众号名称
      |— netGrowthUser Number 0 净增人数
      |— newUser Number 0 新关注人数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302787170
token String

趋势汇总

API地址 : /cmsmanager/statistics/map/collect

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 趋势汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
beginDate String 开始时间
endDate String 结束时间
userSource Number 用户来源:0代表其他合计 1代表公众号搜索 17代表名片分享 30代表扫描二维码 43代表图文页右上角菜单 51代表支付后关注(在支付完成页) 57代表图文页内公众号名称 75代表公众号文章广告 78代表朋友圈广告

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— date String 2019-06-05 日期
   |— info Object 数据
      |— cancelUser Number 0 取消关注数
      |— countUser Number 0 累计数
      |— netGrowthUser Number 0 净关注人数
      |— newUser Number 0 新关注人数
      |— statisticsDate Number 1559664000000 统计日期
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302947692
token String

按公众号查看

API地址 : /cmsmanager/statistics/tencent

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 按公众号查看

Header参数

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

请求参数

名称 类型 必填 初始值 说明
beginDate String 开始时间
endDate String 结束时间
type Number 查询类型1.新增人数 2.取消关注 3.净增人数 4.累计人数
userSource Number 用户来源:0代表其他合计 1代表公众号搜索 17代表名片分享 30代表扫描二维码 43代表图文页右上角菜单 51代表支付后关注(在支付完成页) 57代表图文页内公众号名称 75代表公众号文章广告 78代表朋友圈广告

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appname Array ["美味水果小店","江西实体店打折平台"] 公众号名称集合
      |— 0 String 美味水果小店
   |— array Array 数据集合
      |— date String 2019-06-01 日期
      |— name String 美味水果小店 公众号名称
      |— value Number 0 次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-06 17:35:32
token String

性别汇总

API地址 : /cmsmanager/statistics/sex/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 性别汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order String true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion String 占比
   |— name String 未知 名称
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302185749
token String

省份汇总

API地址 : /cmsmanager/statistics/province/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 省份汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order Boolean true升序false降序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion String 占比
   |— name String 未知 名称
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302185749
token String

城市汇总分页

API地址 : /cmsmanager/statistics/city/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 城市汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String
order Boolean true升序false降序
provinceName String 省级名称
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion String 占比
   |— name String 未知 名称
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302185749
token String

语言汇总

API地址 : /cmsmanager/statistics/lga/collect

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 语言汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 公众号APPID
order String true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— proportion String 占比
   |— name String 未知 名称
   |— number Number 34 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560302185749
token String

用户增长列表分页汇总

API地址 : /cmsmanager/statistics/pageSum

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户增长列表分页汇总

Header参数

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

请求参数

名称 类型 必填 初始值 说明
beginDate String 开始时间
endDate String 结束时间
order String true正序false倒序
sortType Number 1.日期 2.新关注人数 3.取消关注人数 4.净增关注人数 5.累计关注人数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— cancelUser Number 1 取消关注人数
      |— countUser Number 1 累计人数
      |— netGrowthUser Number 1 净增长人数
      |— newUser Number 1 新关注人数
      |— statisticsDates String 2019-08-17 日期
   |— 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-19 09:27:12
token String

调起授权页

API地址 : /weChat/grantAuth

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 如果需要测试,前缀有且必须是真实网址(内网穿透的虚拟网址也可以),前缀不可以是localhost

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点id,必填

响应参数

名称 类型 初始值 说明

查询可管理的公众号、小程序列表

API地址 : /cmsmanager/wechatInfo/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查询公众号、小程序

Header参数

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

请求参数

名称 类型 必填 初始值 说明
type Number 1 状态:1-公众号,2-小程序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— appId String wx794807c47dd36396 公众号、小程序的appId
   |— createTime String 2019-06-19 14:42:19 授权时间
   |— createUser String 授权人
   |— headImg String http://wx.qlogo.cn/mmopen/pvJkDTLugBiaamNSCsz3B1Nibcn3jtdcGactr3zus1AWt1AwYut6YvN2qz5ncjoCVGdYG8Gu8VIT3QiafpCHAWkQ0D2SXziclgUo/0 头像url
   |— id Number 1 公众号、小程序对象id值
   |— isDefaultAuth Boolean false 是否是默认快捷登录账号
   |— isSetAdmin Boolean false 是否是设置管理员
   |— type Number 2 授权方类型 1-公众号 2-小程序
   |— verifyStatus Number 1 认证状态 1-未认证 2-已认证
   |— wechatName String 美味水果小店 公众号、小程序名称
   |— wechatType Number 0 公众号类型 1-普通订阅号(含历史老账号升级后的订阅号) 2-服务号
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 17:21:10
token String

查询单个公众号、小程序

API地址 : /cmsmanager/wechatInfo/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->公众号、小程序的id值

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— isDefaultAuth Boolean true 是否是默认快捷登录账号(此值对在微信号处需要显示)
   |— appId String wx794807c47dd36396 公众号、小程序的appId
   |— createTime Number 1559201657000 授权时间
   |— createUser String 授权人
   |— funcInfo String 17,18,25,30,31,36,37,40, 权限集,多个使用逗号分隔 1.消息管理权限 2.用户管理权限 3.帐号服务权限 4.网页服务权限 5.微信小店权限 6.微信多客服权限 7.群发与通知权限 8.微信卡券权限 9.微信扫一扫权限 10.微信连WIFI权限 11.素材管理权限 12.微信摇周边权限 13.微信门店权限 14.微信支付权限 15.自定义菜单权限 17.帐号管理权限 18.开发管理权限 19.客服消息管理权限
   |— globalId String gh_65797e8412ca 原始ID
   |— grantType Number 1 接入方式 1-授权接入
   |— headImg String http://wx.qlogo.cn/mmopen/pvJkDTLugBiaamNSCsz3B1Nibcn3jtdcGactr3zus1AWt1AwYut6YvN2qz5ncjoCVGdYG8Gu8VIT3QiafpCHAWkQ0D2SXziclgUo/0 头像,图片url
   |— principalName String 个人 公众号/小程序的主体名称
   |— qrcodeUrl String http://mmbiz.qpic.cn/mmbiz_jpg/Nd58dlP11heRiaYg1zhVPp2CJZC4G3k6OG6dR5PiasjtwSlTEzHKJ5Iyz9D30L0ibiaCxauspkuZkL21RED9qc6VIQ/0 二维码图片地址
   |— type Number 2 授权方类型 1-公众号 2-小程序
   |— verifyStatus Number 1 认证状态 1-未认证 2-已认证
   |— wechatName String 美味水果小店 公众号/小程序名称
   |— wechatType Number 0 公众号类型 1-普通订阅号(含历史老账号升级后的订阅号) 2-服务号(如果是小程序无需显示)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560164031038
token String

取消授权公众号、小程序

API地址 : /cmsmanager/wechatInfo/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 此处取消授权,只会影响系统中该公众号、小程序的使用,本身的授权状态无法取消

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [52] 公众号、小程序对象id数组
 |-0 Number 52 公众号、小程序对象id

响应参数

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

设置默认登录授权账号

API地址 : /cmsmanager/wechatInfo/default

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 小程序、公众号对象id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true-数据正确操作正确,false-数据操作
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560166437104
token String

获取小程序最新服务类目

API地址 : /cmsmanager/wechatInfo/category

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 公众号、小程序对象id

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— secondClass String 图片 二级类目名称
   |— secondId Number 302 二级类型ID编号
   |— firstClass String 工具 一级类目名称
   |— thirdId Null null 三级类目ID编号
   |— thirdClass Null null 三级类目名称
   |— firstId Number 287 一级类目ID编号
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560167214888
token String

显示小程序服务器域名

API地址 : /cmsmanager/wechatInfo/displayModifyDomain/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->小程序id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— downloaddomain Array ["https://jspgou.jeecms.com"] downloadFile合法域名list集合
      |— 0 String https://jspgou.jeecms.com downloadFile合法域名
   |— requestdomain Array ["https://jspgou.jeecms.com"] request合法域名list集合
      |— 0 String https://jspgou.jeecms.com request合法域名
   |— uploaddomain Array ["https://jspgou.jeecms.com"] uploadFile合法域名list集合
      |— 0 String https://jspgou.jeecms.com uploadFile合法域名
   |— wsrequestdomain Array ["wss://jspgou.jeecms.com"] socket合法域名list集合
      |— 0 String wss://jspgou.jeecms.com socket合法域名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560168026439
token String

重置小程序服务器域名

API地址 : /cmsmanager/wechatInfo/modifyDomain/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 1. {id}->小程序id 2. 域名前缀有且必须是真实域名或内网穿透虚拟域名

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— downloaddomain Array ["https://www.chenmingit.xyz"] downloadFile合法域名list集合
      |— 0 String https://www.chenmingit.xyz downloadFile合法域名
   |— requestdomain Array ["https://www.chenmingit.xyz"] request合法域名list集合
      |— 0 String https://www.chenmingit.xyz request合法域名
   |— uploaddomain Array ["https://www.chenmingit.xyz"] uploadFile合法域名list集合
      |— 0 String https://www.chenmingit.xyz uploadFile合法域名
   |— wsrequestdomain Array ["wss://www.chenmingit.xyz"] socket合法域名list集合
      |— 0 String wss://www.chenmingit.xyz socket合法域名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560216605257
token String

公众号、小程序添加、修改管理员

API地址 : /cmsmanager/wechatInfo/coreUser

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: userIds

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 72 公众号、小程序id值
userIds Array [14] 用户集合
 |-0 Number 14 用户id

响应参数

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

分页查询公众号、小程序管理员

API地址 : /cmsmanager/wechatInfo/coreUser/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 另一个列表请通过:系统->用户管理->第三方平台管理员列表获取

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 公众号、小程序的id值
username String 小红 用户名/真实姓名
roleid Number 1 角色id
orgId Number 1 组织id值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 24 用户id
      |— org Object 组织对象
         |— name String 研发部 组织名称
      |— roleNames String 角色 角色名称
      |— userExt Object 用户扩展对象
         |— realname String 小红 用户真实姓名
      |— username String ljw 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560224785307
token String

分页查询公众号、小程序

API地址 : /cmsmanager/wechatInfo/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
type Number 1 状态:1-公众号,2-小程序
page Number 1 页码
size Number 1 每页的大小

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— userNames String admin,admin2 管理员用户名字符串
      |— appId String wx8d3c7088ef88a101 公众号、小程序的appId
      |— createTime String 2019-08-12 10:57:49 授权时间
      |— createUser String anonymousUser 授权人
      |— headImg String http://wx.qlogo.cn/mmopen/ajNVdqHZLLCzdEstb2qTcick6j5SXibrAF6YcmzepURI7rl1XJnNFpsYK2wLQLNG6Hh248jibFk3FYvTicdMVepZwvFrMklVd8fp3xTZTF0JnuE/0 头像url
      |— id Number 12 公众号、小程序对象id值
      |— isDefaultAuth Boolean false 是否是默认快捷登录账号
      |— isSetAdmin Boolean false 是否是设置管理员
      |— type Number 1 授权方类型 1-公众号 2-小程序
      |— verifyStatus Number 1 认证状态 1-未认证 2-已认证
      |— wechatName String 江西实体店打折平台 公众号、小程序名称
      |— wechatType Number 1 公众号类型 1-普通订阅号(含历史老账号升级后的订阅号) 2-服务号
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-12 11:40:27
token String

去除权限查询公众号列表

API地址 : /cmsmanager/wechatInfo/noauth/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 去除权限查询公众号列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— appId String wx794807c47dd36396 appid
   |— id Number 1 id
   |— wechatName String 美味水果小店 公众号名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-01 17:21:10
token String

新增永久图文素材

API地址 : /cmsmanager/wechatMaterial/news

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: content->里面的图片类似jspgou一样处理,自主转换

Header参数

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

请求参数

名称 类型 必填 初始值 说明
addNewsRequest Object 新增图文素材对象
 |-articles Array 图文素材集合
  |-title String 你好世界1 图文标题
  |-thumbMediaId String b6Cd9Eto7paT0inQuta-YP-lmpmTNT9DKhG0-c2WEWg 图文消息的封面图片素材id(必须是永久mediaID)
  |-author String chenming 作者
  |-digest String 你好我的世界1 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前64个字。
  |-showCoverPic Number 0 是否显示封面,0即不显示,1即显示(显示在正文中)
  |-content String 你好的我的世界1 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。
  |-contentSourceUrl String http://www.baicu.com 图文消息的原文地址
  |-thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图文素材封面图片的url
  |-needOpenComment Number 1 是否打开评论,0不打开,1打开
  |-onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
appId String wxc596191fde33119f 公众号appId

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— number Number 剩余群发次数
   |— id Number 素材ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-24 18:02:00
token String

新增永久其它素材

API地址 : /cmsmanager/wechatMaterial/material

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx589931544 公众号appid
type String video 上传永久素材类型(图片(image)、语音(voice)
uploadFile File 文件,文件格式大小要求:图片(image): 2M,支持bmp/png/jpeg/jpg/gif格式。 语音(voice):2M,播放长度不超过60s,mp3/wma/wav/amr格式。 视频(video):10MB,支持MP4格式。 缩略图(thumb):64KB,支持JPG格式

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— request Object
      |— name String 24175742s0xd.jpg 素材名称
      |— updateTime String 1563962519981 上传时间
      |— mediaId String AA4mn2UKd6C3GGD6V-uDLy13r5-jGp1ArIC9T7MFol8 微信返回mediaId
      |— url String http://mmbiz.qpic.cn/mmbiz_jpg/4Ex0m2jj4DFZ1WSsCIqFpFR6ibn5c1REZNLcIc07RNctuL5R08Cu1eibAgS4W3gFLunppSdrKKQibvCCbx2ITVHzg/0?wx_fmt=jpeg 图片url
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-24 18:02:00
token String

新增视频永久素材

API地址 : /cmsmanager/wechatMaterial/video

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 支持格式:MP4

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 视频素材标题 视频素材标题
introduction String 视频素材描述 视频素材描述
uploadFile File 文件
appId String wx155545555 公众号appId

响应参数

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

上传图片返回URL

API地址 : /cmsmanager/wechatMaterial/upload/img

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 上传图片返回URL,此处建议在新建永久图文素材时使用

Header参数

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

请求参数

名称 类型 必填 初始值 说明
uploadFile File 文件
appId String wx54555 公众号appId

响应参数

名称 类型 初始值 说明
code Number 200
data String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpWx98eEOAUVCD9G5kGQ2saL8m32A0RJGHba7JiaCq9AVme3YaUaH0KtSh8OAdz7fiaYhJkzicRVKPic8w/0 返回的图片URL
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560237052246
token String

修改永久图文素材

API地址 : /cmsmanager/wechatMaterial/news

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 此处切记: 1. 如果修改的永久图文素材,如果删除了某段图文传入,根本不会删除。 2. 修改永久图文素材,如果传入图文多于修改的图文素材的段数,则会直接报错,提示索引错误,切记。 3. 总结:图文素材修改,修改的素材段数无法更换

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 200 素材id值
news Array 图文素材修改集合
 |-mediaId String b6Cd9Eto7paT0inQuta-YKTXOdB7JY0qTTioPYqoLfY 素材mediaId
 |-index Number 0 要更新的文章在图文消息中的位置(多图文消息时,此字段才有意义),第一篇为0
 |-articles Object 图文素材对象
  |-title String 测试修改1 标题
  |-thumbMediaId String b6Cd9Eto7paT0inQuta-YP-lmpmTNT9DKhG0-c2WEWg 图文消息的封面图片素材id(必须是永久mediaID)
  |-author String chenming 作者
  |-digest String 测试修改1 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空
  |-showCoverPic Number 0 是否显示封面,0为false,即不显示,1为true,即显示
  |-content String 测试修改1 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS
  |-contentSourceUrl String http://www.baicu.com 图文消息的原文地址,即点击“阅读原文”后的URL
  |-needOpenComment Number 1 是否打开评论,0不打开,1打开
  |-onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
 |-thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图文素材封面素材URL

响应参数

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

批量删除永久素材

API地址 : /cmsmanager/wechatMaterial/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
requests Array 要删除的永久素材集合
 |-mediaId String b6Cd9Eto7paT0inQuta-YH7_BTVgfJUTIrcQ6aQlBBg 素材的微信mediaId值
 |-id Number 5 素材的本地id值

响应参数

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

同步永久图文素材

API地址 : /cmsmanager/wechatMaterial/synch/news

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx54885545 公众号appId

响应参数

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

同步其它永久素材

API地址 : /cmsmanager/wechatMaterial/synch/material

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx844221 公众号appId
type String voice 素材类型图片(image)、视频(video)、语音 (voice)

响应参数

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

分页查询永久素材

API地址 : /cmsmanager/wechatMaterial/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 1. 注意返回的时间的格式 2. 此处的查询接口和下方的所有查询接口如果返回的字段有缺失,请联系开发人员,此处的原型参考jspgou处,所以字段可能有所缺失

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx545555 公众号appId
type String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
title String 你好世界 图文标题(如果类型不是news,此检索条件无法生效)
page Number 1 页码
size Number 10 每页最大的容纳数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— wechatUpdateTimes String 2019-01-11 创建时间
      |— id Number 200 素材id
      |— mediaId String b6Cd9Eto7paT0inQuta-YAVaptkCbUQ8p3qrFtIqw7Q 微信返回的素材mediaId
      |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
      |— request Object materialJson转换的JSON对象(查询对象除图文素材外返回)
         |— name String 18629651492419510933028679.jpg 素材名称
         |— updateTime String 1560236664 上传时间
         |— mediaId String b6Cd9Eto7paT0inQuta-YNkEery_ara0pVlwlF1KgWk 微信返回的素材mediaId
         |— url String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpWx98eEOAUVCD9G5kGQ2saLP5iaNMicWzNeiahXdWHApu6ngV6U1O4txYt5Yicf9Y1JMM7SibcVzibz1bOg/0?wx_fmt=jpeg 类型为图片是有返回
      |— requestArray Array materialJson转换的JSON对象(只有图文素材有返回)
         |— showCoverPic Number 0 是否显示封面,0即不显示,1即显示(显示在正文中)
         |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图文素材封面图片的url
         |— thumbMediaId String b6Cd9Eto7paT0inQuta-YP-lmpmTNT9DKhG0-c2WEWg 图文消息的封面图片素材id
         |— onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
         |— author String chenming 作者
         |— digest String 测试修改1 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前64个字。
         |— contentSourceUrl String http://www.baicu.com 图文消息的原文地址
         |— title String 测试修改1 图文标题
         |— needOpenComment Number 0 是否打开评论,0不打开,1打开
         |— content String 测试修改1 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。
         |— url String http://mp.weixin.qq.com/s?__biz=MzI4NTAzMzkyMA==&mid=500194661&idx=1&sn=20b2d211cf4cb4ed103cd6a594a3439f&chksm=73d6a9ca44a120dcdd3a13d4f854b4640cf8076d6e17342c19deee2ff9f8073e9449fa568715#rd 该图文的链接
      |— wechatUpdateTime Number 1560238008 微信服务器返回的修改时间
   |— first Boolean true
   |— last Boolean false
   |— size Number 1
   |— totalElements Number 8
   |— totalPages Number 8
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560242434394
token String

同步服务器图片

API地址 : /cmsmanager/wechatMaterial/synch/img

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx11111 公众号appId
id Number 11 资源id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— request Object
      |— name String 24175742s0xd.jpg 资源名称
      |— updateTime String 1563962519981 上传时间
      |— mediaId String AA4mn2UKd6C3GGD6V-uDLy13r5-jGp1ArIC9T7MFol8 微信返回的mediaId
      |— url String http://mmbiz.qpic.cn/mmbiz_jpg/4Ex0m2jj4DFZ1WSsCIqFpFR6ibn5c1REZNLcIc07RNctuL5R08Cu1eibAgS4W3gFLunppSdrKKQibvCCbx2ITVHzg/0?wx_fmt=jpeg 微信返回的url
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-24 18:02:00
token String

查询单个永久素材

API地址 : /cmsmanager/wechatMaterial/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->素材id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 200 素材id
   |— mediaId String b6Cd9Eto7paT0inQuta-YAVaptkCbUQ8p3qrFtIqw7Q 微信返回的素材mediaId
   |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
   |— request Object materialJson转换的JSON对象(查询对象除图文素材外返回)
      |— name String 18629651492419510933028679.jpg 素材名称
      |— updateTime String 1560236664 上传时间
      |— mediaId String b6Cd9Eto7paT0inQuta-YNkEery_ara0pVlwlF1KgWk 微信返回的素材mediaId
      |— url String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpWx98eEOAUVCD9G5kGQ2saLP5iaNMicWzNeiahXdWHApu6ngV6U1O4txYt5Yicf9Y1JMM7SibcVzibz1bOg/0?wx_fmt=jpeg 类型为图片是有返回
   |— requestArray Array materialJson转换的JSON对象(只有图文素材有返回)
      |— showCoverPic Number 0 是否显示封面,0即不显示,1即显示(显示在正文中)
      |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpVQSTvkyMYMBNgVTOlq3t5HZMVzm7mRNO6Gjj7D5HsicP4uoOSNh3L9xuyGAPtgVIKWSHTQeN3Azaw/0?wx_fmt=jpeg 图文素材封面图片的url
      |— thumbMediaId String b6Cd9Eto7paT0inQuta-YPqGEg3Cf_B7grLc-OWNjW4 图文消息的封面图片素材id
      |— onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
      |— author String chenming 作者
      |— digest String 测试修改1 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前64个字。
      |— contentSourceUrl String http://www.baicu.com 图文消息的原文地址
      |— title String 测试修改1 图文标题
      |— needOpenComment Number 1 是否打开评论,0不打开,1打开
      |— content String 测试修改1 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。
      |— url String http://mp.weixin.qq.com/s?__biz=MzI4NTAzMzkyMA==&mid=500194661&idx=1&sn=20b2d211cf4cb4ed103cd6a594a3439f&chksm=73d6a9ca44a120dcdd3a13d4f854b4640cf8076d6e17342c19deee2ff9f8073e9449fa568715#rd 该图文的链接
   |— wechatUpdateTime Number 1560244067 微信服务器返回的修改时间
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560244736800
token String

下载永久视频素材

API地址 : /cmsmanager/wechatMaterial/dowload/video

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 注:下方返回的视频URL有可能是可以点击下载的,也有可能是可以点击播放的,前缀为http://mp.weixin.qq.com/的视频就是点击播放的,其它的前缀都是可以点击下载的

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data String http://mp.weixin.qq.com/mp/mp/video?__biz=MzI4NTAzMzkyMA==&mid=500194349&sn=60db4f7143c3b5214a8a5471343a5237&vid=h1347ax8bgu&idx=1&vidsn=6d9a4d973433108de11766c9d5dd42d7&fromid=1#rd 返回的视频url
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560245078065
token String

下载永久素材

API地址 : /cmsmanager/wechatMaterial/dowload/material

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 底下返回的切记可能返回视频链接也可能直接返回一个文件流

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
url String http://mp.weixin.qq.com/mp/mp/video?__biz=MzI4NTAzMzkyMA==&mid=500194349&sn=60db4f7143c3b5214a8a5471343a5237&vid=h1347ax8bgu&idx=1&vidsn=6d9a4d973433108de11766c9d5dd42d7&fromid=1#rd 视频链接

新增菜单

API地址 : /cmsmanager/wechatMenu

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
areaCode String 地理区域编码(当menuGroupType为1时此项不可填)
clientDictCode String 客户端版本,当前只具体到系统型号:IOS(1), Android(2),Others(3)(当menuGroupType为1时此项不可填)
languageDictCode String 语言信息,是用户在微信中设置的语言,具体请参考语言表: 1、简体中文 "zh_CN" 2、繁体中文TW "zh_TW" 3、繁体中文HK "zh_HK" 4、英文 "en" 5、印尼 "id" 6、马来 "ms" 7、西班牙 "es" 8、韩国 "ko" 9、意大利 "it" 10、日本 "ja" 11、波兰 "pl" 12、葡萄牙 "pt" 13、俄国 "ru" 14、泰文 "th" 15、越南 "vi" 16、阿拉伯语 "ar" 17、北印度 "hi" 18、希伯来 "he" 19、土耳其 "tr" 20、德语 "de" 21、法语 "fr"(当menuGroupType为1时此项不可填)
menuGroupName String 测试区域 菜单组名称
menuGroupType Number 2 菜单组类型1-默认菜单 2-个性化菜单
sexDictCode Number 1 性别:男(1)女(2)(当menuGroupType为1时此项不可填)
status Number 1 需要新建的菜单组的状态(1- 生效 2-未生效)
tagId Number 对象粉丝标签ID(当menuGroupType为1时此项不可填)
appId String wxc596191fde33119f 微信公众号appId
menuList Array WechatMenu微信菜单集合
 |-childs Array WechatMenu微信菜单子集
  |-choiceType Number 1 1. 发送消息,2.跳转网页,3.扫码,4. 扫码(等待消息),5.立即拍照,6.拍照/相册,7.相册,8.地址位置,9.关联小程序
  |-childs Array [] WechatMenu微信菜单子集
  |-linkUrl String 菜单跳转url(含小程序跳转url),当menuType为view、miniprogram时此项必填
  |-menuKey Number 关键词回复内容(WechatReplyContent)id值,当menuType为click时,此项必填
  |-menuName String 个性化菜单 WechatMenu微信菜单名称
  |-menuType String media_id 菜单的响应动作类型,view表示网页类型,click表示点击类型,miniprogram表示小程序类型,media_id表示为下发素材消息,view_limited表示为跳转图文消息URL
  |-miniprogramAppid String 小程序ID值,当menuType为miniprogram时此项必填
  |-miniprogramPagepath String 小程序的页面路径,当menuType为miniprogram时此项必填
  |-mediaId Number 168 调用新增永久素材接口返回的合法media_id,当menuType为media_id,view_limited时,此项必填
 |-menuName String 图文 WechatMenu微信菜单名称

响应参数

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

修改菜单

API地址 : /cmsmanager/wechatMenu

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 19 菜单组id值
areaCode String 地理区域编码(当menuGroupType为1时此项不可填)
clientDictCode String 客户端版本,当前只具体到系统型号:IOS(1), Android(2),Others(3)(当menuGroupType为1时此项不可填)
languageDictCode String 语言信息,是用户在微信中设置的语言,具体请参考语言表: 1、简体中文 "zh_CN" 2、繁体中文TW "zh_TW" 3、繁体中文HK "zh_HK" 4、英文 "en" 5、印尼 "id" 6、马来 "ms" 7、西班牙 "es" 8、韩国 "ko" 9、意大利 "it" 10、日本 "ja" 11、波兰 "pl" 12、葡萄牙 "pt" 13、俄国 "ru" 14、泰文 "th" 15、越南 "vi" 16、阿拉伯语 "ar" 17、北印度 "hi" 18、希伯来 "he" 19、土耳其 "tr" 20、德语 "de" 21、法语 "fr"(当menuGroupType为1时此项不可填)
menuGroupName String 测试默认菜单 菜单组名称
sexDictCode Number 1 性别:男(1)女(2)(当menuGroupType为1时此项不可填)
status Number 2 需要新建的菜单组的状态(1- 生效 2-未生效)
tagId Number 对象粉丝标签ID(当menuGroupType为1时此项不可填)
menuList Array WechatMenu微信菜单集合
 |-childs Array WechatMenu微信菜单子集
  |-choiceType Number 1 1. 发送消息,2.跳转网页,3.扫码,4. 扫码(等待消息),5.立即拍照,6.拍照/相册,7.相册,8.地址位置,9.关联小程序
  |-childs Array [] WechatMenu微信菜单子集
  |-linkUrl String 菜单跳转url(含小程序跳转url),当menuType为view、miniprogram时此项必填
  |-menuKey Number 关键词回复内容(WechatReplyContent)id值,当menuType为click时,此项必填
  |-menuName String 个性化菜单 WechatMenu微信菜单名称
  |-menuType String media_id 菜单的响应动作类型,view表示网页类型,click表示点击类型,miniprogram表示小程序类型,media_id表示为下发素材消息,view_limited表示为跳转图文消息URL
  |-miniprogramAppid String 小程序ID值,当menuType为miniprogram时此项必填
  |-miniprogramPagepath String 小程序的页面路径,当menuType为miniprogram时此项必填
  |-mediaId Number 168 调用新增永久素材接口返回的合法media_id,当menuType为media_id,view_limited时,此项必填
 |-menuName String 图文 WechatMenu微信菜单名称

响应参数

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

分页查询

API地址 : /cmsmanager/wechatmenugroup/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 此处的查询和下方的查询,如果字段不匹配请联系开发人员,此处返回的所有字段都是jspgou原型返回,

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx4545444 公众号、小程序appId
menuGroupType String 1 菜单组类型1-默认菜单 2-个性化菜单
menuGroupName String 默认菜单组 菜单组名称
page Number 1 页码
size Number 10 每页最大的数据量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— area Object 区域对象
         |— areaName String 北京 区域名称
      |— clientDictCode String 1 显示对象客户端版本 1-IOS, 2-Android,3-Others( 字典类型client_type)
      |— countryName String 显示对象国家
      |— id Number 122 菜单ID值
      |— languageDictCode String 2 语言信息,是用户在微信中设置的语言,具体请参考语言表: 1、简体中文 "zh_CN" 2、繁体中文TW "zh_TW" 3、繁体中文HK "zh_HK" 4、英文 "en" 5、印尼 "id" 6、马来 "ms" 7、西班牙 "es" 8、韩国 "ko" 9、意大利 "it" 10、日本 "ja" 11、波兰 "pl" 12、葡萄牙 "pt" 13、俄国 "ru" 14、泰文 "th" 15、越南 "vi" 16、阿拉伯语 "ar" 17、北印度 "hi" 18、希伯来 "he" 19、土耳其 "tr" 20、德语 "de" 21、法语 "fr"(当menuGroupType为1时此项不可填)
      |— menuGroupName String 推荐 菜单组名称
      |— sexDictCode String 1 显示对象性别 1-男 2-女
      |— status Number 2 菜单组状态(默认菜单组类型中,只允许一组生效菜单) 1- 生效 2-未生效
      |— wTag Object 微信粉丝标签对象
         |— tagName String 内部 标签名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1546915261862
token String

删除菜单

API地址 : /cmsmanager/wechatmenugroup/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 此处如果删除的是个性化菜单则包括微信端的个性化菜单也会被删除

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [6] 菜单组数组
 |-0 Number 6 菜单组id

响应参数

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

查询单个菜单组

API地址 : /cmsmanager/wechatmenugroup/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->菜单组对象

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wxc596191fde33119f 公众号appId
   |— area Object 区域对象
      |— areaCode String 130100 区域code
      |— areaName String 石家庄市 区域名称
      |— parent Object 父级对象
         |— areaCode String 130000
         |— areaName String 河北
         |— parent Null null
   |— clientDictCode String 显示对象客户端版本 1-IOS, 2-Android,3-Others
   |— id Number 25 菜单组id
   |— languageDictCode String 语言信息,是用户在微信中设置的语言,具体请参考语言表: 1、简体中文 "zh_CN" 2、繁体中文TW "zh_TW" 3、繁体中文HK "zh_HK" 4、英文 "en" 5、印尼 "id" 6、马来 "ms" 7、西班牙 "es" 8、韩国 "ko" 9、意大利 "it" 10、日本 "ja" 11、波兰 "pl" 12、葡萄牙 "pt" 13、俄国 "ru" 14、泰文 "th" 15、越南 "vi" 16、阿拉伯语 "ar" 17、北印度 "hi" 18、希伯来 "he" 19、土耳其 "tr" 20、德语 "de" 21、法语 "fr"(当menuGroupType为1时此项不可填)
   |— menuGroupName String 测试个性化菜单2 菜单组名称
   |— menuGroupType Number 2 菜单组类型1-默认菜单 2-个性化菜单
   |— menuId Number 442471085 微信分配的菜单ID
   |— menuList Array WechatMenu微信菜单集合
      |— childs Array WechatMenu微信菜单子集
         |— childs Array [] WechatMenu微信菜单子集
         |— choiceType Number 2 1. 发送消息,2.跳转网页,3.扫码,4. 扫码(等待消息),5.立即拍照,6.拍照/相册,7.相册,8.地址位置,9.关联小程序
         |— id Number 130 菜单id
         |— linkUrl String 菜单跳转url(含小程序跳转url),当menuType为view、miniprogram时此项必填
         |— material Object 微信素材id值
            |— appId String wxc596191fde33119f 素材appId
            |— id Number 168 素材id值
            |— mediaId String b6Cd9Eto7paT0inQuta-YKjKrOPbJNclN1KSV_8QHw0 素材medid_id值
            |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
            |— request Object materialJson转换的JSON对象(查询对象除图文素材外返回)
               |— name String 18629651492419510933028679.jpg 素材名称
               |— updateTime String 1560236664 上传时间
               |— mediaId String b6Cd9Eto7paT0inQuta-YNkEery_ara0pVlwlF1KgWk 微信返回的素材mediaId
               |— url String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpWx98eEOAUVCD9G5kGQ2saLP5iaNMicWzNeiahXdWHApu6ngV6U1O4txYt5Yicf9Y1JMM7SibcVzibz1bOg/0?wx_fmt=jpeg 类型为图片是有返回
            |— requestArray Array materialJson转换的JSON对象(只有图文素材有返回)
               |— showCoverPic Number 1 是否显示封面,0即不显示,1即显示(显示在正文中)
               |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpU5Vva8r7NkibF5sD7zfFnYH8lBxjsyup0xeTAkiaJFpaanwAJ7dicPTVKqO7WzYXVn8yNrPsWjALxNw/0?wx_fmt=jpeg 图文素材封面图片的url
               |— thumbMediaId String b6Cd9Eto7paT0inQuta-YMKnxqvrGmLF2KhuyPDcmi4 图文消息的封面图片素材id
               |— onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
               |— author String hq 作者
               |— digest String 没有了图片新闻 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前64个字。
               |— contentSourceUrl String 图文消息的原文地址
               |— title String 图片内容没有.... 图文标题
               |— needOpenComment Number 0 是否打开评论,0不打开,1打开
               |— content String

没有了图片新闻

图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。
               |— url String http://mp.weixin.qq.com/s?__biz=MzI4NTAzMzkyMA==&mid=500194631&idx=1&sn=6b7713ea96a487b0b28be647b33eec75&chksm=73d6a9e844a120fe4ad63e73be58fdeb2f82f87dce2875c6427aee798c6b7c778e48add98dd3#rd 该图文的链接
         |— menuKey String 菜单点击触发关键词
         |— menuName String 个性化菜单 菜单名称
         |— menuType String media_id 菜单类型 view-网页类型 click-点击类型 miniprogram-小程序类型
         |— miniprogramAppid String 小程序ID
         |— miniprogramPagepath String 小程序的页面路径
         |— wechatReplyContent Object null 回复关键词对象
            |— wechatMaterial Object 素材对象,当消息类型为图文、图片、语音、视频时此对象有返回,返回结构与上方结构类似
            |— title String 标题 音乐标题
            |— thumbMediaId Number 1 略缩图对应的素材ID值
            |— sortNum Number 1 排序值
            |— ruleName String 图文匹配 规则名称
            |— musicUrl String http://www.s 音乐链接
            |— msgType String news 消息类型(text-文本,news-图文 ,image-图片,voice-语音,video-视频,music-音乐)
            |— mediaId Number 854 关键字关联的mediaId值
            |— keyWord String 欢迎 匹配关键字(包括精准、模糊)
            |— id Number 1 回复关键字对象ID值
            |— hqMusicUrll String http://www. 高质量音乐链接
            |— description String 无敌 音乐描述
            |— content String 欢迎你关注jeecms公众号 文本回复内容,当关键字的回复状态为文本是,此值又返回
      |— choiceType Number null 1. 发送消息,2.跳转网页,3.扫码,4. 扫码(等待消息),5.立即拍照,6.拍照/相册,7.相册,8.地址位置,9.关联小程序
      |— id Number 127
      |— linkUrl String
      |— material Null null
      |— menuKey String
      |— menuName String 图文
      |— menuType String
      |— miniprogramAppid String
      |— miniprogramPagepath String
      |— wechatReplyContent Null null
   |— sexDictCode String 1 显示对象性别 1-男 2-女
   |— status Number 1 菜单组状态
   |— tagId Number 对象粉丝标签ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560320529944
token String

修改一个菜单组状态

API地址 : /cmsmanager/wechatmenugroup/status

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 15 菜单组id
status Number 2 菜单组状态(默认菜单组类型中,只允许一组生效菜单) 1- 生效 2-未生效

响应参数

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

同步草稿箱

API地址 : /cmsmanager/miniprogramCode/synch/draft

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

同步模板库

API地址 : /cmsmanager/miniprogramCode/synch/template

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

分页查询

API地址 : /cmsmanager/miniprogramCode/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
codeType String 1 1-草稿箱 2-模板
page Number 1 页码
size Number 1 每页最大的显示数据量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— codeDesc String 小程序 模版描述
      |— codeType Number 2 1-草稿箱 2-模板
      |— codeVersion String v0.0.1 模版版本号
      |— draftId Null null 草稿id(微信返回)
      |— id Number 31 草稿/模板id值(服务器)
      |— isNew Boolean true 模板是否为最新 0-否 1-是
      |— submitTimeStr String 2019/3/22 16:30:57 提交时间
      |— templateId Number 83 模板id(微信返回)
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 6
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560337110808
token String

转换模板

API地址 : /cmsmanager/miniprogramCode/template

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 将草稿转换成模板

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 12 草稿id值(服务器)

响应参数

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

删除模板

API地址 : /cmsmanager/miniprogramCode/template/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 22 模板id值(服务器)

响应参数

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

设置最新模板

API地址 : /cmsmanager/miniprogramCode/template/status

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 22 模板id值(服务器)

响应参数

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

新增体验者

API地址 : /cmsmanager/miniprogrammember

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx794807c47dd36396 小程序appId
wechatId String XJMNIMEI 微信号

响应参数

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

删除体验者

API地址 : /cmsmanager/miniprogrammember/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx794807c47dd36396 小程序appId
id Number 2 体验者id
wechatId String abc714066238 微信号

响应参数

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

查询体验者

API地址 : /cmsmanager/miniprogrammember/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxsss 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— appId String wx794807c47dd36396 小程序appId
   |— createTime Number 1560408052000 创建时间
   |— id Number 23 体验者id
   |— wechatId String XJMNIMEI 微信号
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560408661341
token String

小程序显示按钮

API地址 : /cmsmanager/miniprogramversion/button

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String ws455 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— button Object
      |— 1 Boolean false 显示上传代码按钮
      |— 2 Boolean false 显示提交发布按钮
      |— 3 Boolean false 显示提交审核按钮
      |— 4 Boolean true 撤回审核按钮
      |— 5 Boolean false 重新审核按钮
      |— 6 Boolean false 更新版本提示
      |— 7 Boolean true 是否可以调用二维码
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560475149174
token String

提交代码

API地址 : /cmsmanager/miniprogramversion/submit

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxd5 小程序appId

响应参数

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

获取提交记录

API地址 : /cmsmanager/miniprogramversion/submit/record

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 如果没有失败记录显示的就是版本库中设置的最新版本

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx5452 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— failReason String 代码包太大 错误原因
   |— codeVersion String 1.0.0 版本号
   |— createTime Number 1560331348000 创建时间
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560475540240
token String

提交代码的页面配置

API地址 : /cmsmanager/miniprogramversion/leaf

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx5452 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Array ["pages/index/index","pages/logs/logs","pages/setting/setting","pages/index/index","pages/logs/logs","pages/setting/setting"]
   |— 0 String pages/index/index 代码中的页面配置
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560475712337
token String

小程序可选类目名称

API地址 : /cmsmanager/miniprogramversion/category

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx5452 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— categoryName String 工具>图片 显示小程序可选类目
   |— firstClass String 工具 一级类型名称
   |— firstId Number 287 一级类目id
   |— id Number 0 显示顺序
   |— secondClass String 图片 二级类目名称
   |— secondId Number 302 二级类目id
   |— thirdClass String 三级类目名称
   |— thirdId Null null 三级类目id
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560475821000
token String

提交审核

API地址 : /cmsmanager/miniprogramversion/audit

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
versionDto Array 接受dto集合
 |-address String pages/index/index 页面配置
 |-tag String 时间管理闹钟 小程序标签
 |-title String 首页 小程序标题
 |-categoryDto Object 可选类目dto
  |-categoryName String 工具>信息查询 显示的类目名称
  |-firstClass String 工具 一级类目名称
  |-firstId Number 287 一级类目id
  |-id Number 1 显示顺序值
  |-secondClass String 信息查询 二级类目名称
  |-secondId Number 612 二级类目id
  |-thirdClass String 三级类目名称
  |-thirdId Null null 三级类目id
appId String wx79480 小程序appId

响应参数

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

获取审核记录

API地址 : /cmsmanager/miniprogramversion/audit

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx794807c47 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wxd5ef93b85b5d26c5 小程序appId
   |— auditTime Number 1560424832000 审核时间
   |— codeVersion String 1.0.0 代码版本号
   |— createTime Number 1560407872000 创建时间
   |— failReason String 错误原因
   |— id Number 45 版本id值
   |— status Number 2 状态:1-提交/审核中 2-成功 3-失败
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560476462717
token String

撤销审核

API地址 : /cmsmanager/miniprogramversion/audit/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [52] 要删除的ID数组(只会删除传入的第一个)
 |-0 Number 52 要删除的小程序版本ID

响应参数

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

发布小程序

API地址 : /cmsmanager/miniprogramversion/release

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

获取线上版本

API地址 : /cmsmanager/miniprogramversion/release

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wxd5ef93b 小程序appid

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— action String open 上线版本是否可见:close为不可见,open为可见
   |— appId String wxd5ef93b85b5d26c5 小程序appId
   |— codeVersion String 1.0.0 代码版本号
   |— createTime Number 1560478982000 创建时间
   |— id Number 93 版本id值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560479101994
token String

修改线上版本状态

API地址 : /cmsmanager/miniprogramversion/release/status

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 93 版本id值
action String close 上线版本是否可见:close为不可见,open为可见

响应参数

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

获取体验二维码

API地址 : /cmsmanager/miniprogramversion/qrcode

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx54555 小程序appId

响应参数

名称 类型 初始值 说明
code Number 200
data String /9j/4KKKKKK//2Q== byte数组值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560479988864
token String

新增一个事件(默认/关注)回复)

API地址 : /cmsmanager/wechatreplyclick

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx8d3c7088ef88a101 公众号appId
replyType Number 2 回复类型(1-关注后自动回复 2-默认回复)
wechatReplyContent Object 回复主体对象,如果content不传(不传时要不传一个null,要不就不传,不能传空对象)
 |-content String 测试回复信息 回复信息,传入此值,默认回复文本
 |-mediaId Number 2 回复信息素材id,传入此值根据素材类型自动选择类型

响应参数

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

修改一个事件(默认/关注)回复

API地址 : /cmsmanager/wechatreplyclick

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 33 事件id值
appId String wx8d3c7088ef88a101 公众号appId值
replyType Number 2 回复类型(1-关注后自动回复 2-默认回复)
wechatReplyContent Object 回复主体对象,如果content不传(不传时要不传一个null,要不就不传,不能传空对象)
 |-content String 测试回复信息 回复信息,传入此值,默认回复文本
 |-mediaId Number 2 回复信息素材id,传入此值根据素材类型自动选择类型

响应参数

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

查询单个事件(默认/关注)回复

API地址 : /cmsmanager/wechatreplyclick

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx5455 公众号appId值
replyType Number 1 回复类型(1-关注后自动回复 2-默认回复)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String wx8d3c7088ef88a101 公众号appId
   |— id Number 33 事件回复id值
   |— replyType Number 2 回复类型(1-关注后自动回复 2-默认回复)
   |— wechatReplyContent Object 回复主体实体类
      |— content String 回复的消息内容
      |— msgType String image 消息类型(text-文本,image-图片,voice-音乐,video-视频)
      |— wechatMaterial Object 素材实体类
         |— id Number 1 素材ID值
         |— request Object 素材的json对象
            |— name String 10110147idgt.jpeg 素材名称
            |— updateTime String 1552186922 素材上传时间
            |— mediaId String AA4mn2UKd6C3GGD6V-uDL3Wt9HUx9EMKSFk-FVZGHcQ 微信素材id值
            |— url String http://mmbiz.qpic.cn/mmbiz_jpg/4Ex0m2jj4DEdSMMNMs8w61lgWdTxvTAvpbRONSJA91351VZzHGZKpByO4SkfuqwszfFLhmmtgdtlOSm9qsWt7A/0?wx_fmt=jpeg 图片返回url
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560491208724
token String

删除单个事件(默认/关注)回复

API地址 : /cmsmanager/wechatreplyclick/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [23] id数组
 |-0 Number 23 事件id值

响应参数

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

添加关键字

API地址 : /cmsmanager/keyWord

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 下方的关键字设置,排除了音乐类型,如果发现原型上添加上了音乐类型,请联系开发人员,如果没有请忽略

Header参数

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

请求参数

名称 类型 必填 初始值 说明
keyEq Array ["图文回复"] 关键词(精确匹配)数组
 |-0 String 图文回复
keyLike Array ["模糊匹配"] 关键词(模糊匹配)数组
 |-0 String 模糊匹配
appId String wx8d3c7088ef88a101 公众号appId
wechatReplyContent Object 回复主体对象
 |-content String 你好 回复内容,如果选择文本回复,则此值必填
 |-ruleName String 图文匹配 规则名称
 |-sortNum Number 1 排序值
 |-mediaId Number 219 素材id值
 |-isEnable Boolean false 回复内容,如果选择的不是文本回复,则此值必填

响应参数

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

关键字列表

API地址 : /cmsmanager/keyWord/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 注意:此处的列表不是自动回复中的列表,此处的列表适用于微信菜单管理中的选择

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx544 公众号appId

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— msgType String news 消息类型(text-文本,news-图文 ,image-图片,voice-音乐,video-视频)
   |— replyContentId Number 104 回复主体id值
   |— wordkeyEq String 文本回复 关键字(精准匹配)
   |— wordkeyLike String 关键字(模糊匹配)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560506286740
token String

回复信息分页列表

API地址 : /cmsmanager/wechatreplycontent/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String wx111 公众号appid
searchStr String 回复匹配 检索词

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— content String 文本消息内容
      |— id Number 104
      |— msgType String text
      |— ruleName String 文本匹配
      |— wechatReplyKeywordList Array
         |— wordkeyEq String 文本回复
         |— wordkeyLike String
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560502650337
token String

查询单个自动回复

API地址 : /cmsmanager/wechatreplycontent/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->回复主体id值

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sortNum Number 1 排序值
   |— content String 回复的消息内容
   |— description String 音乐描述
   |— hqMusicUrll String 高质量音乐链接
   |— id Number 113 回复主体id值
   |— isEnable Boolean true 是否启用(0-否 1-是)
   |— mediaId Number 219 素材ID
   |— msgType String news 消息类型(text-文本,news-图文 ,image-图片,voice-音乐,video-视频,music-音乐)
   |— musicUrl String 音乐链接
   |— ruleName String 图文匹配 规则名称
   |— thumbMediaId Null null 缩略图的媒体id
   |— title String 音乐标题
   |— wechatMaterial Object 微信素材对象
      |— wechatUpdateTime Number 1557882296 修改时间
      |— mediaType String news 素材类型图片(image)、视频(video)、语音 (voice)、图文(news)
      |— request Object materialJson转换的JSON对象(查询对象除图文素材外返回)
         |— name String 18629651492419510933028679.jpg 素材名称
         |— updateTime String 1560236664 上传时间
         |— mediaId String b6Cd9Eto7paT0inQuta-YNkEery_ara0pVlwlF1KgWk 微信返回的素材mediaId
         |— url String http://mmbiz.qpic.cn/mmbiz_jpg/gvCYlALaZpWx98eEOAUVCD9G5kGQ2saLP5iaNMicWzNeiahXdWHApu6ngV6U1O4txYt5Yicf9Y1JMM7SibcVzibz1bOg/0?wx_fmt=jpeg 类型为图片是有返回
      |— requestArray Array 是否显示封面,0即不显示,1即显示(显示在正文中)
         |— showCoverPic Number 0 是否显示封面,0即不显示,1即显示(显示在正文中)
         |— thumbMediaUrl String http://mmbiz.qpic.cn/mmbiz_jpg/4Ex0m2jj4DG348h2ozfoYcf3QFOuX0ibicNRDt56jqoX21QH6libgnzGS1b2D9XUWLv9My1gPZpIMY4famqLSjWMQ/0?wx_fmt=jpeg 图文素材封面图片的url
         |— thumbMediaId String AA4mn2UKd6C3GGD6V-uDL3s2ROFK_Zv7LJn3ZJxyMNk 图文消息的封面图片素材id
         |— onlyFansCanComment Number 0 是否粉丝才可评论,0所有人可评论,1粉丝才可评论
         |— author String 1 作者
         |— digest String 一年四季没有比冬天更深沉,更厚实,更有意境了,有谁能比冬天这样的使人冷静,使人清醒,使人激奋!走进冬天,让我 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前64个字。
         |— contentSourceUrl String 图文消息的原文地址
         |— title String 123 图文标题
         |— needOpenComment Number 0 是否打开评论,0不打开,1打开
         |— content String 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。
         |— url String http://mp.weixin.qq.com/s?__biz=MzIyNjIxOTgwNg==&mid=100000070&idx=1&sn=50623ed942a71f51d6c265d671ae2acc&chksm=687283375f050a211fd8fbbc9a116986ce044eaaa2b60764e8d8786eac5d2223304c416e2a08#rd 该图文的链接
   |— wechatReplyKeywordList Array 关键词对象
      |— wordkeyEq String 图文回复 关键词(精确匹配)
      |— wordkeyLike String 关键词(模糊匹配)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560500344688
token String

修改自动回复

API地址 : /cmsmanager/wechatreplycontent

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
keyEq Array ["图文回复"] 关键词(精准匹配)数组
 |-0 String 图文回复
keyLike Array ["模糊匹配"] 关键词(模糊匹配)数组
 |-0 String 模糊匹配
appId String wx8d3c7088ef88a101 公众号appid
wechatReplyContent Object 回复内容,如果选择文本回复,则此值必填
 |-content String 内容 回复内容,如果选择文本回复,则此值必填
 |-id Number 113 回复内容id值
 |-ruleName String 图文匹配 规则名称
 |-mediaId Number 219 排序值
 |-isEnable Boolean false 素材id值
 |-sortNum Number 1 回复内容,如果选择的不是文本回复,则此值必填

响应参数

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

删除单个自动回复

API地址 : /cmsmanager/wechatreplycontent/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [153] 回复主体id数组
 |-0 Number 153 回复主体id值

响应参数

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

微信推送预览

API地址 : /cmsmanager/contentext/preview

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 微信推送预览

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appid String wxc596191fde33119f 微信APPID
contentIds Array [152,162] 内容IDs
 |-0 Number 152

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— sengNumber Number 剩余群发次数
   |— appId String wxc596191fde33119f 微信APPID
   |— author String admin 作者
   |— content String 内容
   |— cover String 封面地址
   |— picId Null null 图片ID
   |— sourceUrl String /www/m/ldscnew/20190521/152.html 原创链接
   |— title String 你好我的世界 标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 13:53:13
token String

推送到微信

API地址 : /cmsmanager/contentext/push

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 推送到微信

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appid String wxc596191fde33119f 公众号APPID
tagId Number 1 标签ID,为空默认传全部
message Number 1 留言设置 1.所有人都可以留言 2.仅关注后留言 3.不允许留言
type Number 1 发送类型1.群发 2.定时群发
sendDate String 2018-12-12 日期
sendHour Number 23 小时(0-23)
sendMinute Number 15 分钟(0-59)
vo Array
 |-cover String 文章封面图片地址url,必传
 |-appId String 公众号APPID
 |-author String admin 作者
 |-content String 内容
 |-picId String 图片id
 |-sourceUrl String /www/m/ldscnew/20190521/152.html 原创链接
 |-title String 你好我的世界 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 13:53:13
token String

添加应用

API地址 : /cmsmanager/weiboSet

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 添加应用

Header参数

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

请求参数

名称 类型 必填 初始值 说明
appId String 2510334929 应用ID
appSecret String 2c64512a12f2e7f6a5cfb5f5b5d8b128 应用秘钥
description String jeecms演示站 备注

响应参数

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

应用配置详情

API地址 : /cmsmanager/weiboSet

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 应用配置详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String 1755542993 应用ID
   |— appSecret String 3a11303e4e4dfe6568fed4ed5f54888a 应用秘钥
   |— description String jeecms咨询 描述
   |— id Number 1 应用本地ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561019083997
token String

同步粉丝

API地址 : /cmsmanager/weibofans/sync

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

粉丝列表分页

API地址 : /cmsmanager/weibofans

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 粉丝列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 账户ID
gender String 性别,m-男 f-女 n-其他
screenName String 昵称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— description String 外面的世界很精彩,外面的世界很无奈。 描述
      |— followersCount Number 221 粉丝数
      |— friendsCount Number 291 关注数
      |— gender String m 性别,m-男 f-女 n-其他
      |— id Number 1 粉丝ID
      |— location String 江西 南昌 地址
      |— profileImageUrl String http://tva4.sinaimg.cn/crop.0.0.1342.1342.50/9d6b29dcjw8favby3zdwcj211a11an2k.jpg 头像
      |— blogUrl String 主页地址
      |— screenName String 泰迪学长啊 昵称
      |— statusesCount Number 528 微博数
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561023881027
token String

根据微博ID查询评论

API地址 : /cmsmanager/weibomessage/comments

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 根据ID查询评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 账户ID
page Number 页码
size Number 数量
weiboId Number 微博ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentId Number 4385549433283598 评论ID
      |— commentText String 那你哈哈哈 评论内容
      |— createTime Number 1561079926000 评论时间
      |— user Object 评论对象
         |— followersCount Number 21 关注数
         |— friendsCount Number 9 粉丝数
         |— gender String m 性别,m-男 f-女 n-位置
         |— idstr String 2434378661 用户ID
         |— location String 江西 南昌 地址
         |— profileImageUrl String http://tvax1.sinaimg.cn/crop.378.0.435.435.50/9119aba5ly8fh8cxbyw6rj20o00o0aax.jpg?Expires=1564140451&ssig=59GepIl%2BcC&KID=imgbed,tva 头像
         |— screenName String tom_jxnc 昵称
         |— statusesCount Number 16 微博数
      |— weiboContent String 第二次测试@tom_jxnc 微博内容
      |— weiboId Number 4385183291339789 微博ID
   |— first Boolean true
   |— last Boolean true
   |— size Number 2
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 18:27:32
token String

根据微博ID发表评论

API地址 : /cmsmanager/weibomessage

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 根据微博ID发表评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
comment String 那你厉害了 评论内容
weiboId Number 4385183291339789 微博LD
weiboUserId Number 31 微博账户ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— commentId Number 4385548812425150 返回的评论ID
   |— commentText String 那你厉害了 内容
   |— createTime Null 1561079930711 创建时间
   |— screenName String tom_jxnc 评论人昵称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561079783003
token String

回复评论

API地址 : /cmsmanager/weibomessage

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 回复评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
comment String 那你厉害了 回复内容
weiboId Number 4385183291339789 微博ID
weiboUserId Number 31 账户ID
commentId Number 4385188115047176 评论ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— commentId Number 4385550011842654 评论ID
   |— commentText String 回复@tom_jxnc:那你厉害了 回复内容
   |— createTime Null 1561079930711 创建时间
   |— screenName String tom_jxnc 昵称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561080068930
token String

删除评论

API地址 : /cmsmanager/weibomessage/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除评论(只限于自己发表的评论)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
commentId Number 4385251860584237 评论ID
weiboUserId Number 31 账户ID

响应参数

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

@我的评论

API地址 : /cmsmanager/weibomessage/atcomments

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: @我的评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 账户ID
page Number 页码
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentId Number 4385272856695075 评论ID
      |— commentText String @tom_jxnc 金钱草颗粒 评论内容
      |— createTime Number 1561013985000 评论时间
      |— user Object 评论人对象
         |— followersCount Number 221 粉丝数
         |— friendsCount Number 291 关注数
         |— gender String m 性别,m-男 f-女 n-位置
         |— idstr String 2641045980 微博用户ID
         |— location String 江西 南昌 地址
         |— profileImageUrl String http://tva4.sinaimg.cn/crop.0.0.1342.1342.50/9d6b29dcjw8favby3zdwcj211a11an2k.jpg?Expires=1564139638&ssig=Sxmg%2B3COIl&KID=imgbed,tva 头像
         |— screenName String 泰迪学长啊 昵称
         |— statusesCount Number 528 微博数
      |— weiboContent String 第二次测试@tom_jxnc 微博内容
      |— weiboId Number 4385183291339789 微博ID
   |— first Boolean true
   |— last Boolean true
   |— size Number 1
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 18:13:59
token String

收到的评论

API地址 : /cmsmanager/weibomessage/recComments

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 收到的评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 账户ID
page Number 页码
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentId Number 4385183598130601 评论ID
      |— commentText String 回复@tom_jxnc:这是评论四 评论内容
      |— createTime Number 1560992704000 评论时间
      |— user Object 评论对象
         |— followersCount Number 221 粉丝数
         |— friendsCount Number 291 关注数
         |— gender String m 性别,m-男 f-女 n-位置
         |— idstr String 2641045980 用户ID
         |— location String 江西 南昌 地址
         |— profileImageUrl String http://tva4.sinaimg.cn/crop.0.0.1342.1342.50/9d6b29dcjw8favby3zdwcj211a11an2k.jpg?Expires=1564139814&ssig=E356A36Fw2&KID=imgbed,tva 头像
         |— screenName String 泰迪学长啊 昵称
         |— statusesCount Number 528 微博数
      |— weiboContent String 第二次测试@tom_jxnc 微博内容
      |— weiboId Number 4385183291339789 微博ID
   |— first Boolean true
   |— last Boolean true
   |— size Number 1
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 18:16:55
token String

发出的评论

API地址 : /cmsmanager/weibomessage/sendComments

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 发出的评论

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 账户ID
size Number 数量
page Number 页码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentId Number 4385549433283598 评论ID
      |— commentText String 那你哈哈哈 评论内容
      |— createTime Number 1561079926000 评论时间
      |— user Object 评论人对象
         |— followersCount Number 21 粉丝数
         |— friendsCount Number 9 关注数
         |— gender String m 性别,m-男 f-女 n-位置
         |— idstr String 2434378661 用户ID
         |— location String 江西 南昌 地址
         |— profileImageUrl String http://tvax1.sinaimg.cn/crop.378.0.435.435.50/9119aba5ly8fh8cxbyw6rj20o00o0aax.jpg?Expires=1564139934&ssig=K8UW%2FJfR8X&KID=imgbed,tva 头像
         |— screenName String tom_jxnc 昵称
         |— statusesCount Number 16 微博数
      |— weiboContent String 第二次测试@tom_jxnc 微博内容
      |— weiboId Number 4385183291339789 微博ID
   |— first Boolean true
   |— last Boolean true
   |— size Number 1
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 18:18:55
token String

账户列表

API地址 : /cmsmanager/weiboinfo/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 账户列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 32 账户ID
   |— screenName String 泰迪学长啊 昵称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561080894969
token String

微博用户详情

API地址 : /cmsmanager/weiboinfo/{uid}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 微博用户详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— followersCount Number 21 粉丝数
   |— friendsCount Number 9 关注数
   |— gender String m 性别,m-男 f-女 n-位置
   |— id Number 31 用户ID
   |— location String 江西 南昌 地址
   |— profileImageUrl String http://tvax1.sinaimg.cn/crop.378.0.435.435.50/9119aba5ly8fh8cxbyw6rj20o00o0aax.jpg 头像
   |— screenName String tom_jxnc 昵称
   |— statusesCount Number 9 微博数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-26 16:25:11
token String

设置管理员

API地址 : /cmsmanager/weiboinfo/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 设置管理员

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1]
 |-0 Number 1 用户集合
weiboUserId Number 31 微博账户ID

响应参数

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

微博管理员列表

API地址 : /cmsmanager/weiboinfo/admins

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 微博管理员列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明
weiboUserId Number 微博用户ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 22 管理员ID
   |— org Object
      |— name String 研发部 组织名称
   |— roleNames String 角色名称
   |— userExt Object
      |— realname String 真实姓名
   |— username String 小白图 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 15:56:55
token String

推送文章到新浪微博

API地址 : /cmsmanager/weiboarticlepush

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 推送文章

Header参数

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

请求参数

名称 类型 必填 初始值 说明
contentIds Array [622] 内容IDs
 |-0 Number 622
weiboIds Array [31] 微博账户IDs
 |-0 Number 31

响应参数

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

推送记录列表分页

API地址 : /cmsmanager/weiboarticlepush/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 推送记录列表分页(推送汇总)

Header参数

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

请求参数

名称 类型 必填 初始值 说明
uid Number 622 微博UID
title Number 31 标题
status Number 发送状态1成功2失败

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— articleSourceUrl String http://www.jeecms.com/www/m/ldsc8/20190618/622.htm 原文地址
      |— articleWeiboUrl String http://weibo.com/ttarticle/p/show?id=2310474384893529403130 微博文章地址
      |— contentId Number 622 内容ID
      |— createTime Number 1560923551000 创建时间
      |— createUser String anonymousUser 创建人
      |— id Number 11 记录ID
      |— pushResult Number 1 发送状态1成功2失败
      |— title String 你好我的世界 标题
      |— uid String 2434378661 微博用户UID
      |— weiboInfo Object
         |— screenName String tom_jxnc 昵称
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561081223943
token String

推送预览

API地址 : /cmsmanager/weiboarticlepush/preview

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 推送预览

Header参数

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

请求参数

名称 类型 必填 初始值 说明
weiboId Number 31 微博账户ID
contentId Number 882 内容ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content String 如果有一天,Java是世界上最好的语言那么PHP怎么想,如果Java不是世界上最好的语言那么就很绝望了 具体内容
   |— contentId Number 882 内容ID
   |— cover String http://vzkje8.natappfree.cc/WEB-INF/sys/weibo/tc.service.png 封面URL
   |— weiboId Number 31 微博账户ID
   |— profileImageUrl String http://tvax1.sinaimg.cn/crop.378.0.435.435.50/9119aba5ly8fh8cxbyw6rj20o00o0aax.jpg 头像URL
   |— pushDate Number 1562306185479 推送时间
   |— screenName String tom_jxnc 微博昵称
   |— summary String 导语
   |— text String 发表了头条文章:《你好我的世界》 与其绑定短微博内容
   |— title String 你好我的世界 标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562306185479
token String

编辑后推送文章

API地址 : /cmsmanager/weiboarticlepush/updatePush

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 修改后推送文章

Header参数

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

请求参数

名称 类型 必填 初始值 说明
content String 如果有一天,Java是世界上最好的语言那么PHP怎么想,如果Java不是世界上最好的语言那么就很绝望了 具体内容
contentId Number 882 内容ID
cover String http://vzkje8.natappfree.cc/WEB-INF/sys/weibo/tc.service.png 封面URL
weiboId Number 31 微博账户ID
text String 发表了头条文章:《你好我的世界》 短微博内容
title String 你好我的世界 标题
summary String 导语

响应参数

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

微博账号列表分页

API地址 : /cmsmanager/weiboinfo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 微博账号列表分页

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— uid String 微博服务ID
      |— adminNames String system 管理员
      |— residueTime Number 剩余1823天 到期时间
      |— followersCount Number 21 粉丝数
      |— friendsCount Number 9 关注数
      |— id Number 31 账号ID
      |— profileImageUrl String http://tvax1.sinaimg.cn/crop.378.0.435.435.50/9119aba5ly8fh8cxbyw6rj20o00o0aax.jpg 头像
      |— red Boolean false 是否标红
      |— screenName String tom_jxnc 昵称
      |— statusesCount Number 9 微博数
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561019344735
token String

账号列表

API地址 : /cmsmanager/weiboinfo/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 账号列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— uid String 微博账户uid
   |— id Number 32 账号ID
   |— screenName String 泰迪学长啊 微博昵称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561022422176
token String

设置管理员

API地址 : /cmsmanager/weiboinfo/user

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 设置管理员

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 管理员ID集合
 |-0 Number 1
weiboUserId Number 31 微博账户ID

响应参数

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

添加账号(微博授权)

API地址 : /weibo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 添加账号(微博授权),这个时候走回调函数,需要处理之后的页面数据

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String https://api.weibo.com/oauth2/authorize?client_id=1755542993&redirect_uri=http://localhost:8080/weibo/authCallBack&state=1&response_type=code 返回的授权网址
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-29 14:15:05
token String

取消授权

API地址 : /cmsmanager/weiboinfo/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 取消授权

Header参数

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

请求参数

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

响应参数

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

无权限账户列表

API地址 : /cmsmanager/weiboinfo/noauth/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 得到全部微博账户

Header参数

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

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— uid String 微博UID
   |— id Number 32 微博账户ID
   |— screenName String 泰迪学长啊 微博名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561022422176
token String

采集任务列表

API地址 : /cmsmanager/collectTasks/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 1 采集任务id
      |— name String 快速采集任务 采集任务名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557388317152
token String

新增快速采集任务

API地址 : /cmsmanager/collectTasks

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 1 采集名称
fieldIds Array [1,2]
 |-0 Number 1 采集字段id
dataPosition Number 1 数据存放位置(1采集内容库 2 栏目)
channelId Number 1 栏目id
modelId Number 1 内容模型id
modelType Number 1 模板类型(1中国政府网2百度搜索词3微博4公众号)
keyword String 关键词、公众号、用户UID
status String 1 开始采集 2只保存任务

响应参数

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

修改采集任务

API地址 : /cmsmanager/collectTasks

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 采集任务id
name String 1 采集任务名称
fieldIds Array [1,2] 字段id数组
 |-0 Number 1 字段id
dataPosition Number 1 数据存放位置(1采集内容库 2 栏目)
channelId Number 1 栏目id
modelId Number 1 内容模型id
modelType Number 1 模板类型(1中国政府网2百度搜索词3微博4公众号)
keyword String 关键词、公众号、用户UID
status String 1 开始采集 2只保存任务

响应参数

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

校验唯一

API地址 : admin/collectTasks/unique/name

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 采集任务名称
id Number 采集任务id

响应参数

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

删除采集任务

API地址 : /cmsmanager/collectTacks/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1 采集任务id

响应参数

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

采集数据列表

API地址 : /cmsmanager/collectContents/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array 数据列表
      |— contxt String
      |— releaseTime String
      |— description String
      |— outLink String https://news.sogou.com/
      |— title String
   |— title Array 列名和
      |— field String contxt
      |— label String 内容
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563605834562
token String

采集数据导出

API地址 : /cmsmanager/collectContents/export

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明

采集模板列表

API地址 : /cmsmanager/collecttpls

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 采集模板列表

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 模板ID
   |— modelName String 中国政府网_要闻采集 模板名称
   |— spaceDataId Number 98 资源ID
   |— spaceDataUrl String /u/cms/www/201907/03150423xuxr.png URL
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563591734951
token String

模板获取详情

API地址 : /cmsmanager/collecttpls/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 模板获取详情

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— spaceDataUrl String 图片URL
   |— spaceDataId String 图片资源ID
   |— sourceUrl String 来源地址
   |— rules String 规则
   |— modelName String 模板名称
   |— modelId Number 模板ID
   |— collectUrl String 采集地址
   |— examples Array
      |— commentNum Null null 评论数
      |— content String 2017年我国研发人员全时当量全球第一 内容
      |— date Number 1562575772000 时间
      |— description String 描述
      |— domain String 目标域名
      |— forwardNum Null null 转发数
      |— id Number 1 标识符
      |— imgUrl String 图片地址
      |— link String http://sousuo.gov.cn/column/31421/0.htm 文章链接
      |— listLink String 列表页链接
      |— source String 人民日报 来源
      |— thumbNum Null null 点赞数
      |— title String 创新指数何以创新高 标题
      |— username String 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562639102519
token String

新增自定义采集

API地址 : /cmsmanager/collectTaskExt

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增自定义采集

Header参数

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

请求参数

名称 类型 必填 初始值 说明
task Object 任务对象
 |-deepXpath String 深入采集Xpath
 |-deepCollect Boolean 是否深入采集
 |-name String 自定义采集 采集任务名称
 |-url String www.baidu.com 采集URL
 |-startPage Number 1 采集起始页数
 |-endPage Number 10 采集结束页数
 |-startPoint Number 1 采集起点(1从第一条开始,2从最后一条开始)
 |-pageSet Number 1 分页设置( 1不分页2自动识别3手动识别4识别瀑布流分页)
 |-contentType Number 1 采集内容类型(1列表2单页)
 |-dataPosition Number 1 数据存放位置(1采集内容库2栏目)
 |-contentModelId Number 4 内容模型ID
 |-channelId Number 栏目id
taskExt Object 任务扩展
 |-serverUrl String 192.168.0.2 服务器地址
 |-port Number 8080 端口
 |-username String 123456 用户名
 |-pwd String 123456 密码
 |-collectThread Number 2 采集线程数
 |-intervalTime Number 2000 间隔时间(单位毫秒
 |-isTry Boolean true 是否请求失败重试true.是 false不是
 |-tryNumber Number 2 重试次数
 |-tryIntervalTime Number 2 重试次数时间间隔(单位秒)
 |-collectTime String 0 0/30 9-17 * * ? 采集时间(直接存corn 表达式)
items Array 字段集合
 |-itemId Number 1 字段id
 |-valueProperty String 取值属性名称
 |-customizeValue String 自定义,字段值
 |-isIncrement Boolean false 是否增量采集
 |-downloadFile Boolean false 是否下载文件
 |-itemField String title 字段
 |-respirceId Number 98 资源目录id值
 |-numFilters Array
  |-filterCondition Number 1 过滤条件:1.必须包含、2.不得包含、3.数字大于、4.数字小于、5.日期大于、6.日期小于、7.日期等于、8.长度大于、9.长度小于
  |-filterValue String 哈哈 过滤值
 |-txtFilters Array
  |-findValue String 你好 findValue
  |-splaceValue String *** 替换内容
datas Array 采集数据集合
 |-title String //*[@id=\"pl_editAppAdvance\"]/div[4] 字段名称(前台展示的字段名称作为key)值为该字段需要采集的XPATH,为空传空字符串

响应参数

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

修改自定义采集

API地址 : /cmsmanager/collectTaskExt

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改自定义采集

Header参数

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

请求参数

名称 类型 必填 初始值 说明
task Object
 |-deepXpath String 深入采集Xpath
 |-deepCollect Boolean 是否深入采集
 |-id Number 96 任务ID
 |-name String 最新采集20 任务名称
 |-url String www.baidu.com 采集url
 |-startPage Number 1 采集起始页数
 |-endPage Number 10 采集结束页数
 |-startPoint Number 1 采集起点(1从第一条开始,2从最后一条开始)
 |-pageSet Number 1 分页设置( 1不分页2自动识别3手动识别4识别瀑布流分页)
 |-contentType Number 1 采集内容类型(1列表2单页)
 |-dataPosition Number 1 数据存放位置(1采集内容库2栏目)
 |-contentModelId Number 4 内容模型ID
 |-channelId Number 栏目id
taskExt Object 扩展对象
 |-serverUrl String 192.168.0.2 服务器地址
 |-port Number 9090 端口
 |-username String 123456 用户名
 |-pwd String 45679 密码
 |-collectThread Number 2 采集线程数
 |-intervalTime Number 2000 间隔时间(单位毫秒)
 |-isTry Boolean true 是否请求失败重试true.是 false不是
 |-tryNumber Number 2 重试次数
 |-tryIntervalTime Number 2 重试次数时间间隔(单位秒)
 |-collectTime String 0 0/30 9-17 * * ? 采集时间(直接存corn 表达式)
items Array 字段集合
 |-itemId Number 1 字段id
 |-valueProperty String 取值属性名称
 |-customizeValue String 自定义,字段值
 |-isIncrement Boolean false 是否增量采集
 |-downloadFile Boolean false 是否下载文件
 |-itemField String title 字段
 |-respirceId Number 98 资源目录id值
 |-numFilters Array
  |-filterCondition Number 1 过滤条件:1.必须包含、2.不得包含、3.数字大于、4.数字小于、5.日期大于、6.日期小于、7.日期等于、8.长度大于、9.长度小于
  |-filterValue String 刘德华 过滤值
 |-txtFilters Array
  |-findValue String 刘德华 查找内容
  |-splaceValue String *** 替换内容

响应参数

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

移动数据

API地址 : /cmsmanager/collectContents/export/content

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
channelId Number 11 栏目id
modelId String 1 内容模型id
collectContentIds Array 1 采集内容id集合值

响应参数

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

暂停采集任务

API地址 : /cmsmanager/collect/data/pause/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String 暂停任务4
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563593311533
token String

恢复采集任务

API地址 : /cmsmanager/collect/data/resume/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String 恢复任务4
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563593365106
token String

停止采集任务

API地址 : /cmsmanager/collect/data/terminate/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data String 停止任务4
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563593409194
token String

删除采集内容

API地址 : /cmsmanager/collectContents/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

查询快速查询的模板的字段

API地址 : /cmsmanager/collectitem

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
status Number 1 1. 中国政府网采集字段,2.微信采集字段,3. 微博采集字段,4. 百度采集字段

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— itemField String 1 字段id
   |— itemLabel String 标题 字段显示名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563607921865
token String

开始任务

API地址 : /cmsmanager/collectTasks/start

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id String 采集任务id

响应参数

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

清空所有数据

API地址 : /cmsmanager/collectContents/all/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
taskId Number 采集任务id

响应参数

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

采集数据分页

API地址 : /cmsmanager/collectContents/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— contxt String
      |— releaseTime String
      |— description String
      |— outLink String https://news.sogou.com/
      |— title String
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
   |— title Array
      |— field String contxt
      |— label String 内容
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563605834562
token String

快速采集详情

API地址 : /cmsmanager/collectTasks/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— fieldIds Array 字段id集合
      |— 0 Number 字段id
   |— spaceDataUrl String 模板图标地址
   |— collectUrl String 采集地址
   |— rules String 采集规则
   |— modelName String 模板名称
   |— channelId Number null 栏目id
   |— contentModelId Number null 内容模型id
   |— dataPosition Number 1 数据存放位置(1采集内容库2栏目)
   |— id Number 1 任务id
   |— keyword String 搜索词
   |— modelType Number 1 模板类型(1中国政府网2百度搜索词3微博4公众号)
   |— name String 中国政府 采集任务名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563757296035
token String

开始自定义采集任务

API地址 : /cmsmanager/collect/data/start/{collectTaskId}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

深入采集

API地址 : /cmsmanager/collectCustom/deepCollect

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 该接口会尝试自动提取新闻正文, 如果提取成功将会返回新闻相关字段的数据和xpath, 如果提取失败则啥都没有

Header参数

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

请求参数

名称 类型 必填 初始值 说明
taskId Number 采集任务id
parentField String 该深入采集在父页面中的入口字段, 比如当前深入采集是通过titleLink进入的, 则parentField为titleLink
url String 深入采集的样本url

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— textContent String 开发比人类更聪明的AGI会导致世界毁灭吗?
   |— textTitleXpath String /html/body/div/div/div[1]/div/div[1]/div[2]/div[2]/div/div/div[1]/div/div[1]/div[1]/div/div/div[1]/div/h1
   |— textContentXpath String /html/body/div/div/div[1]/div/div[1]/div[2]/div[2]/div/div/div[1]/div/div[1]/div[1]/div/div/div[1]/div/h1
   |— textTitle String 开发比人类更聪明的AGI会导致世界毁灭吗?
   |— textTimeXpath String /html/body/div/div/div[1]/div/div[1]/div[2]/div[2]/div/div/div[1]/div/div[1]/div[1]/div/div/div[1]
   |— textTime String 2019-08-20 11:21:44
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-20 15:22:47
token String

结果分析-按用户

API地址 : /cmsmanager/questionnaireAnswer/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
isEffective Boolean true 有效
province String
city String
device String 设备
replayName String 参与人
ip String IP
beginTime String 开始时间
endTime String 结束时间
questionnaireId String 问卷id
orderBy Number 1是创建时间倒序 2是创建时间升序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— isFile Boolean true 该问卷有附件题 false 该问卷没有附件题
      |— answer String 多选题答案 答案
      |— city String city
      |— createTime String 2019-10-26 15:27:24 创建时间
      |— device String pc 设备
      |— ip String ip IP
      |— isEffective Boolean true true 有效
      |— province String province
      |— replayName String 1 参与人
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-06 15:21:56
token String

标记有效

API地址 : /cmsmanager/questionnaireAnswer/valid

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

标记无效

API地址 : /cmsmanager/questionnaireAnswer/invalid

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

删除

API地址 : /cmsmanager/questionnaireAnswer/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

问卷统计

API地址 : /cmsmanager/questionnaire/find

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— beginTime String 2019-10-23 14:15:11 开始时间
   |— endTime String 2019-10-28 14:15:11 结束时间
   |— number Number 1 数量
   |— pageViews Number 0 浏览量
   |— rate Number 0 参与率
   |— status Number 0 状态
   |— title String 这是复制的问卷 标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-07 10:53:46
token String

导出问卷结果-用户分类

API地址 : /cmsmanager/questionnaireAnswer/export

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
isEffective Boolean 是否有效 true 有效
province String
city String
device String 设备
ip String IP
replayName String 参与人
beginTime String 开始时间
endTime String 结束时间
questionnaireId Number 问卷id
page Number
size Number

响应参数

名称 类型 初始值 说明

导出问卷结果-题目分类

API地址 : /cmsmanager/questionnaireAnswer/subject/export

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
isEffective String true 有效
province String
city String
device String 设备
ip String IP
replayName String 参与人
beginTime String 开始时间
endTime String 结束时间
questionnaireId Number 问卷id
subjectId Number 题目id
options String 排除的答案,多个用英文逗号隔开
page Number
size Number

响应参数

名称 类型 初始值 说明

结果分析-按题目分页列表

API地址 : /cmsmanager/questionnaireAnswer/subject/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
subjectId Number 题目id
province String
city String
device String 设备
ip String IP
replayName String 参与人
beginTime String 开始时间
endTime String 结束时间
questionnaireId Number 问卷id
options String 排除的选项(非级联题传id,级联题传答案)
page Number
size Number

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— answer String [{ "height": "1200", "name": "f0b64ac81835d2e839e92dbabf5e6d53.jpeg", "pdfUrl": "", "type": 1, "url": "/u/cms/www/201911/28140928ofql.jpeg", "width": "1920" }] 答案
      |— city String city
      |— createTime String 2019-10-26 15:27:24 创建时间
      |— device String pc 设备
      |— ip String ip IP
      |— province String province
      |— replayName String 1 参与人
   |— 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-08 09:12:56
token String

题目分类-饼图

API地址 : /cmsmanager/questionnaireAnswer/subject/pieChart

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— count Number 1 数量
   |— item String 选项二 选项
   |— optionId String 339 选项id
   |— rate Null null 占比
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 09:03:34
token String

结果分析-按题目列表(左侧)

API地址 : /cmsmanager/questionnaireAnswer/subject/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— number Number 1
   |— options Array
      |— number Number 1 数量
      |— optionId Number 337 选项id
      |— rate Number 100 占比
      |— title String 选项一 标题
   |— subjectId Number 450 题目id
   |— title String 单选题 题目标题
   |— type Number 1 题目类型
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 09:09:44
token String

设备分析

API地址 : /cmsmanager/questionnaireAnswer/chart/device

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— count Number 2
   |— item String pc
   |— optionId String
   |— rate Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 09:18:30
token String

地图

API地址 : /cmsmanager/questionnaireAnswer/chart/map

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— count Number 2
   |— item String province
   |— optionId String
   |— rate Number 100
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 09:19:08
token String

趋势分析

API地址 : /cmsmanager/questionnaireAnswer/chart/trend

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
deviceType Number 设备类型 1pc 2移动
province String
city String
showType Number 显示方式 1时2天3周4月
beginTime String 开始时间
endTime String 结束时间
questionnaireId Number 问卷id

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— 参与人次 Number 0
   |— time String 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 09:23:59
token String

用户答题详情

API地址 : /cmsmanager/questionnaireAnswer/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— address String provincecity
   |— answer Array
      |— result String [ {"height": "1200", "name": "f0b64ac81835d2e839e92dbabf5e6d53.jpeg", "pdfUrl": "", "type": 1, "url": "/u/cms/www/201911/28140928ofql.jpeg", "width": "1920" }]
      |— title String 单选题
   |— describe String 描述
   |— device String pc
   |— effective Boolean true
   |— ip String ip
   |— participateTime Number 1572074799000
   |— replayName String 1
   |— title String 这是复制的问卷
   |— voteStyle Object
      |— bgConfig Object
         |— alignType String 1
         |— bgColor String #F0F0F0
         |— bgImage Null null
         |— bgImageUrl String
         |— bgType Number 2
         |— isRepeat Number 1
         |— opacity Number 100
      |— contConfig Object
         |— bgColor String #F0F0F0
         |— borderColor String #e8e8e8
         |— borderRadius Number 0
         |— borderWidth Number 1
         |— hasBorder Number 1
      |— fontConfig Object
         |— descStyle Object
            |— fontAlign String left
            |— fontColor String #333333
            |— fontSize Number 14
            |— fontWigth Number 400
         |— optStyle Object
            |— fontAlign String left
            |— fontColor String #333333
            |— fontSize Number 14
            |— fontWigth Number 400
         |— stemStyle Object
            |— fontAlign String left
            |— fontColor String #333333
            |— fontSize Number 14
            |— fontWigth Number 400
         |— titleStyle Object
            |— fontAlign String left
            |— fontColor String #333333
            |— fontSize Number 24
            |— fontWigth Number 600
      |— headConfig Object
         |— bgImage Null null
         |— bgImageUrl String
      |— subConfig Object
         |— bgColor String #F0F0F0
         |— borderColor String
         |— borderRadius Number 0
         |— borderWidth Number 0
         |— btnHeight Number 0
         |— btnWidth Number 0
         |— fontStyle Null null
         |— hasBorder Number 0
         |— text String
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 16:12:28
token String

分页列表

API地址 : /cmsmanager/questionnaire/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
status Number 状态(0未发布1流转中2已驳回3进行中4已结束)
beginTime String 开始时间
endTime String 结束时间
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— answerCount Null null 答卷数
      |— beginTime Null null 开始时间
      |— checkStatus Boolean false true 已审核 false 未审核
      |— createTime String 2019-10-22 15:01:11 创建时间
      |— createUser String system 创建人
      |— endTime Null null 结束时间
      |— status Number 0 状态(0未发布1流转中2已驳回3进行中4已结束)
      |— title String 测试 标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-22 15:22:05
token String

新建

API地址 : /cmsmanager/questionnaire

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 测试1804 标题
details String 描述 描述
bgConfig Object
 |-bgType Number 2 页面背景类型(1图片2颜色)
 |-bgImage Number 页面背景图id
 |-alignType String left 对齐方式(left right center)
 |-opacity Number 100 透明度
 |-isRepeat Number 1 是否重复
 |-bgColor String #F0F0F0 页面背景颜色
headConfig Object
 |-bgImage String 页眉图片
contConfig Object
 |-bgColor String #ffffff 内容区背景颜色
 |-hasBorder Number 1 是否使用边框(1是0否)
 |-borderColor String #e8e8e8 边框颜色
 |-borderWidth Number 1 边框粗细
 |-borderRadius Number 0 边框圆角
fontConfig Object
 |-titleStyle Object
  |-fontSize Number 24 标题字体大小
  |-fontWigth Number 600 标题字体是否加粗
  |-fontColor String #333333 标题字体颜色
  |-fontAlign String left 标题字体对齐方式
 |-descStyle Object
  |-fontSize Number 14 描述字体大小
  |-fontWigth Number 400 描述字体是否加粗
  |-fontColor String #333333 描述字体颜色
  |-fontAlign String left 描述字体对齐方式
 |-stemStyle Object
  |-fontSize Number 14 题干字体大小
  |-fontWigth Number 400 题干字体是否加粗
  |-fontColor String #333333 题干字体颜色
  |-fontAlign String left
 |-optStyle Object
  |-fontSize Number 14 选项字体大小
  |-fontWigth Number 400 选项字体是否加粗
  |-fontColor String #333333 选项字体颜色
  |-fontAlign String left
subConfig Object
 |-text String 提交按钮文字
 |-fontStyle Object
  |-fontSize Number 14 提交按钮字体大小
  |-fontWigth Number 400 提交按钮字体是否加粗
  |-fontColor String #333333 提交按钮字体颜色
 |-bgColor String #ffffff 提交按钮背景颜色
 |-hasBorder Number 1 提交按钮是否使用边框
 |-borderColor String #e8e8e8 提交按钮边框颜色
 |-borderWidth Number 1 提交按钮边框粗细
 |-borderRadius Number 0 提交按钮边框圆角
 |-btnWidth Number 77 提交按钮边框宽度
 |-btnHeight Number 32 提交按钮边框高度
coverPic Number 123456 图片地址id
isVerification Boolean true true 使用验证码 false 不使用
processType Number 1 提交成功后处理方式(1显示文字信息2跳转到指定页面3显示结果)
prompt String 成功 文字信息/指定页面
workflowId String 工作流id
beginTime String 2019-10-23 14:15:11 开始时间
endTime String 2019-10-28 14:15:11 结束时间
answerLimit Boolean false true 登录才能投票 false 可以不登录
userAnswerFrequencyLimit Number 1 用户答题次数限制
userAnswerFrequencyLimitUnit Number 1 用户答题次数限制单位(1只能2每小时3每天)
ipAnswerFrequencyLimit Number 1 ip答题次数限制
ipAnswerFrequencyLimitUnit Number 1 ip答题次数限制单位(1只能2每小时3每天)
deviceAnswerFrequencyLimit Number 1 设备答题次数限制
deviceAnswerFrequencyLimitUnit Number 1 设备答题次数限制单位(1只能2每小时3每天)
isOnlyWechat Boolean false true 只能微信 false 不只微信
wechatAnswerFrequencyLimit Number 1 微信用户答题次数限制
wechatAnswerFrequencyLimitUnit Number 1 微信用户答题次数限制(1只能2每小时3每天)
shareLogo Number 1 分享logo图Id
description String 说明文字 说明文字
subjects Array
 |-title String 单选题 标题
 |-type Number 1 1单选2多选3问答4下拉5级联6附件
 |-isAnswer Boolean false true 必答 false 非必答
 |-prompt String 提示 提示
 |-column Number 1 每行列数
 |-options Array
  |-name String 选项一 选项名称
  |-pic Number pic 图片id
  |-isDefault Boolean false true 默认 false 不是默认
  |-isRequired Boolean true true 必填 false 非必填
  |-sortNum Number 1 排序
status Number (0保存1提交审核3发布)

响应参数

名称 类型 初始值 说明
code Number 200
data Number 122 投票调查id(问卷设置也是这个)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-24 09:02:52
token String

删除

API地址 : /cmsmanager/questionnaire/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [102]
 |-0 Number 102 投票调查id

响应参数

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

预览

API地址 : /cmsmanager/questionnaire/preview/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id} 写投票调查id

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— bgConfig Object
      |— alignType Number 1
      |— bgColor String #F0F0F0
      |— bgImage String
      |— bgType Number 2
      |— isRepeat Number 1
      |— opacity Number 100
   |— details String 描述
   |— fontConfig Object
      |— descStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— optStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— stemStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— titleStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 24
         |— fontWigth Number 600
   |— headConfig Object
      |— bgImage String
   |— subConfig Object
      |— bgColor String #ffffff
      |— borderColor String #e8e8e8
      |— borderRadius Number 0
      |— borderWidth Number 1
      |— btnHeight Number 32
      |— btnWidth Number 77
      |— fontStyle Object
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— hasBorder Number 1
      |— text String
   |— subjects Array
      |— allowFile Boolean false
      |— answer Boolean false
      |— cascadeOption String
      |— column Number 1
      |— fileCount Boolean false
      |— fileCountLimit Null null
      |— fileSize Boolean false
      |— fileSizeLimit Null null
      |— fileSizeLimitUnit Null null
      |— fileType Boolean false
      |— fileTypeLimit String
      |— id Number 82
      |— inputHigh Null null
      |— inputWidth Null null
      |— limit Boolean false
      |— limitCondition Null null
      |— options Array
         |— createTime String 2019-10-23 18:30:06
         |— createUser String system
         |— id Number 42
         |— isDefault Boolean false
         |— isRequired Boolean true
         |— name String 选项一
         |— pic String pic
         |— questionnaireSubjectId Number 82
         |— sortNum Number 1
         |— updateTime Null null
         |— updateUser String
      |— prompt String 提示
      |— radio Boolean false
      |— title String 单选题
      |— type Number 1
      |— wordLimit String
   |— title String 测试1804
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-24 10:06:14
token String

详情

API地址 : /cmsmanager/questionnaire/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
type Number 新建和修改完获取详情时填true

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— actions Array
      |— reasonMust String 意见是否必填
      |— reasonNeed String 是否需要输入意见
      |— actionName String 动作名
      |— actionId Number 动作ID
   |— revokeSupport Boolean true 可审核
   |— answerLimit Boolean false 是否登录后才能投票
   |— beginTime Number 1571811311000 开始时间
   |— bgConfig Object
      |— alignType Number 1
      |— bgColor String #F0F0F0
      |— bgImage Null null
      |— bgImageUrl String
      |— bgType Number 2
      |— isRepeat Number 1
      |— opacity Number 100
   |— contConfig Object
      |— bgColor String #ffffff
      |— borderColor String #e8e8e8
      |— borderRadius Number 0
      |— borderWidth Number 1
      |— hasBorder Number 1
   |— coverPic Number 123 封面图片Id
   |— coverPicUrl String 封面图片
   |— description String 说明文字 说明文字
   |— details String 描述
   |— deviceAnswerFrequencyLimit Number 1 设备答题次数限制
   |— deviceAnswerFrequencyLimitUnit Number 1 设备答题次数限制单位(1只能2每小时3每天)
   |— endTime Number 1572243311000 结束时间
   |— fontConfig Object
      |— descStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— optStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— stemStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— titleStyle Object
         |— fontAlign String left
         |— fontColor String #333333
         |— fontSize Number 24
         |— fontWigth Number 600
   |— headConfig Object
      |— bgImage Null null
      |— bgImageUrl String
   |— id Number 235
   |— ipAnswerFrequencyLimit Number 1 ip答题次数限制
   |— ipAnswerFrequencyLimitUnit Number 1 ip答题次数限制单位(1只能2每小时3每天)
   |— onlyWechat Boolean false 是否只能微信使用
   |— previewUrl String
   |— processType Number 1 提交成功后处理方式(1显示文字信息2跳转到指定页面3显示结果)
   |— prompt String 成功 提示
   |— shareLogo Number 1245 分享logo图id
   |— shareLogoUrl String 分享logo图地址
   |— status Number 0
   |— subConfig Object
      |— bgColor String #ffffff
      |— borderColor String #e8e8e8
      |— borderRadius Number 0
      |— borderWidth Number 1
      |— btnHeight Number 32
      |— btnWidth Number 77
      |— fontStyle Object
         |— fontColor String #333333
         |— fontSize Number 14
         |— fontWigth Number 400
      |— hasBorder Number 1
      |— text String
   |— subjects Array
      |— dragable Boolean false
      |— editor String
      |— groupIndex Null null
      |— id Number 412
      |— index Null null
      |— isAnswer Boolean false
      |— isCustom Boolean true
      |— option Object
         |— column Number 1
         |— fileNum Null null
         |— fileNumLimit Boolean false
         |— fileSize Null null
         |— fileSizeLimit Boolean false
         |— fileTypeLimit Boolean false
         |— fileTypeSet Null null
         |— fileTypes String
         |— fileUnit String
         |— inputHeight Null null
         |— inputLimit Boolean false
         |— inputNum Null null
         |— inputNumLimit Boolean false
         |— inputType Null null
         |— inputWidth Null null
         |— isRadio Boolean false
         |— options Array []
      |— placeholder String 提示
      |— preview String
      |— prompt String
      |— title String 单选题
      |— type Number 1
      |— value Null null
   |— title String 测试1804
   |— userAnswerFrequencyLimit Number 1 用户答题次数限制
   |— userAnswerFrequencyLimitUnit Number 1 用户答题次数限制单位(1只能2每小时3每天)
   |— verification Boolean true 是否使用验证码
   |— wechatAnswerFrequencyLimit Number 1 微信用户答题次数限制
   |— wechatAnswerFrequencyLimitUnit Number 1 微信用户答题次数限制(1只能2每小时3每天)
   |— workflowId Number 762 工作流id
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-29 17:56:10
token String

发布

API地址 : /cmsmanager/questionnaire/release

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [112]
 |-0 Number 112 投票调查id

响应参数

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

暂停

API地址 : /cmsmanager/questionnaire/pause

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [112]
 |-0 Number 112 投票调查id

响应参数

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

待办列表

API地址 : /cmsmanager/task/questionnaire/toDeal

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— actions Array
         |— code String agree agree通过 disagree不通过
         |— id Number 2602 动作Id
         |— name String 动作 动作
      |— autoRevokeTime Null null 自动驳回时间
      |— channelName String
      |— contentId Number 225 投票调查id
      |— displayRemainTime String -- 获取流转剩余时间
      |— lastActionCode String submit 上个节点的动作编号 submit提交审核 agree通过 disagree不通过 sysdisagree 系统自动驳回
      |— lastActionName String 动作 上个节点的动作名称(如果是会签,则显示通过或者不通过)
      |— lastActionUsers Array ["system"]
         |— 0 String system 上次操作人
      |— previewUrl String http://192.168.0.200:8700/preview?contentId=225&type=questionnaire 预览地址
      |— title String 测试1804 投票调查标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-28 11:51:15
token String

已办列表

API地址 : /cmsmanager/task/questionnaire/handle

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— allowRevoke Boolean false 是否允许撤回
      |— channelName String
      |— contentId Number 235 投票调查id
      |— flowTime String 2019-10-28 13:51:24 通过时间
      |— nodeName String 结束 当前办理节点名称
      |— previewUrl String http://192.168.0.200:8700/preview?contentId=235&type=questionnaire 预览url
      |— title String 测试1804 投票调查标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-28 14:03:02
token String

逾期未办

API地址 : /cmsmanager/task/questionnaire/overDue

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 标题

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— allowRevoke Boolean false 是否允许撤回 true 允许 false 不允许
      |— channelName String
      |— contentId Number 2 投票调查id
      |— flowTime Number 1563585907000 逾期时间
      |— nodeName String 审核1 逾期节点名称
      |— previewUrl String /www/m/news/20190517/2.html 预览地址
      |— title String 测试2 投票调查标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563589129406
token String

提交审核

API地址 : /cmsmanager/task/questionnaire/submit

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
questionnaireId Number 投票调查id

响应参数

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

撤回(工作流)

API地址 : /cmsmanager/task/questionnaire/revoke

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

审核

API地址 : /cmsmanager/task/questionnaire/audit

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
questionnaireId Number 投票问卷id
actionId Number 动作id
reason String 审核详情

响应参数

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

批量提交审核

API地址 : /cmsmanager/task/questionnaire/submits

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array
 |-0 Number 235 投票调查id

响应参数

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

复制

API地址 : /cmsmanager/questionnaire/copy

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 1
title String 这是复制的

响应参数

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

问卷链接

API地址 : /cmsmanager/questionnaire/link/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— details String 描述 描述
   |— embedded String 嵌入式
   |— iframe String iframe代码
   |— qrCodeUrl String http://192.168.0.200:8700/common/qrcode/136?val=http://192.168.0.200:8700/questionnaire/235 136px二维码
   |— shareLogoUrl String 微信分享logo图
   |— title String 测试1804 标题
   |— url String http://192.168.0.200:8700/questionnaire/235 问卷地址
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-29 11:01:52
token String

下载二维码图片

API地址 : /cmsmanager/questionnaire/qrcode

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
size Number 360 大小
id Number 问卷id

响应参数

名称 类型 初始值 说明

修改

API地址 : /cmsmanager/questionnaire

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 测试1804 标题
details String 描述 描述
bgConfig Object
 |-bgType Number 2 页面背景类型(1图片2颜色)
 |-bgImage String 页面背景图id
 |-alignType String left
 |-opacity Number 100
 |-isRepeat Number 1
 |-bgColor String #F0F0F0
headConfig Object
 |-bgImage String
contConfig Object
 |-bgColor String #ffffff
 |-hasBorder Number 1
 |-borderColor String #e8e8e8
 |-borderWidth Number 1
 |-borderRadius Number 0
fontConfig Object
 |-titleStyle Object
  |-fontSize Number 24
  |-fontWigth Number 600
  |-fontColor String #333333
  |-fontAlign String left
 |-descStyle Object
  |-fontSize Number 14
  |-fontWigth Number 400
  |-fontColor String #333333
  |-fontAlign String left
 |-stemStyle Object
  |-fontSize Number 14
  |-fontWigth Number 400
  |-fontColor String #333333
  |-fontAlign String left
 |-optStyle Object
  |-fontSize Number 14
  |-fontWigth Number 400
  |-fontColor String #333333
  |-fontAlign String left
subConfig Object
 |-text String
 |-fontStyle Object
  |-fontSize Number 14
  |-fontWigth Number 400
  |-fontColor String #333333
 |-bgColor String #ffffff
 |-hasBorder Number 1
 |-borderColor String #e8e8e8
 |-borderWidth Number 1
 |-borderRadius Number 0
 |-btnWidth Number 77
 |-btnHeight Number 32
coverPic Number 123456 图片地址id
isVerification Boolean true true 使用验证码 false 不使用
processType Number 1 提交成功后处理方式(1显示文字信息2跳转到指定页面3显示结果)
prompt String 成功 文字信息/指定页面
workflowId String 工作流id
beginTime String 2019-10-23 14:15:11 开始时间
endTime String 2019-10-28 14:15:11 结束时间
answerLimit Boolean false true 登录才能投票 false 可以不登录
userAnswerFrequencyLimit Number 1 用户答题次数限制
userAnswerFrequencyLimitUnit Number 1 用户答题次数限制单位(1只能2每小时3每天)
ipAnswerFrequencyLimit Number 1 ip答题次数限制
ipAnswerFrequencyLimitUnit Number 1 ip答题次数限制单位(1只能2每小时3每天)
deviceAnswerFrequencyLimit Number 1 设备答题次数限制
deviceAnswerFrequencyLimitUnit Number 1 设备答题次数限制单位(1只能2每小时3每天)
isOnlyWechat Boolean false true 只能微信 false 不只微信
wechatAnswerFrequencyLimit Number 1 微信用户答题次数限制
wechatAnswerFrequencyLimitUnit Number 1 微信用户答题次数限制(1只能2每小时3每天)
shareLogo Number 1 分享logo图Id
description String 说明文字 说明文字
subjects Array
 |-id Number
 |-title String 单选题
 |-type Number 1
 |-isAnswer Boolean false
 |-prompt String 提示
 |-column Number 1
 |-options Array
  |-name String 选项一
  |-pic String pic
  |-isDefault Boolean false
  |-isRequired Boolean true
  |-sortNum Number 1
status String
id Number

响应参数

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

判断是否配置工作流

API地址 : /cmsmanager/questionnaire/workflow

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 配置了工作流 false没有配置工作流
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563589129406
token String

导出答案

API地址 : /cmsmanager/questionnaire/answer/export

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明

清空答卷

API地址 : /cmsmanager/questionnaire/answer/clean

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明

图片列表

API地址 : /questionnaire/pic

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— headImg Array 页眉图
      |— thumbnail String ''
      |— picId Number 1
      |— picUrl String /u/cms/www/201911/pic.jpg
   |— bgImg Array 背景图
      |— thumbnail String ''
      |— picId Number 1
      |— picUrl String /u/cms/www/201911/pic.jpg
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-28 14:03:02
token String

获取本地栏目和模型数据

API地址 : /cmsmanager/collect/getId

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— appId String 4XYBO*3bAk5d3cAk5d3aAk5d39zkdc3YMk5g APPID
   |— channels Array 栏目JSON
      |— children Array
         |— name String 投稿栏目
         |— id Number 3422
         |— parentId Number 1747
         |— isBottom Boolean true
      |— name String 新闻
      |— id Number 1747
      |— parentId Null null
      |— isBottom Boolean false
   |— models Array 模型JSON
      |— modelName String 下载
      |— id Number 962
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-08 11:21:32
token String

获取表单分页列表

API地址 : /cmsmanager/form/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 搜索标题名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime String 2020-01-07 08:55:09
      |— createUser String system
      |— description String 投诉表单 描述
      |— id Number 12
      |— title String 投诉表单 标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 09:15:43
token String

表单详情

API地址 : /cmsmanager/form/${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-01-10 13:46:56
      |— createUser String system
      |— dataType String input
      |— defValue String
      |— field String title
      |— formId Number 12
      |— groupType String 1
      |— id Number 172
      |— 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 09:23:04
token String

创建表单

API地址 : /cmsmanager/form

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 建议 标题
description String 投诉表单 描述
formScene Number 1 应用场景(1领导信箱 2智能表单)

响应参数

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

表单修改

API地址 : /cmsmanager/form

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 投诉表单2
description String 投诉表单2
formScene Number 1
id Number 2

响应参数

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

查询名称是否可用

API地址 : /cmsmanager/form/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 标题
id Number

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true代表可用 false不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 10:05:08
token String

表单删除

API地址 : /cmsmanager/form/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

表单设置

API地址 : /cmsmanager/form/updateFields

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
bgConfig Object 背景样式JSON(对象内属性前端自定定义即可)
 |-alignType String left top 所有字段参考智能表单
 |-bgColor String #F0F0F0
 |-bgImage Number 20 背景图ID
 |-bgImageUrl String /u/cms/www/201911/26102414mnfg.jpg
 |-bgType Number 1
 |-isRepeat Number 1
 |-opacity Number 100
contConfig Object 内容区样式JSON(对象内属性前端自定定义即可)
 |-bgColor String #ffffff
 |-borderColor String #e8e8e8
 |-borderRadius Number 0
 |-borderWidth Number 1
 |-hasBorder Number 1
fontConfig Object 字体样式JSON(对象内属性前端自定定义即可)
 |-descStyle Object
  |-fontAlign String left
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-optStyle Object
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-stemStyle Object
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-titleStyle Object
  |-fontAlign String center
  |-fontColor String #333333
  |-fontSize Number 24
  |-fontWigth Number 600
headConfig Object 页眉样式JSON(对象内属性前端自定定义即可)
 |-bgImage Number 4 背景图ID
 |-bgImageUrl String /u/cms/www/201911/22173638yekm.jpg
subConfig Object 按钮样式(JSON(对象内属性前端自定定义即可)
 |-bgColor String #1ec6df
 |-borderColor String #ffffff
 |-borderRadius Number 4
 |-borderWidth Number 1
 |-btnHeight Number 36
 |-btnWidth Number 100
 |-fontStyle Object
  |-fontColor String #ffffff
  |-fontSize Number 14
  |-fontWigth Number 400
 |-hasBorder Number 1
 |-text String 提交
fields Array 字段对象集合(类似模型)
 |-dragable Boolean true
 |-canDelete Boolean true
 |-icon String wenben
 |-type String input dateTimeSection(日期区间类型)imageCheckbox(图片多选)imageRadio图片单选)cascade(级联)
 |-name String 标题 系统默认字段有:captcha验证码 title标题 content内容 openIntention 公开意愿
 |-groupType String 1 字段分组
 |-groupIndex Number 1
 |-isCustom Boolean false
 |-index Number 3
 |-preview String DInputPreview
 |-editor String DInputEditor
 |-value Object
  |-defaultValue String
  |-label String 标题
  |-name String title
  |-placeholder String 请输入内容
  |-tip String 请输入内容
  |-isLengthLimit Boolean true
  |-max Number 50
  |-isInputLimit Boolean true
  |-inputLimit String chinese
  |-isRegister Boolean false
  |-isRequired Boolean false
 |-prop String input_1578618073334_771855
id Number 12
formScene Number 1

响应参数

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

表单修改(标题描述、分组)

API地址 : /cmsmanager/form/simpleUpdate

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 投诉表单3332 标题
description String 投诉表单2 描述
typeId Number 60 分组
id Number 476

响应参数

名称 类型 初始值 说明
code Number 200
data Number 476
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-30 14:27:13
token String

信件类型列表

API地址 : /cmsmanager/letterType/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— noticeOpen Boolean 是否开启写信须知
      |— noticeTxt String 写信须知
      |— 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 每台电脑或手机限制
      |— devicbLimitUnit Number 1 每台电脑或手机限制单位((1只能2每小时3每天 0不限制)
      |— form Object
         |— id Number 12
         |— title String 投诉表单
      |— formId Number 12 适用表单id
      |— id Number 32
      |— ipSubLimit Number 10 ip提交次数限制
      |— ipSubLimitUnit Number 1 ip提交次数限制单位(1只能2每小时3每天0不限制)
      |— 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 接收信箱ID
      |— scoreSet Number 3 满意度评价设置(1开启且公开评价结果 2开启但不公开评价结果 3不开启)
      |— sortNum Number 10
      |— sortWeight Number 10
      |— submitLimitLogin Boolean true 是否登录后才能投票
      |— updateTime String 2020-01-10 11:02:43
      |— updateUser String system
      |— userSubLimit Null null 用户提交次数限制
      |— userSubLimitUnit Null null 用户提交次数限制单位(1只能2每小时3每天)
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 11:37:06
token String

信件类型详情

API地址 : /cmsmanager/letterType/${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-01-10 11:00:46
   |— createUser String system
   |— default Boolean false
   |— deviceSubLimit Number 10
   |— deviceSubLimitUnit Number 1
   |— form Object
      |— id Number 12
      |— title String 投诉表单
   |— formId Number 12
   |— id Number 32
   |— ipSubLimit Number 10
   |— ipSubLimitUnit Number 1
   |— name String 投诉2
   |— processType Number 1
   |— prompt String 提交成功,感谢您的参与!
   |— recBox Object
      |— boxType Object
         |— id Number 1
         |— name String 投诉
      |— id Number 3
      |— name String 局长信箱1
   |— recBoxId Number 3
   |— scoreSet Number 3
   |— sortNum Number 10
   |— sortWeight Number 10
   |— submitLimitLogin Boolean true
   |— updateTime String 2020-01-10 11:02:43
   |— updateUser String system
   |— userSubLimit Null null
   |— userSubLimitUnit Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 12:00:08
token String

检查名称是否可用

API地址 : /cmsmanager/letterType/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 12:01:21
token String

排序

API地址 : /cmsmanager/letterType/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 12
toId Number 3

响应参数

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

保存

API地址 : /cmsmanager/letterType

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 咨询
processType Number 1 提交成功后处理方式(1显示文字信息2显示信件编号及查询码 )
submitLimitLogin Boolean true 是否登录后才能投票
prompt String 提交成功,感谢您的参与! 文字信息/指定页面
deviceSubLimitUnit Number 1 设备提交次数限制单位(1只能2每小时3每天 0不限制)
deviceSubLimit Number 10 设备提交次数限制
ipSubLimitUnit Number 1 ip提交次数限制单位(1只能2每小时3每天0不限制)
ipSubLimit Number 10 ip提交次数限制
formId Null null 适用表单ID
recBoxId Number 42 接收信箱ID
coverPicId Number 1 封面图ID
userSubLimit Number 用户提交次数限制
userSubLimitUnit Number 用户提交次数限制单位(1只能2每小时3每天)
scoreSet Number 满意度评价设置(1开启且公开评价结果 2开启但不公开评价结果 3不开启)
noticeOpen Boolean 是否开启写信须知
noticeTxt String 写信须知文本

响应参数

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

修改

API地址 : /cmsmanager/letterType

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 投诉2
processType Number 1
submitLimitLogin Boolean true
prompt String 提交成功,感谢您的参与!
deviceSubLimitUnit Number 1
deviceSubLimit Number 10
ipSubLimitUnit Number 1
ipSubLimit Number 10
formId Number 12
recBoxId Number 3
coverPicId Number 1
userSubLimit String
userSubLimitUnit String
scoreSet String
id Number 32
noticeTxt String 写信须知文本
noticeOpen Boolean 是否开启写信须知

响应参数

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

删除

API地址 : /cmsmanager/letterType/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

信箱类型列表

API地址 : /cmsmanager/letterBoxType/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— createTime String 2020-01-04 16:21:19
   |— createUser String system
   |— id Number 13
   |— name String 投诉23
   |— sortNum Number 10
   |— sortWeight Number 12
   |— updateTime String 2020-01-04 16:56:25
   |— updateUser String system
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 10:55:41
token String

信箱类型名称检查是否可用

API地址 : /cmsmanager/letterBoxType/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 10:57:22
token String

信箱类型详情

API地址 : /cmsmanager/letterBoxType/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— createTime String 2020-01-04 16:21:12
   |— createUser String system
   |— id Number 1
   |— name String 投诉
   |— sortNum Number 10
   |— sortWeight Number 11
   |— updateTime String 2020-01-04 16:56:11
   |— updateUser String system
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 11:00:08
token String

信箱类型排序

API地址 : /cmsmanager/letterBoxType/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 13
toId Number 12

响应参数

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

信箱类型保存

API地址 : /cmsmanager/letterBoxType

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

信箱类型修改

API地址 : /cmsmanager/letterBoxType

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 投诉23
id Number 13

响应参数

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

信箱类型删除

API地址 : /cmsmanager/letterBoxType/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

信箱分页

API地址 : /cmsmanager/letterBox/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content 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
      |— letterCount Number 0 信件数量
      |— name String 副局长信箱1 名称
      |— sortNum Number 10
      |— sortWeight Number 10
      |— updateTime Null null
      |— updateUser String
      |— workflow Object
         |— id Number 485
         |— name String 工作流审核步骤 工作流名称
      |— workflowId Number 485
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 11:05:58
token String

用户可管理信箱列表

API地址 : /cmsmanager/letterBox/getMyboxs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String
boxTypeId Number 信箱类型ID

响应参数

名称 类型 初始值 说明
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 11:12:45
token String

信箱详情

API地址 : /cmsmanager/letterBox/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

检查信箱名称是否可用

API地址 : /cmsmanager/letterBox/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 11:15:55
token String

信箱排序

API地址 : /cmsmanager/letterBox/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
fromId Number 12
toId Number 3

响应参数

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

信箱保存

API地址 : /cmsmanager/letterBox

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 局长投诉信箱23 名称
boxTypeId Number 13 信箱类型id
workflowId Number 152 工作流id
userIds Array [1,543] 可管理用户id
 |-0 Number 1

响应参数

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

信箱修改

API地址 : /cmsmanager/letterBox

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 局长信箱1
boxTypeId Number 1
workflowId Number 152
userIds Array [1,543]
 |-0 Number 1
id Number 3

响应参数

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

信箱删除

API地址 : /cmsmanager/letterBox/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

分页

API地址 : /cmsmanager/letter/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
typeId Number 信件类型ID
title String 标题
letterNo String 编号
status Number 1待办理 2已回复 3流转中 (已回复 已评价 已选登 用2 已删除用空)
isRecycle Boolean 是否回收站
hasScore Boolean 是否评价
hasOpen Boolean 是否选登
nextBoxId Boolean 当前停留信箱id
replyBoxId Number 回复信箱id
orderBy Number orderBy 排序 (1创建时间倒序 2 回复时间倒序 3选登时间倒序 4评价时间倒序 5删除时间倒序)
createTimeMin String reateTimeMin 来信时间最小值
createTimeMax String createTimeMax 来信时间最大值
replyTimeMin String replyTimeMin 回复时间最小值
replyTimeMax String replyTimeMax 回复时间最大值
openTimeMin String openTimeMin 选登时间最小值
openTimeMax String openTimeMax 选登时间最大值
scoreMin Number scoreMin 评价时间最小值
scoreMax Number 评价时间最大值
recycleTimeMin String recycleTimeMin 删除时间最小值
recycleTimeMax String recycleTimeMax 删除时间最大值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— address String 发信地区
      |— attrMap Object 信件详情字段数据(详情展示,列表无)
         |— checkbox_iYKbH2 Array ["选项2"]
            |— 0 String 选项2
         |— datetime_Qqn6Ma String 2020-01-10
         |— select_3UcTuz String 选项1
         |— address_PckPnz String 滨江一号
         |— radio_dDb0I8 String 选项1
         |— imageCheckbox_nO5P6h Array
            |— label String 选项3
            |— url String /u/cms/www/202007/09152837fp9o.png
            |— val Number 25043
         |— datetimerange_RknVi6 Null null
         |— imageRadio_DO69fu Object
            |— label String 选项1
            |— url String /u/cms/www/202007/09152900seul.jpg
            |— val Number 25045
         |— title String 我的第2封信件 标题
         |— content String 我的第2封信件内容呢 内容
         |— audioUpload_ys1qIk Object
            |— coverImg Null null
            |— id Number 18
            |— pdfPath String
            |— resAlias String 铃声2(3).mp3
            |— resDesc String
            |— resDuration String 00:01:00
            |— resId Number 25053
            |— sizeUnit String 938KB
            |— url String /u/cms/www/202007/09160742onqy.mp3
         |— fileUpload_6iCcyt Array
            |— coverImg Null null
            |— id Number 1
            |— pdfPath String
            |— resAlias String
            |— resDesc String
            |— resDuration String
            |— resId Number 25054
            |— sizeUnit String
            |— url String
         |— videoUpload_vLbXLE Object
            |— coverImg Object
               |— alias String 1594282065202
               |— dimensions String 544*960
               |— duration String 00:00:00
               |— id Number 25055
               |— size Number 29
               |— url String /u/cms/www/202007/09160744pqux.jpg
            |— id Number 21
            |— pdfPath String
            |— resAlias String 1(5).mp4
            |— resDesc String
            |— resDuration String 00:00:07
            |— resId Number 25056
            |— sizeUnit String 808KB
            |— url String /u/cms/www/202007/09160744ahn2.mp4
         |— multiImageUpload_TYyxkf Array
            |— coverImg Null null
            |— id Number 2
            |— pdfPath String
            |— resAlias String
            |— resDesc String 111,2222
            |— resDuration String
            |— resId Number 25057
            |— sizeUnit String
            |— url String
         |— imageUpload_AhLVe5 Object
            |— coverImg Null null
            |— id Number 24
            |— pdfPath String
            |— resAlias String 1(8).jpg
            |— resDesc String
            |— resDuration String 00:00:00
            |— resId Number 25059
            |— sizeUnit String 858KB
            |— url String /u/cms/www/202007/09160745z6l2.jpg
         |— city_6J0aO2 String null
      |— city Null null
      |— cityCode String
      |— content String 我修222改的内容333d44d222d3dsdafasd
      |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
      |— createTime String 2020-07-09 16:07:42 创建时间
      |— createUser String system 创建用户
      |— currNodeId Null null
      |— datas Array 字段是数据
         |— dataType String input 字段类型
         |— field String title 字段
         |— label String 单行文本框 字段label
         |— required Boolean false
         |— val String 我的第2封信件 字段值
      |— finishMinute Null null 完结时效
      |— finishTime Null null 完结时间
      |— firstBox Null null 受理信箱
      |— firstBoxId Number 42
      |— flowProcessId String
      |— flowStartUserId Null null
      |— id Number 2
      |— ip String 0:0:0:0:0:0:0:1 ip
      |— isOpen Boolean false 是否公开
      |— isRecycle Boolean false 是否回收站
      |— letterNo String 20200709100001 编号
      |— nextBox Object 待处理信箱
         |— id Number 12
         |— name String 局长審核
      |— nextBoxId Number 12
      |— openIntention Boolean true 公开意愿
      |— openTime Null null 是否选登
      |— openUser Null null 选登用户
      |— openUserId Null null
      |— province Null null
      |— provinceCode String
      |— qPass String vMRxWl00 查询密码
      |— recycleTime Null null 加入回收站时间
      |— recycleUser Null null 加入回收站人
      |— recycleUserId Null null
      |— replyBox Object 回复信箱
         |— id Number 12
         |— name String 局长審核
      |— replyBoxId Number 12
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1594353069000 回复时间
      |— 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 1 信件状态(1待办理 2已回复 3流转中 )
      |— title String content
      |— type Object 信件类型
         |— id Number 1
         |— name String 咨询2
      |— typeId Number 1
      |— updateTime String 2020-07-10 11:51:09
      |— updateUser String system
      |— userDel Boolean false
      |— userId Number 1
      |— viewReplyContent String 您好,已收件qwqwqwfasdffdd 前台展示回复内容
      |— workflowId Null null
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-10 14:02:52
token String

删除至回收站

API地址 : /cmsmanager/letter/recycle

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

转发回复

API地址 : /cmsmanager/letter/reply

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
id Number 132
nextBoxId Number 12 转发信箱
reason String 转发给您看看哈 转发意见
title String content 标题
content String 我修222改的内容333d44d222d3 内容
forward Boolean false 是否转发 true是转发 false是直接回复
replyContent String 您好,已收件qwqwqwffdd 回复内容
scoreSet Number 1 满意度评价设置(1开启且公开评价结果 2开启但不公开评价结果 3不开启)
isOpen Boolean true 是否选登

响应参数

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

信件详情-日志分页

API地址 : /cmsmanager/letterLog/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— box Object 信箱
         |— boxType Object
            |— id Number 1
            |— name String 投诉
         |— id Number 12
         |— name String 副局长信箱
      |— boxId Number 12
      |— createTime Number 1581402600000
      |— id Number 72
      |— letterId Number 72
      |— logInfo String 删除 信件日志内容
      |— user Object 用户
         |— id Number 1
         |— username String system
      |— userId Number 1
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 9
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 14:37:03
token String

回收站还原

API地址 : /cmsmanager/letter/reduce

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

彻底删除

API地址 : /cmsmanager/letter/delete/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

清空回收站

API地址 : /cmsmanager/letter/clearAll

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

选登

API地址 : /cmsmanager/letter/open

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

取消选登

API地址 : /cmsmanager/letter/close

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

待处理信件分页

API地址 : /cmsmanager/letter/task/toDeal

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— actions Array 可支持的动作集合
         |— code String agree
         |— id Number 1482
         |— name String 通过
      |— autoRevokeTime Null null 自动驳回时间(逾期时间)
      |— content String 我修222改的内容333d44d222d3dsdafasd 回复内容
      |— createTime Number 1581405585000
      |— displayRemainTime String -- 获取流转剩余时间
      |— id Number 162
      |— lastActionCode String submit 最后动作编号
      |— lastActionName String 动作 最后动作名称
      |— lastActionUsers Array ["system"] 最后动作操作人
         |— 0 String system
      |— letterNo String 20200211100001 编号
      |— nextBox Object 处理信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1581407242000 回复时间
      |— replyUser Null null 回复人
      |— title String content 标题
      |— typeName String 类型名
   |— 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 15:56:12
token String

审核

API地址 : /cmsmanager/letter/task/audit

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
actionId Number 动作ID
reason String 动作原因
id Number 信件ID

响应参数

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

撤回审核

API地址 : /cmsmanager/letter/task/revoke

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

已处理信件分页

API地址 : /cmsmanager/letter/task/handle

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— allowRevoke Boolean false 是否允许撤回
      |— content String 我修222改的内容333d44d222d3dsdafasd 内容
      |— createTime Number 1581405585000
      |— flowTime String 2020-02-11 16:02:38
      |— id Number 162
      |— letterNo String 20200211100001 编号
      |— nextBox Object 当前信箱
         |— id Number 32
         |— name String 副局长信箱12
      |— nodeName String 结束 当前节点名称
      |— replyContent String 您好,已收件qwqwqwfasdffdd 回复内容
      |— replyTime Number 1581407242000 回复时间
      |— replyUser Null null 回复人
      |— title String content 标题
      |— typeName String 信件类型名
   |— 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 16:03:09
token String

逾期未办内容

API地址 : /cmsmanager/letter/task/overDue

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Object 同已处理信件
   |— content Array
      |— allowRevoke Boolean false
      |— content String 我修222改的内容333d44d222d3dsdafasd
      |— createTime Number 1581405585000
      |— flowTime String 2020-02-11 16:02:38
      |— id Number 162
      |— letterNo String 20200211100001
      |— nextBox Object
         |— id Number 32
         |— name String 副局长信箱12
      |— nodeName String 结束
      |— replyContent String 您好,已收件qwqwqwfasdffdd
      |— replyTime Number 1581407242000
      |— replyUser Null null
      |— title String content
      |— typeName String
   |— 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 16:03:09
token String

待办信件数量

API地址 : /cmsmanager/letter/task/toDealCount

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Number 0 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 16:10:12
token String

信件数据-查询详情

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

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object 其他结构参考分页列表
   |— address String
   |— attrMap Object
      |— checkbox_iYKbH2 Array ["选项2"]
         |— 0 String 选项2
      |— datetime_Qqn6Ma String 2020-01-10
      |— select_3UcTuz String 选项1
      |— address_PckPnz String 滨江一号
      |— radio_dDb0I8 String 选项1
      |— imageCheckbox_nO5P6h Array
         |— label String 选项3
         |— url String /u/cms/www/202007/09152837fp9o.png
         |— val Number 25043
      |— datetimerange_RknVi6 Null null
      |— imageRadio_DO69fu Object
         |— label String 选项1
         |— url String /u/cms/www/202007/09152900seul.jpg
         |— val Number 25045
      |— title String 我的第2封信件
      |— content String 我的第2封信件内容呢
      |— audioUpload_ys1qIk Object
         |— coverImg Null null
         |— id Number 18
         |— pdfPath String
         |— resAlias String 铃声2(3).mp3
         |— resDesc String
         |— resDuration String 00:01:00
         |— resId Number 25053
         |— sizeUnit String 938KB
         |— url String /u/cms/www/202007/09160742onqy.mp3
      |— fileUpload_6iCcyt Array
         |— coverImg Null null
         |— id Number 1
         |— pdfPath String
         |— resAlias String
         |— resDesc String
         |— resDuration String
         |— resId Number 25054
         |— sizeUnit String
         |— url String
      |— videoUpload_vLbXLE Object
         |— coverImg Object
            |— alias String 1594282065202
            |— dimensions String 544*960
            |— height String 960
            |— id Number 25055
            |— resourceDate Null null
            |— resourceType Number 1
            |— size Number 29
            |— url String /u/cms/www/202007/09160744pqux.jpg
            |— width String 544
         |— id Number 21
         |— pdfPath String
         |— resAlias String 1(5).mp4
         |— resDesc String
         |— resDuration String 00:00:07
         |— resId Number 25056
         |— sizeUnit String 808KB
         |— url String /u/cms/www/202007/09160744ahn2.mp4
      |— multiImageUpload_TYyxkf Array
         |— coverImg Null null
         |— id Number 2
         |— pdfPath String
         |— resAlias String
         |— resDesc String 111,2222
         |— resDuration String
         |— resId Number 25057
         |— sizeUnit String
         |— url String
      |— imageUpload_AhLVe5 Object
         |— coverImg Null null
         |— id Number 24
         |— pdfPath String
         |— resAlias String 1(8).jpg
         |— resDesc String
         |— resDuration String 00:00:00
         |— resId Number 25059
         |— sizeUnit String 858KB
         |— url String /u/cms/www/202007/09160745z6l2.jpg
      |— city_6J0aO2 String null
   |— city Null null
   |— cityCode String
   |— content String 我修222改的内容333d44d222d3dsdafasd
   |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
   |— createTime String 2020-07-09 16:07:42
   |— createUser String system
   |— currNodeId Null null
   |— datas Array
      |— dataType String input
      |— field String title
      |— label String 单行文本框
      |— required Boolean false
      |— val String 我的第2封信件
   |— finishMinute Null null
   |— finishTime Null null
   |— firstBox Null null
   |— firstBoxId Number 42
   |— flowProcessId String
   |— flowStartUserId Null null
   |— id Number 2
   |— ip String 0:0:0:0:0:0:0:1
   |— isOpen Boolean false
   |— isRecycle Boolean false
   |— lastLog Object 最后操作记录
      |— box Object 待处理信箱
         |— id Number 12
         |— name String 局长審核
      |— boxId Number 12
      |— createTime Number 1594352870000 创建时间
      |— id Number 1
      |— letterId Number 2
      |— logInfo String 信件主题(我的第2封信件)修改为(content),信件内容(我的第2封信件)修改为(content),回复内容(您好,已收件qwqwqwfasdffdd),满意度评价设置(开启且公开评价结果),选登设置((否))
      |— user Object 操作用户
         |— attrMap Object
         |— id Number 1
         |— realname String 管理员
         |— telephone String 18278451242
         |— userExt Object
            |— birthday Null null
            |— gender Number 3
         |— username String system
      |— userId Number 1
   |— letterNo String 20200709100001
         |— id Number 12
         |— name String 局长審核
         |— attrMap Object
         |— id Number 1
         |— realname String 管理员
         |— telephone String 18278451242
         |— userExt Object
            |— birthday Null null
            |— gender Number 3
         |— username String system
   |— nextBox Object
      |— id Number 12
      |— name String 局长審核
   |— nextBoxId Number 12
   |— openIntention Boolean true
   |— openTime Null null
   |— openUser Null null
   |— openUserId Null null
   |— province Null null
   |— provinceCode String
   |— qPass String vMRxWl00
   |— recycleTime Null null
   |— recycleUser Null null
   |— recycleUserId Null null
   |— replyBox Object
      |— id Number 12
      |— name String 局长審核
   |— replyBoxId Number 12
   |— replyContent String 您好,已收件qwqwqwfasdffdd
   |— replyTime Number 1594353069116
   |— replyUser Object
      |— attrMap Object
      |— id Number 1
      |— realname String 管理员
      |— telephone String 18278451242
      |— userExt Object
         |— birthday Null null
         |— gender Number 3
      |— username String system
   |— replyUserId Number 1
   |— score Number 0
   |— scoreSet Number 1
   |— scoreTime Null null
   |— sendUser Object
      |— attrMap Object
      |— id Number 1
      |— realname String 管理员
      |— telephone String 18278451242
      |— userExt Object
         |— birthday Null null
         |— gender Number 3
      |— username String system
   |— status Number 1
   |— title String content
   |— type Object
      |— id Number 1
      |— name String 咨询2
   |— typeId Number 1
   |— updateTime String 2020-07-10 11:51:09
   |— updateUser String system
   |— userDel Boolean false
   |— userId Number 1
   |— viewReplyContent String 您好,已收件qwqwqwfasdffdd
   |— workflowId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-10 11:51:13
token String

撤销办理状态

API地址 : /cmsmanager/letter/revokeReply

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

信件概览统计

API地址 : /cmsmanager/letter/statistic/survey

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
year Number 年份
timeUnit Number 1第一季度 2 第2季度 3第3季度 4 第4季度 5上半年 6下半年 7 -18分别代表 1-12月

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— replysVos Object 回复量柱状图数据
      |— date String 时间
      |— count Number 数量
   |— letterVos Object 留言量柱状图数据
      |— count Number 数量
      |— date String 时间
   |— areaVos Array 地区数据
      |— area Null null 地区
      |— areaCode String
      |— count Number 1 数量
   |— avgScore Number 0 平均评分
   |— lastCycleAvgScore Number 0 最近一期平均满意度
   |— lastCycleCount Number 0 环比留言总数量
   |— lastCycleIncreRatio Number 1 环比留言增长
   |— lastCycleReplyCount Number 0 环比回复量总数量
   |— lastCycleReplyIncreRatio Number 1 环比回复量增长
   |— previouCount Number 0 同比留言总数量
   |— previouIncreRatio Number 1 同比留言增长
   |— previouReplyCount Number 0 同比回复量总数量
   |— previouReplyIncreRatio Number 1 同比回复量增长
   |— replyCount Number 1 回复数
   |— replyRatio Number 1 留言回复率
   |— totalCount Number 0 留言数
   |— typeVos Array 信件类型统计数据u
      |— count Number 1 数量
      |— ratio Null null 占比
      |— type Object 类型
         |— id Number 42
         |— name String 咨询
      |— typeId Number 42
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 16:42:28
token String

获取第一封信件年份

API地址 : /cmsmanager/letter/getFirstLetterYear

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Number 2018 年份
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 16:41:27
token String

信件汇总(按信箱统计)

API地址 : /cmsmanager/letter/statistic/byBox

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— boxCounts Array 信箱统计数据集合
      |— adminUsernames String system,test 信箱管理员
      |— avgScore Number 10 平均评分
      |— id Number 32 信箱id
      |— name String 副局长信箱12 信箱名称
      |— openCount Number 0 已选登数量
      |— processingCount Number 0 流转中数量
      |— recycleCount Number 0 已删除数量
      |— replyCount Number 1 已回复数量
      |— replyRatio Number 1 回复率
      |— scoreCount Number 0 已评价数量
      |— totalCount Number 1 总数
      |— typeId Number 1 信件类型ID
      |— unProcessCount Number 0 待处理数量
   |— boxType Object 信件类型
      |— id Number 1
      |— name String 投诉
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-11 16:49:04
token String

统计数量-省份

API地址 : /cmsmanager/letter/statistic/countByProvince

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— area Null null
      |— areaCode String
      |— count Number 1
   |— 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 16:54:48
token String

工作量统计

API地址 : /cmsmanager/letter/statistic/getReplyStatic

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
groupBy Number groupBy 1 人 2信箱
year Number year 年份
timeUnit Number timeUnit 查询周期(1第一季度 2 第2季度 3第3季度 4 第4季度 5上半年 6下半年 7 -18分别代表 1-12月)
orderBy Number orderBy 1回复数量降序 2回复效率降序 3满意度降序*

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— box Null null 信箱对象
      |— boxId Null null
      |— replyCount Number 1 回复数量
      |— replyTime Number 154560 办理效率(单位分钟)
      |— score Number 0 平均评分
      |— user Object 用户对象
         |— id Number 1
         |— realname String 管理员
         |— username String system
      |— userId Number 1
   |— 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 16:55:08
token String

表单类型列表

API地址 : /cmsmanager/formType/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— formTotalCount Number 2 总表单数
   |— forms Array 分组表单
      |— formCount Number 0 表单数
      |— id Number 6
      |— name String 智能表单的名字就是要特别的长
   |— notGroupFormCount Number 1 未分组表单数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-01 14:56:33
token String

表单类型名称是否可用

API地址 : /cmsmanager/formType/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 11:38:51
token String

表单类型详细

API地址 : /cmsmanager/formType/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— createTime String 2020-02-14 09:38:03
   |— createUser String system
   |— id Number 12
   |— name String 分组3
   |— siteId Number 1
   |— sortNum Number 10
   |— sortWeight Number 10
   |— updateTime String 2020-02-14 09:39:17
   |— updateUser String system
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 11:39:43
token String

表单类型删除

API地址 : /cmsmanager/formType/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
ids Array [6] id数组
 |-0 Number 6
cascadeDelForm Boolean true true 删除分组及分组内的所有表单 false 该分组内的表单变为未分组状态

响应参数

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

表单类型保存

API地址 : /cmsmanager/formType

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

表单类型修改

API地址 : /cmsmanager/formType

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 分组2
id Number 22

响应参数

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

表单列表

API地址 : /cmsmanager/smartForm/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
name String 名称
typeId Number 类型id 0未分组 全部不传此参数
status Number 状态 0未发布 1进行中 2已结束 全部为空

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— endTime String 结束时间
      |— beginTime String 开始时间
      |— createTime String 2020-02-14 17:30:54
      |— createUser String system
      |— description String 智能表单1 描述
      |— formType Object 分类
         |— id Number 22
         |— name String 分组2
      |— id Number 54
      |— joinCount Number 0 参与人次
      |— status Number 1 发布状态(0未发布 1已发布 2暂停)
      |— title String 智能表单134w3 标题
      |— viewStatus Number 1 展示状态 0未发布 1进行中 2已结束
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 13:55:01
token String

表单详情

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

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— headImg Object 页眉图
      |— id Number
      |— sysRes Boolean true是系统默认图
      |— url String url
   |— bgImg Object 背景图
      |— url String url
      |— id Number
      |— sysRes Boolean 是否系统默认图
   |— beginTime Number 1581676381000 开始时间
   |— bgConfig String {"bgType":1,"bgColor":"#F0F0F0","bgImageUrl":"/u/cms/www/201911/26102414mnfg.jpg","alignType":"left top","bgImage":20,"isRepeat":1,"opacity":100} 背景样式JSON(对象内属性前端自定定义即可)
   |— contConfig String {"borderColor":"#e8e8e8","bgColor":"#ffffff","borderRadius":0,"borderWidth":1,"hasBorder":1} 字体样式JSON(对象内属性前端自定定义即可)
   |— coverPic Object 封面图
      |— id Number 1
      |— url String /u/cms/www/201911/22173609efvz.jpg
   |— coverPicId Number 1 封面图ID
   |— createTime String 2020-02-19 14:46:35
   |— createUser String system
   |— description String 投诉表单2 描述
   |— deviceSubLimit Number 1000 设备提交次数限制
   |— deviceSubLimitUnit Number 1 设备提交次数限制单位(1只能2每小时3每天)
   |— endTime Null null 结束时间
   |— fields Array [] 字段信息
   |— 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 2 表单场景
   |— formType Object 表单类型
      |— id Number 22
      |— name String 分组2
   |— headConfig String {"bgImageUrl":"/u/cms/www/201911/22173638yekm.jpg","bgImage":4} 页眉样式JSON(对象内属性前端自定定义即可)
   |— id Number 92
   |— ipSubLimit Number 1000 ip提交次数限制
   |— ipSubLimitUnit Number 1 ip提交次数限制单位(1只能2每小时3每天)
   |— 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-19 14:46:35
      |— createUser String system
      |— dataType String input
      |— defValue String
      |— field String title
      |— formId Number 92
      |— groupType String 1
      |— id Number 432
      |— isCustom Boolean false
      |— isRequired Boolean false
      |— itemLabel String 标题
      |— placeholder String 请输入内容
      |— sortNum Number 3
      |— tipText String 请输入内容
      |— updateTime Null null
      |— updateUser String
   |— joinCount Number 9 参与人次
   |— processType Number 1
   |— prompt String 提交成功,感谢您的参与!
   |— shareDesc String 我分享的
   |— shareLogo Object 分享图片
      |— id Number 1
      |— url String /u/cms/www/201911/22173609efvz.jpg
   |— shareLogoId Number 1 分享图片ID
   |— siteId Number 1
   |— status Number 1 状态
   |— 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 true 是否登录后才能提交
   |— title String 投诉表单0w21r9ddd 标题
   |— typeId Number 22 ;额偶像od
   |— updateTime String 2020-02-25 14:07:49
   |— updateUser String system
   |— url String http://localhost:8700/interact-form.htm?id=92 浏览地址
   |— userSubLimit Number 1000 用户提交次数限制
   |— userSubLimitUnit Number 1 用户提交次数限制单位(1只能2每小时3每天)
   |— viewCount Number 13 浏览次数
   |— viewStatus Number 1 表单状态 0未发布 1进行中 2已结束
   |— wechatSubLimit Number 1 微信用户提交次数
   |— wechatSubLimitUnit Number 1 微信用户提交次数限制(1只能2每小时3每天)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 13:58:45
token String

表单发布

API地址 : /cmsmanager/smartForm/publish

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
publish Boolean true true发布 false暂停
id Array 54 id数组

响应参数

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

表单删除

API地址 : /cmsmanager/smartForm/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

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

表单保存

API地址 : /cmsmanager/smartForm

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 智能表单13qwqw4w3
description String 智能表单1
typeId Number 22

响应参数

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

表单修改和表单设置

API地址 : /cmsmanager/smartForm

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 投诉表单3332 标题
description String 投诉表单2 描述
id Number 42 id
coverPicId Number 1 封面图id
processType Number 1 提交成功后(1显示文字信息2跳转到指定页面 )
prompt String 提交成功,感谢您的参与! 提交成功后提示语
beginTime String 2020-02-14 18:26 开始时间
endTime String 2020-02-16 18:26 结束时间
submitLimitLogin Boolean true 登录后才能填写
userSubLimit Number 10 每个用户填写次数限制
userSubLimitUnit Number 1 用户提交次数限制单位(1只能2每小时3每天)
ipSubLimit Number 10 ip提交次数限制
ipSubLimitUnit Number 1 ip提交次数限制单位(1只能2每小时3每天)
deviceSubLimit Number 10 设备提交次数限制
deviceSubLimitUnit Number 1 设备提交次数限制单位(1只能2每小时3每天)
isOnlyWechat Number 0 只能在微信中填写
wechatSubLimit Number 1 微信用户提交次数限
wechatSubLimitUnit Number 1 微信用户提交次数限制(1只能2每小时3每天)
shareDesc String 我分享的 分享说明文字
shareLogoId Number 1 分享Logo
typeId Number 分组ID 0未分组

响应参数

名称 类型 初始值 说明

表单字段编辑

API地址 : /cmsmanager/smartForm/updateFields

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
bgConfig Object 参考表单详情
 |-alignType String left top
 |-bgColor String #F0F0F0
 |-bgImage Number 20
 |-bgImageUrl String /u/cms/www/201911/26102414mnfg.jpg
 |-bgType Number 1
 |-isRepeat Number 1
 |-opacity Number 100
contConfig Object
 |-bgColor String #ffffff
 |-borderColor String #e8e8e8
 |-borderRadius Number 0
 |-borderWidth Number 1
 |-hasBorder Number 1
fontConfig Object
 |-descStyle Object
  |-fontAlign String left
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-optStyle Object
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-stemStyle Object
  |-fontColor String #333333
  |-fontSize Number 14
  |-fontWigth Number 400
 |-titleStyle Object
  |-fontAlign String center
  |-fontColor String #333333
  |-fontSize Number 24
  |-fontWigth Number 600
headConfig Object
 |-bgImage Number 4
 |-bgImageUrl String /u/cms/www/201911/22173638yekm.jpg
subConfig Object
 |-bgColor String #1ec6df
 |-borderColor String #ffffff
 |-borderRadius Number 4
 |-borderWidth Number 1
 |-btnHeight Number 36
 |-btnWidth Number 100
 |-fontStyle Object
  |-fontColor String #ffffff
  |-fontSize Number 14
  |-fontWigth Number 400
 |-hasBorder Number 1
 |-text String 提交
fields Array
 |-dragable Boolean true
 |-canDelete Boolean true
 |-icon String wenben
 |-type String input
 |-name String 标题
 |-groupType Number 1
 |-groupIndex Number 1
 |-isCustom Boolean false
 |-index Number 3
 |-preview String DInputPreview
 |-editor String DInputEditor
 |-value Object
  |-defaultValue String
  |-label String 标题
  |-name String title
  |-placeholder String 请输入内容
  |-tip String 请输入内容
  |-isLengthLimit Boolean true
  |-max Number 50
  |-isInputLimit Boolean true
  |-inputLimit String chinese
  |-isRegister Boolean false
  |-isRequired Boolean false
 |-prop String input_1578618073334_771855
id Number 53
componentConfig Object 组件区设置

响应参数

名称 类型 初始值 说明

表单复制

API地址 : /cmsmanager/smartForm/copy

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明
title String 投诉表单0w21r9ddd 新表单名称
description String 投诉表单2
id Number 53 被复制的id

响应参数

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

表单名称检查是否可用

API地址 : /cmsmanager/smartForm/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

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

请求参数

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

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 14:43:43
token String

清空表单数据

API地址 : /cmsmanager/smartForm/clearData/delete/${id}

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

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

请求参数

名称 类型 必填 初始值 说明

响应参数

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

导出结果数据

API地址 : /cmsmanager/smartFormData/export

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
formId Number 表单ID
isRead Boolean 是否已读
proviceCode String 省份编码
cityCode String 城市编码
isPc Boolean 是否pc
username String 用户名
ip String IP
createTimeMin String 创建时间最小值
createTimeMax String 创建时间查询最大值

响应参数

名称 类型 初始值 说明

系统默认图片查询

API地址 : /cmsmanager/resourceSpaceDatas/pic

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
querySence Number 2表单的图片

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— bgImg Array 背景图
      |— mobilePicUrl String /u/cms/www/201911/25095746csic.jpg 手机图
      |— picId Number 35 id
      |— picUrl String /u/cms/www/201911/25095746csic.jpg pc图
      |— thumbnail String /u/cms/www/201911/城市1.jpg 缩率小图
   |— headImg Array 页眉图
      |— mobilePicUrl String /u/cms/www/201911/22173609efvz.jpg
      |— picId Number 25
      |— picUrl String /u/cms/www/201911/22173609efvz.jpg
      |— thumbnail String /u/cms/www/201911/风景1.jpg
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-01 18:16:29
token String

标记表单数据是否已读

API地址 : /cmsmanager/smartFormData

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
read Boolean true 已读true 未读false
ids Array [34]
 |-0 Number 34

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-03 08:45:33
token String

表单修改(标题描述、分组)

API地址 : /cmsmanager/smartForm/simpleUpdate

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
title String 投诉表单3332 标题
description String 投诉表单2 描述
typeId Number 60 分组
id Number 476

响应参数

名称 类型 初始值 说明
code Number 200
data Number 476
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-04-30 14:27:13
token String

结果数据分页

API地址 : /cmsmanager/smartFormData/getPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
formId Number 表单ID
isRead Boolean 是否已读
proviceCode String 省份编码
cityCode String 城市编码
isPc Boolean 是否pc
username String 用户名
ip String IP
createTimeMin String 创建时间最小值
createTimeMax String 创建时间查询最大值
page_sort String 值 id 字段属性
page_sort_dir String 值 desc 和 asc 降序和升序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— datas Array 结果数据数组
      |— required Boolean 是否必填题
      |— val Object 字段显示值 ,资源、和图片单选多选是特殊的
      |— label String 字段标签
      |— field String 字段
   |— content Array
      |— address String 区域
      |— attrMap Object 结果数据
         |— imageRadio String 8 所有key都是字段名称
         |— select String 2
         |— address String 滨江一号
         |— videoUpload Object 视频类型字段
            |— id Number 255 资源id
            |— pdfPath String PDF路径
            |— resAlias String 1(161) 名称
            |— resDesc String 图片描述
            |— resDuration String 00:00:07 视频时长
            |— resId Number 24998 资源库id
            |— sizeUnit String 808KB 资源大小
            |— url String /u/cms/www/202002/261614585wab.mp4 资源路径
         |— city String
         |— imageUpload Object
            |— id Number 254
            |— pdfPath String
            |— resAlias String 1(160)
            |— resDesc String
            |— resDuration String 00:00:00
            |— resId Number 24997
            |— sizeUnit String 858KB
            |— url String /u/cms/www/202002/2616145550g5.jpg
         |— title String 我的第2封信件
         |— fileUpload Array
            |— id Number 45
            |— pdfPath String /u/cms/www/202002/261615001jrg.pdf
            |— resAlias String 1(162)
            |— resDesc String
            |— resDuration String
            |— resId Number 24999
            |— sizeUnit String 27KB
            |— url String /u/cms/www/202002/261615001jrg.txt
         |— content String 我的第2封信件内容呢
         |— radio String 2
         |— datetime String 2020-01-10
         |— multiImageUpload Array
            |— id Number 47
            |— pdfPath String /u/cms/www/202002/26161500enll.pdf
            |— resAlias String 8(3)
            |— resDesc String 111,2222
            |— resDuration String
            |— resId Number 25001
            |— sizeUnit String 121KB
            |— url String /u/cms/www/202002/26161500enll.png
         |— imageCheckbox String ["4"]
         |— checkbox String ["1"]
      |— city Null null
      |— cityCode String
      |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
      |— createTime String 2020-02-26 16:14:55 创建时间
      |— createUser String system
      |— formId Number 92
      |— id Number 73
      |— ip String 0:0:0:0:0:0:0:1 ip
      |— isPc Boolean true 是否pc
      |— isRead Boolean false 是否已读
      |— isRecycle Boolean false
      |— province Null null
      |— provinceCode String
      |— systemInfo String PC 网络设备
      |— updateTime Null null
      |— updateUser String
      |— user Object 用户信息
         |— id Number 1
         |— realname String 管理员
         |— username String system
      |— userId Number 1
      |— wxopenId String
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 13
   |— totalPages Number 2
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:24:23
token String

表单数据-查询详情

API地址 : /cmsmanager/smartFormData/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— address String
   |— attrMap Object
      |— imageRadio String 8
      |— select String 2
      |— address String 滨江一号
      |— videoUpload Object
         |— id Number 255
         |— pdfPath String
         |— resAlias String 1(161)
         |— resDesc String
         |— resDuration String 00:00:07
         |— resId Number 24998
         |— sizeUnit String 808KB
         |— url String /u/cms/www/202002/261614585wab.mp4
      |— city String
      |— imageUpload Object
         |— id Number 254
         |— pdfPath String
         |— resAlias String 1(160)
         |— resDesc String
         |— resDuration String 00:00:00
         |— resId Number 24997
         |— sizeUnit String 858KB
         |— url String /u/cms/www/202002/2616145550g5.jpg
      |— title String 我的第2封信件
      |— fileUpload Array
         |— id Number 45
         |— pdfPath String /u/cms/www/202002/261615001jrg.pdf
         |— resAlias String 1(162)
         |— resDesc String
         |— resDuration String
         |— resId Number 24999
         |— sizeUnit String 27KB
         |— url String /u/cms/www/202002/261615001jrg.txt
      |— content String 我的第2封信件内容呢
      |— radio String 2
      |— datetime String 2020-01-10
      |— multiImageUpload Array
         |— id Number 46
         |— pdfPath String /u/cms/www/202002/26161500psxb.pdf
         |— resAlias String 4(11)
         |— resDesc String 111,2222
         |— resDuration String
         |— resId Number 25000
         |— sizeUnit String 122KB
         |— url String /u/cms/www/202002/26161500psxb.png
      |— imageCheckbox String ["4"]
      |— checkbox String ["1"]
   |— city Null null
   |— cityCode String
   |— cookieIdentity String 448592e3-493f-40b5-b8f8-84628eebdee9
   |— createTime String 2020-02-26 16:14:55
   |— createUser String system
   |— formId Number 92
   |— id Number 73
   |— ip String 0:0:0:0:0:0:0:1
   |— isPc Boolean true
   |— isRead Boolean false
   |— isRecycle Boolean false
   |— province Null null
   |— provinceCode String
   |— systemInfo String PC
   |— updateTime Null null
   |— updateUser String
   |— user Object
      |— id Number 1
      |— realname String 管理员
      |— username String system
   |— userId Number 1
   |— wxopenId String
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:30:03
token String

删除表单数据

API地址 : /cmsmanager/smartFormData/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [28,32]
 |-0 Number 28

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:34:09
token String

报表

API地址 : /cmsmanager/smartForm/statistic/groupByField/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— data Null null 饼状图数据(null则说明是其他字段)
   |— field String title 字段名称
   |— itemLabel String 标题 字段标签
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:35:12
token String

按设备统计

API地址 : /cmsmanager/smartForm/statistic/device/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— mobileCount Number 0 移动端数量
   |— pcCount Number 13 pc端数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:37:28
token String

地区统计

API地址 : /cmsmanager/smartForm/statistic/province/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— dataCount Number 6 数量
   |— province String 江西 省份
   |— ratio Number 0.4615 比例
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:49:56
token String

趋势统计

API地址 : /cmsmanager/smartForm/statistic/trend/${id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
pc Boolean 是否pc
province String 城市编号
city String 城市编号
showType Number 1按时显示 2按天显示 3 按周显示 4按月统计
endTime String 查询结束时间
beginTime String 查询开始时间

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— count Number 0 数量
   |— time String 2020-01-01-2020-01-31 时间区段key
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-02-26 16:51:02
token String

新增会员

API地址 : /cmsmanager/members

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增会员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 大西瓜 用户名
email String 1251254654@qq.com 邮箱
userGroup Number 1 用户组
userLevel Number 1 用户等级
telephone String 798795465 手机
psw String Kh2+07MaeeQ= 密码
integral Number 0 积分
realname String Siri 真实姓名
status Boolean true true启用false不启用
json Object 自定义对象
 |-fax_Wu1i9z String 这是传真 传真标签名称
 |-input_cxQXwC String 个性签名 输入框标签名称
 |-city_c981df Object 城市自定义对象
  |-provinceCode Number 1001 省级CODE
  |-cityCode Number 1002 城市CODE
 |-address_UkoQ9D Object 地址对象
  |-provinceCode Number 1001 省级CODE
  |-cityCode Number 1002 城市CODE
  |-areaCode Number 1003 地区code
  |-address String 西湖区观洲阳光小区 地址
 |-imageUpload_lqPB7R Number 98 单图上传标签

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555492604597
token String

修改会员

API地址 : /cmsmanager/members

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改会员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 262 用户ID
email String 1251254654@qq.com 邮箱
userGroup Number 1 用户组ID
userLevel Number 1 用户等级
telephone String 798795465 电话
psw String Kh2+07MaeeQ= 密码(不修改传空)
integral Number 0 积分
realname String Siri 真实姓名
status Boolean true true 启用 false 不启用
json Object 自定义对象
 |-fax_Wu1i9z String 这是传真 传真标签
 |-input_cxQXwC String 个性签名 个性签名标签
 |-city_c981df Object 城市自定义对象
  |-provinceCode Number 1001 省级CODE
  |-cityCode Number 1002 城市CODE
 |-address_UkoQ9D Object 地址自定义对象
  |-provinceCode Number 1001 省级CODE
  |-cityCode Number 1002 城市CODE
  |-areaCode Number 1003 区域code
  |-address String 西湖区观洲阳光小区 地址
 |-imageUpload_lqPB7R Number 98 单图上传便签

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555492604597
token String

会员待审核列表

API地址 : /cmsmanager/members/audit

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员待审核列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
checkStatus Number 审核状态0待审核2审核不通过
key String 用户名/邮箱
page Number 页数
size Number 数量
sourceSite Number 来源站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— enabled Boolean 是否启用
      |— createTime String 注册时间
      |— sourceSiteName String 来源站点名称
      |— id Number 用户ID
      |— checkStatus Boolean true true启用false不启用
      |— userLevel String 铜牌会员 等级名称
      |— integral Number 0 积分
      |— telephone String 5464654 手机
      |— userGroup String 研发二组 分组名称
      |— email String 89798165@qq.com 邮箱
      |— realname String Siri 真实姓名
      |— username String 黎明 用户名
      |— status Number 0 用户审核状态(1审核通过、2审核不通过 0待审核)
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563247548703
token String

审核通过

API地址 : /cmsmanager/members/on

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 审核通过

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [3] 会员ID
 |-0 Number 3

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555493127216
token String

审核不通过

API地址 : /cmsmanager/members/off

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 审核不通过

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [3] 会员ID
 |-0 Number 3
reason String 审核不通过原因

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555493127216
token String

会员详情

API地址 : /cmsmanager/members/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— registerTime String 注册时间
   |— siteName String 来源站点名称
   |— dataField Object 自定义对象
      |— status Number 用户审核状态(1审核通过、2审核不通过 0待审核)
      |— address_rvbkxi Object 地址对象
         |— areaCode String 1001 区域CODE
         |— address String 1001 地址
         |— provinceCode String 1001 省级CODE
         |— cityCode String 城市CODE
      |— password String ef1fb92fa79d65f0b6dc85bb54b0cb40019aa4cb 密码
      |— checkStatus Boolean true true 启用 false 不启用
      |— userLevel Number 1 用户等级
      |— integral Number 0 积分
      |— imageUpload_WQIZPN Object 单图对象
         |— id Number 98 资源ID
         |— url String /u/cms/www/201907/03150423xuxr.png 路径
      |— telephone String 546613231 手机号
      |— userGroup Number 1 用户组
      |— email String 789121654661@qq.com 邮箱
      |— city_DrWdPU Object 城市对象
         |— provinceCode String 1001 省级CODE
         |— cityCode String 1001 城市CODE
      |— realname String Siri 真实姓名
      |— username String 刘德华 用户名
   |— id Number 332 会员ID
   |— renderingField Object 前台渲染字段内容
      |— formListBase Array
         |— preview String DGroupPreview
         |— editor String DGroupEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 2
         |— groupIndex Number 1
         |— type String group
         |— 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 userGroup
            |— options Array []
            |— isSmsVerification Boolean false
            |— tip String
            |— label String 所属会员组
            |— placeholder String 请输入内容
            |— isSmsFindPassword Boolean false
            |— isRegister Boolean false
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563244091178
token String

会员管理列表

API地址 : /cmsmanager/members

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员管理列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
enabled Boolean 是否启用true启用false不启用
key String 关键字
groupId Number 会员组ID
levelId Number 等级ID
sourceSite Number 来源站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— email String 85412321@qq.com 邮箱
      |— enabled Boolean true true启用false不启用
      |— id Number 342 用户ID
      |— integral Number 0 积分
      |— sourceSite Object 来源站点
         |— id Number 242 站点ID
         |— name String jeecms子站5 站点名称
      |— userExt Object 扩展对象
         |— realname String Siri 真实姓名
      |— userGroup Object 用户组
         |— groupName String 研发二组 组名
      |— userLevel Object 等级对象
         |— levelName String 铜牌会员 等级名称
      |— username String 郭富城 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563245547899
token String

修改积分配置

API地址 : /cmsmanager/members/score

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 修改积分配置

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
submitStatus String 1 投稿状态
submitSuccessNumber String 1 每成功投稿篇数
submitSuccessScore String 1 获得积分
submitScoreLimit String 1 积分获取限制
submitOnedayMaxScore String 1 每日投稿最多可获取积分
commentStatus String 1 评论状态
commentSuccessNumber String 1 每成功投稿篇数
commentSuccessScore String 1 获得积分
commentScoreLimit String 1 积分获取限制
commentOnedayMaxScore String 1 每日投稿最多可获取积分
registerStatus String 1 注册状态
registerSuccessScore String 1 注册成功获得积分
perfectMessageStatus String 1 完善信息状态
perfectMessageSuccessScore String 1 完善个人信息获得积分

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556259103196
token String

积分配置详情

API地址 : /cmsmanager/members/score

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 积分配置详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— cmsSiteCfg Object
      |— commentOnedayMaxScore String 1 每日评论最多可获取积分
      |— commentScoreLimit String 1 评论积分获取限制
      |— commentStatus String 1 评论状态
      |— commentSuccessNumber String 1 每评论成功投稿篇数
      |— commentSuccessScore String 1 评论获得积分
      |— perfectMessageStatus String 1 完善信息状态
      |— perfectMessageSuccessScore String 1 完善个人信息获得积分
      |— registerStatus String 1 注册状态
      |— registerSuccessScore String 1 注册成功获得积分
      |— submitOnedayMaxScore String 1 每日投稿最多可获取积分
      |— submitScoreLimit String 1 积分获取限制
      |— submitStatus String 1 投稿状态
      |— submitSuccessNumber String 1 每成功投稿篇数
      |— submitSuccessScore String 1 投稿获得积分
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556259166044
token String

会员模型字段

API地址 : /cmsmanager/members/addition/model

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员模型字段

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— enableJson Object
      |— formListBase Array
         |— preview String DLevelPreview
         |— editor String DLevelEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 5
         |— groupIndex Number 2
         |— type String level
         |— disableFields Array ["label","name","isRegister"]
            |— 0 String label
         |— hiddenFields Array ["placeholder","isSmsVerification","isSmsFindPassword"]
            |— 0 String placeholder
         |— dragable Boolean true
         |— name String 会员等级
         |— isCustom Boolean false
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean false
            |— defaultValue String
            |— name String userLevel
            |— options Array []
            |— isSmsVerification Boolean false
            |— tip String
            |— label String 会员等级
            |— isSmsFindPassword Boolean false
            |— isRegister Boolean false
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562898180059
token String

会员启用

API地址 : /cmsmanager/members/enable

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 启用会员(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2]
 |-0 Number 2

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

禁用会员

API地址 : /cmsmanager/members/disable

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 禁用会员(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 用户ID集合
 |-0 Number 2

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

会员删除

API地址 : /cmsmanager/members/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 会员删除(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2]
 |-0 Number 2

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

待审核会员动态字段

API地址 : /cmsmanager/members/addition

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 待审核会员动态字段

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— label String 密码 标签
   |— value String password
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563159972984
token String

分页查询会员组信息

API地址 : /cmsmanager/memberGroup/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 1 页数
size Number 1 每页的条数
groupName String 一组 用户组名称

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的数组
      |— groupName String 研发一组 用户组名称
      |— id Number 3 会员组对象ID
      |— isDefault Boolean true 是否为默认组
      |— remark String 这是研发一组,简单介绍这小组是干什么的,为公司研发软件的小组 描述
      |— remarkInfo String 这是研发一组,简单介绍这小组是干什么的,... 描述信息(分页时使用,当字数超过20个字时。超过的部分用...显示)
   |— first Boolean true 第一条
   |— last Boolean true 最后一条
   |— size Number 10 大小
   |— totalElements Number 2 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555317488159 时间戳
token String 系统验证token

获取详细会员组信息

API地址 : /cmsmanager/memberGroup/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: id直接在URL后面

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— isAllChannelContribute Boolean 是否所有栏目投稿权限
   |— isAllChannelView Boolean 是否所有栏目浏览权限
   |— contributes Array 栏目投稿集合
      |— id Number 1 栏目ID
   |— views Array 栏目浏览集合
      |— id Number 1 栏目ID
   |— groupName String 研发一组 组名
   |— id Number 22 组ID
   |— isDefault Boolean false 是否默认true 默认 false 非默认
   |— remark String 这是研发一组 备注
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558677090480
token String

添加会员组信息

API地址 : /cmsmanager/memberGroup

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
groupName String 研发二组 会员组名
remark String 这是研发二组 备注
isDefault Boolean true 是否默认
isAllChannelView Boolean false 是否具有栏目浏览全部权限,true是,false否
isAllChannelContribute Boolean false 是否具有栏目投稿全部权限,true是,false否
views Array [1] 浏览栏目ID集合
 |-0 Number 1
contributes Array [1] 投稿栏目ID集合
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555318015258 时间戳
token String 系统验证token

修改会员组信息

API地址 : /cmsmanager/memberGroup

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
groupName String 研发一组 用户组名称
remark String 这是研发一组,简单介绍这小组是干什么的,我也不知道,我就是为了凑字数 描述
isDefault Boolean true 是否为默认组
id Number 3 会员组对象ID
isAllChannelView Boolean 是否拥有栏目浏览权限true 是false 没有
isAllChannelContribute Boolean 栏目投稿权限
views Array 浏览栏目ID
contributes Array 投稿栏目ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555318227026 时间戳
token String 系统验证token

删除会员组信息

API地址 : /cmsmanager/memberGroup/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 会员组对象ID集合
 |-0 Number 1 会员组对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555318227026 时间戳
token String 系统验证token

会员组列表

API地址 : /cmsmanager/memberGroup/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员组列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— groupName String 测试 会员组名称
   |— id Number 52 会员组ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562893990192
token String

成员管理

API地址 : /cmsmanager/memberGroup/list/users

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 成员管理

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
groupId Number 会员组ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— enabled Boolean 是否启用,true启用false禁用
      |— admin Boolean false 是否管理员
      |— checkStatus Number 1 审核状态(1审核通过、2审核不通过 0待审核)
      |— createTime Number 1562897128000 创建时间
      |— email String 1251254654@qq.com 邮箱
      |— id Number 272 用户ID
      |— integral Number 0 积分
      |— memberAttrs Array
         |— areaCode String 地域code
         |— attrName String birthday_qgFKdw 扩展字段名
         |— attrType String birthday 数据类型
         |— attrValue String 扩展字段值
         |— cityCode String 城市CODE
         |— provinceCode String 省级CODE
         |— resourcesSpaceData Object null
            |— url String 资源路径
            |— id Number 资源ID
      |— sourceSite Object
         |— id Number 1 站点ID
         |— name String jeecms主站 站点名称
      |— userExt Object
         |— birthday Null null 生日
         |— gender Number 1 1.男2.女3.保密
         |— lockedIp String 锁定IP
         |— lockedTime Null null 锁定时间
         |— realname String Siri 真实姓名
         |— remark String 备注 备注
         |— telephone String 798795465 电话
      |— userGroup Object 用户组对象
         |— groupName String 研发二组 组名
         |— isDefault Boolean true 是否默认
         |— remark String 这是研发二组 备注
      |— userLevel Object 会员等级对象
         |— integralMax Number 1000 积分最大值
         |— integralMin Number 0 积分最小值
         |— levelName String 铜牌会员 等级名称
         |— remark String 会员等级,等级分为不同阶段需要不同的积分,字数超过20了吗 备注
      |— username String 大西瓜 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562898097363
token String

添加成员

API地址 : /cmsmanager/memberGroup/list/users

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 添加成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 62 会员组ID
userId Array [262]
 |-0 Number 262 用户ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562893802507
token String

移动成员

API地址 : /cmsmanager/memberGroup/list/users

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 移动成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 62 会员组ID
userId Array [262]
 |-0 Number 262 用户ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562893802507
token String

分页获取会员等级信息

API地址 : /cmsmanager/memberLevel/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
levelName String 银牌 会员等级名称
page Number 1 页数
size String 1 每页的条数

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的数组
      |— id Number 12 会员等级对象ID
      |— integralMax Number 1000 等级积分范围最大值
      |— integralMin Number 0 等级积分范围最小值
      |— levelIcon Number 1 logo资源id
      |— levelName String 铜牌会员 会员等级名称
      |— logoResource Object 会员图片资源对象
         |— id Number 1 会员图片资源对象ID
         |— url String /u/gou/www/201903/08183341elrk.jpg 会员图片地址
      |— remark String 会员等级,等级分为不同阶段需要不同的积分,字数超过20了吗 描述信息
      |— remarkInfo String 会员等级,等级分为不同阶段需要不同的积分... 分页时显示的描述信息(超过20个字后面的文字用...代替显示)
   |— first Boolean true 第一条
   |— last Boolean true 最后就一条
   |— size Number 10 大小
   |— totalElements Number 1 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555313558082 时间戳
token String 系统验证token

获取详细会员等级信息

API地址 : /cmsmanager/memberLevel/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— id Number 12 会员等级对象ID
   |— integralMax Number 1000 等级积分范围最大值
   |— integralMin Number 0 等级积分范围最小值
   |— levelIcon Number 1 logo资源id
   |— levelName String 铜牌会员 会员等级名称
   |— logoResource Object 会员图片资源对象
      |— id Number 1 会员图片资源对象ID
      |— url String /u/gou/www/201903/08183341elrk.jpg 会员图片地址
   |— remark String 会员等级,等级分为不同阶段需要不同的积分,字数超过20了吗 备注
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555314073775 时间戳
token String 系统验证token

添加会员等级信息

API地址 : /cmsmanager/memberLevel

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
levelName String 银牌会员 会员等级名称
integralMin Number 1001 等级积分范围最小值
integralMax Number 5000 等级积分范围最大值
levelIcon Number 1 logo资源id
remark String 会员等级,等级分为不同阶段需要不同的积分,字数超过20了吗 备注

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555314073775 时间戳
token String 系统验证token

修改会员等级信息

API地址 : /cmsmanager/memberLevel

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
levelName String 银牌会员 会员等级名称
integralMin Number 1001 等级积分范围最小值
integralMax Number 5888 等级积分范围最大值
levelIcon Number 1 logo资源id
remark String 会员等级,等级分为不同阶段需要不同的积分,字数超过20了吗 备注
id Number 13 会员等级对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555314073775 时间戳
token String 系统验证token

删除会员等级信息

API地址 : /cmsmanager/memberLevel/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12,13,14,15] 会员等级对象ID集合
 |-0 Number 12 会员等级对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555314073775 时间戳
token String 系统验证token

会员等级列表

API地址 : /cmsmanager/memberLevel/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 会员等级列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— levelName String 测试 等级名称
   |— id Number 52 等级ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562893990192
token String

积分配置详情

API地址 : /cmsmanager/members/score

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 积分配置详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— cmsSiteCfg Object
      |— commentOnedayMaxScore String 每日评论最多可获取积分
      |— commentScoreLimit String 积分获取限制
      |— commentStatus String 评论状态
      |— commentSuccessNumber String 每成功评论
      |— commentSuccessScore String 获得积分
      |— perfectMessageStatus String 完善信息状态
      |— perfectMessageSuccessScore String 完善个人信息获得积分
      |— registerStatus String 注册状态
      |— registerSuccessScore String 注册成功获得积分
      |— submitOnedayMaxScore String 每日投稿最多可获取积分
      |— submitScoreLimit String 积分获取限制
      |— submitStatus String 投稿状态
      |— submitSuccessNumber String 每成功投稿篇数
      |— submitSuccessScore String 获得积分
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563175669381
token String

修改积分配置

API地址 : /cmsmanager/members/score

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 修改积分配置

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
submitStatus String 1 投稿状态
submitSuccessNumber String 1 每成功投稿篇数
submitSuccessScore String 1 获得积分
submitScoreLimit String 1 积分获取限制
submitOnedayMaxScore String 1 每日投稿最多可获取积分
commentStatus String 1 评论状态
commentSuccessNumber String 1 每成功评论
commentSuccessScore String 1 获得积分
commentScoreLimit String 1 积分获取限制
commentOnedayMaxScore String 1 每日评论最多可获取积分
registerStatus String 1 注册状态
registerSuccessScore String 1 注册成功获得积分
perfectMessageStatus String 1 完善信息状态
perfectMessageSuccessScore String 1 完善个人信息获得积分

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563176379721
token String

新增组织

API地址 : /cmsmanager/orgs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 新增组织

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
parentId Null null 父结点(默认传空)
code String 134 组织代码
name String 研发部-安卓 组织名称
orgNum String 1000 组织编号
orgLeader String Sirry 组织负责人
phone String 123546546468 电话
orgFax String 0791-5465464 传真
orgRemark String 这是研发部-安卓 描述
isVirtual Boolean false 是否虚拟组织(true是,反之相反)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555299021224
token String

修改组织

API地址 : /cmsmanager/orgs

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改组织

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1105 组织ID
parentId Null null 父结点ID
code String 134 组织代码
name String 研发部-IOS 组织名称
orgNum String 1000 组织编号
orgLeader String Sirry 组织负责人
phone String 123546546468 电话
orgFax String 0791-5465464 传真
orgRemark String 这是研发部-安卓 描述
isVirtual Boolean false 是否虚拟

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555299021224
token String

组织详情

API地址 : /cmsmanager/orgs/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— managerAble String true可管理,false不可管理
   |— nodeIds Array 结点集合
   |— isVirtual Boolean 是否虚拟组织
   |— createUser String 创建人
   |— createTime String 创建时间
   |— id Number 1105 组织ID
   |— name String 研发部-IOS 组织名称
   |— orgFax String 0791-5465464 传真
   |— orgLeader String Sirry 负责人
   |— orgNum String 1000 编号
   |— orgRemark String 这是研发部-安卓 描述
   |— parent Object 父结点对象
      |— id Number 1
      |— name String 研发部
      |— orgFax String
      |— orgLeader String
      |— orgNum String 10
      |— orgRemark String
      |— parent Null null
      |— parentId Null null
      |— phone String
   |— parentId Number 1 父结点ID
   |— phone String 123546546468 电话
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555300185814
token String

组织列表

API地址 : /cmsmanager/orgs/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isVirtual Boolean 虚拟组织
key String 组织名/组织编号/组织负责人
parentId Number 父结点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— createUser String 创建人
   |— createTime String 创建时间
   |— isVirtual String 是否虚拟组织
   |— managerAble Boolean 是否可管理,true是 false否
   |— id Number 1 组织ID
   |— name String 研发部 组织名称
   |— orgLeader String 负责人
   |— orgNum String 10 组织编号
   |— phone String 电话
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555308890548
token String

成员管理(列表分页)

API地址 : /cmsmanager/orgs/list/users

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 成员管理(列表分页)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 页数
size Number 数量
id String 组织Id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 用户ID
      |— email String admin@jeecms.com 邮箱
      |— telephone String 电话
      |— userExt Object
         |— realname String siri 真名
         |— linephone String 01654644 座机
      |— username String admin 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 5
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555311640175
token String

移除成员

API地址 : /cmsmanager/orgs/list/users

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 移除成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 目标组织ID
userId Array [1] 用户ID数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555314112685
token String

组织树形结构

API地址 : /cmsmanager/orgs/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织树形结构

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
parentId String 父结点ID
permIgnore Boolean 是否忽略比较权限大小 (列表查询不比较 传true,新建和修改比较 传false)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— name String 研发部 组织名称
   |— id Number 1 组织ID
   |— children Array 子组织
      |— name String 研发部-IOS
      |— id Number 1105
      |— parentId Number 1
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555315289596
token String

组织添加成员

API地址 : /cmsmanager/orgs/list/users

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织添加成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 组织ID
userId Array [1] 用户ID
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555316786328
token String

删除组织

API地址 : /cmsmanager/orgs/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除组织(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 组织ID
 |-0 Number 2
type Number 1 类型(1正常操作2.继续操作)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557046424144
token String

组织排序

API地址 : /cmsmanager/orgs/sort

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织排序

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 组织ID
orderOrgId Number 被排序的组织ID
up Boolean true向上false向下

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562232881567
token String

验证组织名称

API地址 : /cmsmanager/orgs/orgname/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证组织名称

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgname String 组织名称
id Number 组织ID,修改必传

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false false验证不通过true通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562292174954
token String

组织树形(无权限控制)

API地址 : /cmsmanager/orgs/tree/noauth

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织树形(无权限控制)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— children Array 子结点
         |— children Array
            |— name String 城建一号 名称
            |— id Number 145 唯一标识符
            |— parentId Number 143 父结点
         |— name String 三亚小组
         |— id Number 143
         |— parentId Number 142
      |— name String 项目部
      |— id Number 142
      |— parentId Number 1
   |— name String 金磊科技
   |— id Number 1
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-08 14:40:39
token String

新增角色

API地址 : /cmsmanager/roles

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增角色

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
roleName String 研发人员 角色名称
description String 负责研发 描述
orgid Number 1 组织ID

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554886589725
token String

角色详情

API地址 : /cmsmanager/roles/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 角色详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— managerAble String true可管理,false不可管理
   |— org Object 组织对象
      |— nodeIds Array 组织节点
      |— id Number 组织ID
   |— orgCode String 组织编号
   |— roleName String 角色名称
   |— orgid Number 组织ID
   |— description String 负责研发 描述
   |— id Number 1 角色ID
   |— orgName String 研发部 组织名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554886869285
token String

角色修改

API地址 : /cmsmanager/roles

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 角色修改

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id String 1 角色ID
roleName String 研发人员修改 角色名称
description String 负责研发 描述
orgid Number 1 组织ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554886909141
token String

角色列表

API地址 : /cmsmanager/roles/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 角色列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
roleName String 角色名称
orgId Number 组织ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 角色ID
   |— roleName String 研发人员修改 角色名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887010990
token String

成员管理(列表分页)

API地址 : /cmsmanager/roles/list/users

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 成员管理

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 角色ID
page Number 页数
size String 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— users Array 成员列表
      |— id Number 用户ID
      |— email String 879894@qq.com 邮箱
      |— telephone String 465464646 电话
      |— userExt Object 用户扩展对象
         |— realname String 小红 真实姓名
         |— linephone String 0791-85256582 座机
      |— username String 小白图 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887519176
token String

角色列表分页

API地址 : /cmsmanager/roles/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 角色列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
roleName String 角色名称
orgid Number 组织ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— managerAble Boolean 是否可管理,true可管理false不可管理
      |— createUser String 创建人
      |— createTime String 创建时间
      |— id Number 2 角色ID
      |— orgName String 研发部 组织名称
      |— roleName String 研发人员修改 角色名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554861894423
token String

删除角色

API地址 : /cmsmanager/roles/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除角色(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 角色ID组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554862508243
token String

移除成员

API地址 : /cmsmanager/roles/list/users/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 移除成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 角色ID
userId Array [1] 用户ID
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555314112685
token String

角色添加成员

API地址 : /cmsmanager/roles/list/users

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 角色添加成员

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 角色ID
userId Array [1] 用户ID数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555316786328
token String

新增用户

API地址 : /cmsmanager/users

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增用户

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 小白图 用户名
psw String Kh2+07MaeeQ= 密码
realname String 小红 真实姓名
telephone String 0791-85256582 座机号
usePhone String 465464646 手机号
email String 879894@qq.com 邮箱
enabled Boolean true 是否启用,true启用,false禁止
roleid Array [1] 角色ID
 |-0 Number 1
orgid Number [1] 组织ID
userSecretId Number 人员密级

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554862508243
token String

用户列表分页

API地址 : /cmsmanager/users/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
enabled Boolean 是否启用,true启用,false 禁用
orgid Number 组织ID
roleid Number 角色ID
key String 关键字(用户名,邮箱,电话,真名,手机)
userSecretId Number 人员密级ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— userSecretName String 密级名称
      |— itself Boolean 是否本系统用户,true是,false不是
      |— createTime String 创建时间
      |— createUser String system 创建人
      |— enabled Boolean true 是否启用
      |— id Number 24 用户ID
      |— managerAble Boolean true 是否可管理
      |— orgName String 研发部 组织名
      |— roleNames String 角色 角色名称
      |— userExt Object
         |— realname String 小红 真名
      |— username String ljw 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560242844472
token String

修改用户

API地址 : /cmsmanager/users

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改用户

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 62 用户ID
realname String 小红 真实姓名
telephone String 0791-85256582 座机
usePhone String 15285457845 手机
email String 123456789@qq.com 邮箱
enabled Boolean true 是否启用,true启用,false禁用
roleid Array [] 角色ID
orgid Number [] 组织ID
userSecretId Number 密级ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885276222
token String

用户详情

API地址 : /cmsmanager/users/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— org Object 组织对象
      |— nodeIds Array 节点ID
      |— id Number 组织ID
   |— roleIds Array 角色ID集合
      |— userSecretId Number 人员密级ID
   |— orgId Number 组织ID
   |— createUser String 创建人
   |— createTime String 创建时间
   |— email String 123456789@qq.com 邮箱
   |— enabled Boolean false 是否启用,true启用,false禁止
   |— id Number 62 用户ID
   |— orgName String 组织名称
   |— roleNames String 角色名称
   |— telephone String 15285457845 手机号
   |— userExt Object
      |— realname String 真实姓名
      |— linephone String 0791-85256582 座机号
   |— username String 小白 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554890018019
token String

删除用户

API地址 : /cmsmanager/users/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除用户(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 用户ID集合
 |-0 Number 2
type Number 1 类型(1正常操作2.继续操作)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

启用用户

API地址 : /cmsmanager/users/on

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 启用用户(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 用户ID集合
 |-0 Number 2
type Number 1 类型(1正常操作2.继续操作)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

禁用用户

API地址 : /cmsmanager/users/off

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 禁用用户(返回不可操作数据时,弹出提示框,继续点击Type 传2)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 用户ID集合
 |-0 Number 2
type Number 1 类型(1正常操作2.继续操作)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885428064
token String

验证用户名

API地址 : /cmsmanager/users/username/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证用户名

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true通过验证,反之相反
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885929818
token String

验证邮箱

API地址 : /cmsmanager/users/mail/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证邮箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mail String 邮箱
id Number 用户ID,修改要传

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true验证通过,反之相反
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885929818
token String

验证手机号

API地址 : /cmsmanager/users/phone/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 验证手机号

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
phone String 手机号
id String 用户ID,修改要传

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true验证通过,反之相反
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554885929818
token String

验证密码格式

API地址 : /cmsmanager/users/pwd/unique

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 验证密码格式

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
psw String Kh2+07MaeeQ= 加密后的密码
username String 大西瓜 用户名

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true验证通过,false验证不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556244305733
token String

第三方平台(微信/微博)管理员列表

API地址 : /cmsmanager/users/third/manager/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
appId String wxwss 公众号、小程序、微博appId
isWechat Boolean true 是否是查询微信
username String 小红 用户名/真实姓名
roleid Number 1 角色id
orgId Number 1 组织id
page Number 1 页码
size Number 1 每页最大的容纳数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 24 用户id
      |— org Object 组织对象
         |— name String 研发部 组织名称
      |— roleNames String 角色 角色名称
      |— userExt Object 用户扩展对象
         |— realname String 小红 用户真实姓名
      |— username String ljw 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560224785307
token String

修改密码(重置密码)

API地址 : /cmsmanager/users/psw

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 修改密码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 24 用户ID
psw String dm68n4dEeZA= 密码(加密后)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561189669773
token String

后台登录修改密码

API地址 : /cmsmanager/users/adminpsw

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 后台登录修改密码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
oldpsw String Kh2+07MaeeQ= 原密码,加密
psw String Kh2+07MaeeQ= 新密码,加密

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 15:39:24
token String

管理员用户列表

API地址 : /cmsmanager/users/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 管理员用户列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 用户ID
   |— username String system 用户名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-28 14:58:47
token String

获取系统设置信息

API地址 : /cmsmanager/config/global

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— attrs Object 系统属性集合
      |— systemFlagResourceUrl String 系统标志资源URL
      |— templateFile String 模板文件存储服务器
      |— dataBackupsMemory String 数据备份文件存储服务器
      |— templateFileType String 模板文件存储服务器1本地服务器 2.FTP
      |— processingMode String 0请选择 1显示验证码 2锁定账号(禁用) 3一定时间内禁止登录 */
      |— sensitiveWordsReplace String 敏感词默认替换
      |— dataBackupsMemoryType String 1 数据备份文件存储服务器类型1本地服务器 2.FTP 3.OSS存储器(默认为1)
      |— openContentIssue String 1 是否开启内容发文字号(1是0否)
      |— openAttachmentSecurity String 1 是否开启附件密级(1是0否)
      |— openContentSecurity String 1 是否开启内容密级(1是0否)
      |— isSensitiveWords String 1 是否允许输入敏感词((1是0否)
      |— memberRegisterExamine String 1 会员注册是否需要审核((1是0否)
      |— isActivationImage String 1 会员注册是否需要图片验证码(1是0否)
      |— IsVisible String 1 组织对所有用户可见(1是0否)
      |— isMemberRegister String 1 是否开启会员注册(1是0否)
      |— isMemberFunction String 1 是否开启会员功能(1是0否)
      |— isContentCode String 1 是否生成内容页二维码(1是0否)
      |— serverPort String 80 端口号
      |— isIntranetSet String 1 是否开启内网设置(1是0否)
      |— openOfficePort String 90 openoffice端口
      |— isBaiduPush String 0 是否开启百度推送(1是0否)
      |— deploymentPath String 部署路径
      |— openOfficeCatalog String openoffice安装目录
      |— baiduPushToken String baidutoken 百度推送Token
      |— wechatSmallImgId String 微信小程序图片ID
      |— wechatPublicNumberImgId String 微信公众号图片ID
      |— sysImgId String 管理端logo图关联ID
      |— loginSysImgId String 管理端登录页logo图关联ID
      |— operIdentityImgId String 用户登录及注册logo图关联ID
      |— frontImgId String 1 logo图关联ID
      |— securityOpen String 0 是否开启安全设置
      |— passMin String 6 密码最小位数
      |— passMax String 20 密码最大位数
      |— passCompositionRule String 0 密码组成规则 1无要求 2必须包含字母和数字 * 3必须包含大写字母、小写字母、数字 4必须包含字母、数字、特殊字符 * 5必须包含大写字母、小写字母、数字、特殊字符
      |— passIsEqually String 0 是否允许密码与用户名相同
      |— passRegularChange String 1 是否强制要求用户定期修改密码
      |— passRegularCycle String 5 强制修改密码周期 单位天
      |— passFirstNeedUpdate String 1 首次登录是否强制要求修改密码
      |— passResetNeedUpdate String 1 修改密码后首次登录是否强制要求修改密码
      |— checkCycle String 0 登录时密码错误校验周期 0则不限制
      |— checkCycleUnit String 1 登录时密码校验周期单位 1天 2时 3分
      |— loginErrorCount String 3 登录时密码最大错误次数
      |— autoLogout String 1 登录后长时间未操作自动退出账号(1是0否)
      |— autoLogoutMinute String 5 自动退出周期 单位分钟
      |— loginMuti String 1 是否允许同一账号异地登录(1是0否)
      |— accountLockAuto String 1 长期未登录锁定账号(1是0否)
      |— accountLockAutoDay String 5 长期未登录锁定账号天数 默认0
   |— id Number 1 系统设置对象ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555040760446
token String

保存系统设置信息

API地址 : /cmsmanager/config/global

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 传入id则为新增操作,否则为修改操作

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
attrs Object 系统属性集合
 |-initPasswd String
 |-systemFlagResourceId String 系统标志资源ID
 |-templateFile String 模板文件存储服务器
 |-dataBackupsMemory String 数据备份文件存储服务器
 |-templateFileType String 1 模板文件存储服务器1本地服务器 2.FTP
 |-processingMode String 处理方式 0请选择 1显示验证码 2锁定账号(禁用) 3一定时间内禁止登录 */
 |-openContentIssue String 0 是否开启内容发文字号(1是0否)
 |-sensitiveWordsReplace String 敏感词默认替换 ,填空表示不替换
 |-dataBackupsMemoryType String 数据备份文件存储服务器1本地服务器 2.FTP 3.OSS存储器(默认为1)
 |-openContentSecurity String 0 是否开启内容密级(1是0否)
 |-openAttachmentSecurity String 0 是否开启附件密级(1是0否)
 |-isSensitiveWords String 1 是否允许输入敏感词(1是0否)
 |-memberRegisterExamine String 1 会员注册是否需要审核(1是0否)
 |-isActivationImage String 1 会员注册是否需要图片验证码(1是0否)
 |-IsVisible String 1 组织对所有用户可见(1是0否)
 |-isMemberFunction String 1 是否开启会员功能(1是0否) 是否开启会员功能
 |-isMemberRegister String 1 是否开启会员注册(1是0否)
 |-deploymentPath String 部署路径
 |-serverPort String 80 端口号
 |-openOfficeCatalog String openoffice安装目录
 |-openOfficePort String 90 openoffice端口号
 |-isBaiduPush String 1 是否开启百度推送(1是0否)
 |-baiduPushToken String baidutoken 百度推送Token(开启百度推送时,此字段必填) 百度推送Token
 |-isIntranetSet String 1 是否开启内网设置(1是0否)
 |-isContentCode String 0 是否生成内容页二维码(1是0否)
 |-loginLimitType String 禁止登录时长类型 1.天 2.小时 3.分钟
 |-loginLimit String 禁止登录时长
 |-securityOpen String 0 是否开启安全设置(1是0否)
 |-passMin String 6 密码最小位数
 |-passMax String 20 密码最大位数
 |-passCompositionRule String 1 密码组成规则 1无要求 2必须包含字母和数字 * 3必须包含大写字母、小写字母、数字 4必须包含字母、数字、特殊字符 * 5必须包含大写字母、小写字母、数字、特殊字符
 |-passIsEqually String 0 是否允许密码与用户名相同(1是0否)
 |-passRegularChange String 1 是否强制要求用户定期修改密码(1是0否
 |-passRegularCycle String 5 强制修改密码周期 单位天
 |-passFirstNeedUpdate String 1 首次登录是否强制要求修改密码(1是0否
 |-passResetNeedUpdate String 1 重置密码后首次登录是否强制要求修改密码(1是0否
 |-checkCycle String 0 登录时密码错误校验周期 0则不限制
 |-checkCycleUnit String 1 登录时密码校验周期单位 1天 2时 3分
 |-loginErrorCount String 3 登录时密码最大错误次数
 |-processingMode String 2 处理方式 1显示验证码 2锁定账号(禁用) 3一定时间内禁止登录
 |-autoLogout String 1 登录后长时间未操作自动退出账号(1是0否
 |-autoLogoutMinute String 5 自动退出周期 单位分钟(开启自动退出时此字段必填)
 |-loginMuti String 1 是否允许同一账号异地登录(1是0否
 |-accountLockAuto String 1 长期未登录锁定账号(1是0否
 |-accountLockAutoDay String 5 长期未登录锁定账号天数 默认0
id String 1 系统设置对象ID(使用场景说明)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555040519869 时间戳
token String 系统验证token

读取系统是否采用国密算法

API地址 : /cmsmanager/config/global/isSmEncrypt

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true是采用国密算法
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-03-18 15:36:47
token String

获取模型信息详情

API地址 : /cmsmanager/model/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 1. enableJson、unEnableJson中的对象的参数值结构就是我当前的传值结构,但是其中对象的具体传值之前是由前端定义,此处传值是前端需要的值,此值是前端配置,如果需要修改或者进行其它操作请通知后台对应修改。 2. enableJson中的集合的排序已经是排序好的,前台无需通过其它方式重新进行排序。

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— enableJson Object 启用字段Json
      |— formListBase Array [[[{"preview":"DColumnPreview","editor":"DColumnEditor","groupType":1,"icon":"jia","index":1,"groupIndex":1,"type":"column","disableFields":["label","name","isRequired"],"hiddenFields":["options"],"dragable":true,"prop":"column_1576572883619_912235","name":"所属栏目","isCustom":false,"canDelete":false,"value":{"isRequired":true,"isOtherOption":false,"isOtherOptionRequired":false,"defaultValue":"","name":"channelId","options":[],"tip":"","label":"所属栏目","otherOption":{"label":"其他","value":999}}}]],[[{"preview":"DReleaseTimePreview","editor":"DReleaseTimeEditor","groupType":1,"icon":"jia","index":2,"groupIndex":2,"type":"releaseTime","disableFields":["label","name"],"hiddenFields":[],"dragable":true,"prop":"releaseTime_1576572883619_574345","name":"发布时间","isCustom":false,"canDelete":false,"value":{"isDefaultNow":true,"isRequired":false,"defaultValue":"","name":"releaseTime","format":"yyyy-MM-dd","accuracy":"HH:mm:ss","tip":"","label":"发布时间","type":"datetime"}}]],[[{"preview":"DTitlePreview","editor":"DTitleEditor","groupType":1,"icon":"jia","index":3,"groupIndex":2,"type":"title","disableFields":["label","name","isRequired"],"hiddenFields":[],"dragable":true,"name":"标题","isCustom":false,"canDelete":false,"value":{"isRequired":true,"min":1,"max":50,"defaultValue":{"titleColor":"#666666","titleIsBold":true,"title":""},"inputLimit":"","name":"title","tip":"","isInputLimit":false,"label":"标题","placeholder":"请输入内容","isLengthLimit":true}}],[{"preview":"DSubTitlePreview","editor":"DSubTitleEditor","groupType":1,"icon":"jia","index":4,"groupIndex":2,"type":"subTitle","disableFields":["label","name"],"hiddenFields":[],"dragable":true,"name":"副标题","isCustom":false,"canDelete":false,"value":{"isRequired":false,"min":1,"max":50,"defaultValue":"","inputLimit":"","name":"shortTitle","tip":"","isInputLimit":false,"label":"副标题","placeholder":"请输入内容","isLengthLimit":true}}]],[[{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":1,"dragable":true,"prop":"multiImageUpload_1576573009540_648238","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_enxHgc","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}},{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":2,"dragable":true,"prop":"multiImageUpload_1576573005487_675966","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_fFJvwo","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}}],[{"preview":"DVideoUploadPreview","editor":"DVideoUploadEditor","groupType":1,"icon":"shipin","index":6,"groupIndex":8,"type":"videoUpload","dragable":true,"prop":"videoUpload_1576573078317_593667","name":"视频上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"MB","size":"50","defaultValue":"","name":"videoUpload_VMHcPt","tip":"","label":"视频上传","type":["mov","mp4","rmvb","3gp","mkv"],"isRegister":false}}]],[[{"preview":"DFileUploadPreview","editor":"DFileUploadEditor","groupType":1,"icon":"fujianshangchuan","index":7,"groupIndex":7,"type":"fileUpload","dragable":true,"prop":"fileUpload_1576573002067_925111","name":"附件上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"MB","size":"10","typeLimit":1,"enableType":"","defaultValue":[],"name":"fileUpload_Q6Hp39","limit":"","disableType":"","tip":"","label":"附件上传","isRegister":false}}]],[[{"preview":"DImageUploadPreview","editor":"DImageUploadEditor","groupType":1,"icon":"dantushangchuan","index":8,"groupIndex":6,"type":"imageUpload","sortWeight":1,"dragable":true,"prop":"imageUpload_1576572997210_261","name":"单图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"KB","size":"","defaultValue":"","name":"imageUpload_Lei1BI","width":"","tip":"","label":"单图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"isRegister":false,"height":""}},{"preview":"DImageUploadPreview","editor":"DImageUploadEditor","groupType":1,"icon":"dantushangchuan","index":8,"groupIndex":6,"type":"imageUpload","sortWeight":2,"dragable":true,"prop":"imageUpload_1576572951690_7109","name":"单图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"KB","size":"","defaultValue":"","name":"imageUpload_vpJMO1","width":"","tip":"","label":"单图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"isRegister":false,"height":""}}]]] 模型主体区域Json集合
         |— 0 Array [[{"preview":"DColumnPreview","editor":"DColumnEditor","groupType":1,"icon":"jia","index":1,"groupIndex":1,"type":"column","disableFields":["label","name","isRequired"],"hiddenFields":["options"],"dragable":true,"prop":"column_1576572883619_912235","name":"所属栏目","isCustom":false,"canDelete":false,"value":{"isRequired":true,"isOtherOption":false,"isOtherOptionRequired":false,"defaultValue":"","name":"channelId","options":[],"tip":"","label":"所属栏目","otherOption":{"label":"其他","value":999}}}]]
      |— formListExtend Array [[[{"preview":"DContentPreview","editor":"DContentEditor","tabName":"content","groupType":1,"tabLabel":"正文","icon":"jia","index":1,"groupIndex":12,"type":"content","dragable":true,"name":"正文内容","isCustom":true,"canDelete":true,"value":{"isRequired":false,"defaultValue":"","name":"content","tip":"","label":"正文内容"}}]]] 模型扩展区域Json集合
         |— 0 Array [[{"preview":"DContentPreview","editor":"DContentEditor","tabName":"content","groupType":1,"tabLabel":"正文","icon":"jia","index":1,"groupIndex":12,"type":"content","dragable":true,"name":"正文内容","isCustom":true,"canDelete":true,"value":{"isRequired":false,"defaultValue":"","name":"content","tip":"","label":"正文内容"}}]]
   |— id Number 1233 模型ID值
   |— isEnable Boolean true 是否启用
   |— isGlobal Number 1 是否全局(1全局 0站点模型)
   |— modelName String 模型2 模型名称
   |— site Object null 站点对象
      |— id Number 1 站点id值
   |— tplType Number 2 模型类型(1-栏目模型 2-内容模型 3会员模型)
   |— unEnableJson Array 未启用字段json
      |— preview String DAbstractPreview
      |— editor String DAbstractEditor
      |— groupType String
      |— icon String jia
      |— index Number 1
      |— groupIndex Number 2
      |— type String abstract
      |— disableFields Array ["label","name"]
         |— 0 String label
      |— hiddenFields Array []
      |— dragable Boolean true
      |— name String 摘要
      |— isCustom Boolean false
      |— canDelete Boolean true
      |— value Object
         |— isRequired Boolean false
         |— min Number 1
         |— max Number 100
         |— defaultValue String
         |— inputLimit String
         |— name String description
         |— link String 自动提取摘要
         |— tip String
         |— isInputLimit Boolean false
         |— label String 摘要
         |— placeholder String
         |— isLengthLimit Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-12-21 11:54:22
token String

模型管理分页信息

API地址 : /cmsmanager/model/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isEnable Boolean true 是否启用 false:禁用 true:启用
tplType Number 1 模型类型(1-栏目模型 2-内容模型 3-会员模型)
isGlobal Number 1 是否全局(1全局 0站点模型) 不传则是所有(全站模型+所属站点创建的本站模型)
modelName String 模型名称
page Number 1 页数
size Number 10 每页条数

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的集合
      |— isGlobal Number 是否全局(1全局模型 0本站模型)
      |— id Number 1 模型对象ID
      |— isEnable Boolean true 是否启用 false:禁用 true:启用
      |— modelName String 新闻 模型名称
      |— siteId Number 1 站点Id
      |— tplType Number 1 模型类型(1-栏目模型 2-内容模型 3-会员模型)
   |— first Boolean true 第一条
   |— last Boolean true 最后一条
   |— size Number 10 大小
   |— totalElements Number 1 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555657919266 时间戳
token String 系统验证token

添加本地模型

API地址 : /cmsmanager/model/thisSite

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelName String 电影 模型名称
isEnable Boolean 0 是否开启 false:禁用 true:启用
tplType Number 1 模型类型(1-栏目模型 2-内容模型 3-会员模型)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555660300679 时间戳
token String 系统验证token

添加全站模型

API地址 : /cmsmanager/model/wholeSite

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelName String 时讯 模型名称
isEnable Boolean 0 是否启用 false:禁用 true:启用
tplType Number 1 模型类型(1-栏目模型 2-内容模型 3-会员模型

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555660300679 时间戳
token String 系统验证token

修改模型信息

API地址 : /cmsmanager/model

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelName String 战事 模型名称
isEnable Boolean 0 是否启用 true:启用 false:禁用
id Number 43 模型对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555660300679 时间戳
token String 系统验证token

是否启用模版信息

API地址 : /cmsmanager/model/isEnable

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isEnable Boolean 1 是否启用 true:启用 false:禁用
id Number 43 模型对象id

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555660300679 时间戳
token String 系统验证token

删除模型信息

API地址 : /cmsmanager/model/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2,3] 模型对象ID集合
 |-0 Number 1 模型对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555660300679 时间戳
token String 系统验证token

校验模型名称是否可用

API地址 : /cmsmanager/model/modelName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelName String 电影 模型名称
tplType Number 1 模型类型 1:栏目 2:内容 3:会员
id Number 模型id,编辑操作下校验为必填参数
isGlobal Number 0:本站模型 1:全站模型

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Boolean false false表示不可用,true表示可用
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555662877166 时间戳
token String 系统验证token

添加模型字段信息

API地址 : /cmsmanager/modelItem

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 1. 下方传值的enableJson标识、unEnableJson标识 仅仅是给前台示意传值,这两个值切记不可作为参数传到后台。 2. enableJson标识、unEnableJson标识中的对象的参数值结构必须和我传值一样,但是其中对象的具体传值是由前端定义,此处传值是前端需要的值,此值是前端配置,如果需要修改或者进行其它操作请通知后台对应修改。 3. enableJson中的JSON集合中的每一个集合都是一个模型区域块,每个区域块中的一个JSON集合都是一列,而每一个列中的JSON对象都是一个字段。每列中的index(排序值)一样,每列中的sortWeight中的排序说明该字段在列中的排序

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelId Number 1233 模型ID值
enableJson String 启用字段,json格式字符串,实际数据由前端定义
unEnableJson String 未启用字段,json格式字符串,实际数据由前端定义
enableJson标识 Object
 |-formListBase Array [[[{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":1,"dragable":true,"prop":"multiImageUpload_1576573009540_648238","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_enxHgc","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}},{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":2,"dragable":true,"prop":"multiImageUpload_1576573005487_675966","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_fFJvwo","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}}],[{"preview":"DVideoUploadPreview","editor":"DVideoUploadEditor","groupType":1,"icon":"shipin","index":6,"groupIndex":8,"type":"videoUpload","dragable":true,"prop":"videoUpload_1576573078317_593667","name":"视频上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"MB","size":"50","defaultValue":"","name":"videoUpload_VMHcPt","tip":"","label":"视频上传","type":["mov","mp4","rmvb","3gp","mkv"],"isRegister":false}}]]] 模型主体区域
  |-0 Array [[{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":1,"dragable":true,"prop":"multiImageUpload_1576573009540_648238","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_enxHgc","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}},{"preview":"DMultiImageUploadPreview","editor":"DMultiImageUploadEditor","groupType":1,"icon":"duotu","index":5,"groupIndex":9,"type":"multiImageUpload","sortWeight":2,"dragable":true,"prop":"multiImageUpload_1576573005487_675966","name":"多图上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"max":50,"defaultValue":[],"label":"多图上传","type":["jpg","png","gif","bmp","psd","jpeg"],"unit":"KB","min":"","size":"","name":"multiImageUpload_fFJvwo","width":"","limit":"","tip":"","isImageDesc":true,"isLengthLimit":false,"isRegister":false,"height":""}}],[{"preview":"DVideoUploadPreview","editor":"DVideoUploadEditor","groupType":1,"icon":"shipin","index":6,"groupIndex":8,"type":"videoUpload","dragable":true,"prop":"videoUpload_1576573078317_593667","name":"视频上传","isCustom":true,"canDelete":true,"value":{"isRequired":false,"unit":"MB","size":"50","defaultValue":"","name":"videoUpload_VMHcPt","tip":"","label":"视频上传","type":["mov","mp4","rmvb","3gp","mkv"],"isRegister":false}}]]
 |-formListExtend Array [] 模型扩展区域
unEnableJson标识 Array
 |-dragable Boolean true
 |-canDelete Boolean true
 |-icon String jia
 |-type String abstract
 |-name String 摘要
 |-groupType String
 |-groupIndex Number 2
 |-isCustom Boolean false
 |-index Number 1
 |-preview String DAbstractPreview
 |-editor String DAbstractEditor
 |-hiddenFields Array []
 |-disableFields Array ["label","name"]
  |-0 String label
 |-value Object
  |-defaultValue String
  |-label String 摘要
  |-name String description
  |-placeholder String
  |-tip String
  |-isLengthLimit Boolean true
  |-min Number 1
  |-max Number 100
  |-isInputLimit Boolean false
  |-inputLimit String
  |-isRequired Boolean false
  |-link String 自动提取摘要

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561521601218
token String

不含分页列表

API地址 : /cmsmanager/model/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
tplType Number 1 1-栏目模型 2-内容模型 3会员模型

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 9 模型id
   |— modelName String 领导动态 模型名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561516213246
token String

模型列表拖动排序

API地址 : /cmsmanager/model/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 移动规则为默认移动到目标元素上面

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
fromId Number 61 移动元素id
tolId Number 4 移动至目标元素id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555660300679
token String

会员模型详情

API地址 : /cmsmanager/model/member

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 状态码
data Object
   |— enableJson Object 启用字段对象,结构如同添加模型字段结构一值,原样返回
   |— id Number 61 模型id
   |— modelName String 70周年 模型名称
   |— unEnableJson Array [] 未启用字段对象,结构如同添加模型字段结构一值,原样返回
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561521615197
token String

产品信息

API地址 : /cmsmanager/systeminfo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 产品信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— systemUrl String 公司官网链接
   |— afterSaleExpiredDate String 售后服务到期时间
   |— authCode String 123 授权码
   |— authExpiredDate String 2018-11-11 过期时间
   |— authState Number 2 授权状态1.已授权 2.未授权 3.未完成授权 4.授权过期
   |— authorization String 未授权 授权许可
   |— copyright String 版权所有
   |— dbName String jeecms 数据库名称
   |— dbPort Number 3306 端口
   |— dbType String Mysql 数据库类型
   |— dbUrl String 192.168.0.200 url
   |— jdk String 1.8.0_131 java版本
   |— productName String 产品名称
   |— siteName String 江西金磊科技发展公司 站点名称
   |— system String Windows 10 操作系统
   |— version String 10.0.0 版本号
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562913706666
token String

更改授权码

API地址 : /cmsmanager/systeminfo/change

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 更改授权码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
attrValue String 授权码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562914735671
token String

新增菜单

API地址 : /cmsmanager/menus

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
coreMenu Object
 |-parentId Number 12 父节点id(增加非一级菜单,必填,增加一级菜单,非必填)
 |-menuName String 菜单三 菜单名称
 |-sortNum Number 2 排序值
 |-menuType String 1 菜单类型 1、菜单 2、权限
 |-hidden Boolean true 是否可见 true可见 false不可见
 |-path String /api 页面路径
 |-component String /index.ashx 组件
 |- name String 权限标识 权限标识
 |-icon String /menu.jpg 菜单图片
 |-redirect String /api 重定向路由标识
apiIds Array [1,12] API id数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554880484114
token String

查询详情

API地址 : /cmsmanager/menus/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id} -> 需要查询的id值

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— apis Array
      |— id Number 1 apiid
      |— apiName String api名称
      |— apiUrl String api路径
   |— id Number 2 菜单id
   |— icon String 2 菜单图标
   |— menuName String 2 菜单名称
   |— menuType Number 1 菜单类型(1菜单2权限)
   |— component String 2 组件
   |— parentIds Array 2,3 上级菜单id数组
      |— 0 Number 3 上级菜单id
   |— redirect String 2 重定向路由标识
   |— path String 2 路由地址
   |— hidden Boolean false 是否可见 true可见 false不可见
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1560311271885
token String

树形查询所有

API地址 : /cmsmanager/menus/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— name String command 权限标识
   |— childs Array 子类对象数组
      |— name String /command/data 权限标识
      |— childs Array [] 子类对象数组
      |— id Number 1942 菜单id
      |— menuName String 控制台获取数据 菜单名称
      |— menuType Number 2 菜单类型1菜单2权限
      |— path String 页面路径
      |— hidden Boolean false 是否显示true是false否
   |— id Number 1423 菜单id
   |— menuName String 控制台 菜单名称
   |— menuType Number 2 菜单类型1菜单2权限
   |— path String 页面路径
   |— hidden Boolean false 是否显示true是false否
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559633140914
token String

菜单修改为显示

API地址 : /cmsmanager/menus/display

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [64] 需要修改的ID数组
 |-0 Number 64

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554884575832
token String

菜单修改为隐藏

API地址 : /cmsmanager/menus/hidden

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [64] 菜单id数组
 |-0 Number 64 标识

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554884575832
token String

校验路由是否唯一

API地址 : /cmsmanager/menus/routes/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
routing String /menus 路由地址
id Number 1 标识

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true路由可用,false路由不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887733493
token String

修改菜单

API地址 : /cmsmanager/menus

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
coreMenu Object
 |-id Number 103 标识
 |-parentId Number 0 父节点id
 |-menuName String 菜单久 菜单名称
 |-sortNum Number 2 排序值
 |-menuType String 1 菜单类型 1、菜单 2、权限
 |-hidden Boolean true 是否可见 true可见 false不可见
 |-path String /index10 页面路径
 |-component String /index.ashx 组件
 |-name String 权限标识 权限标识
 |-icon String /menu.jpg 菜单图标
 |-redirect String /sdas 重定向路由标识
apiIds Array [33,34,35] api id数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887873410
token String

修改排序值

API地址 : /cmsmanager/menus/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sorts Array
 |-id Number 136 标识
 |-sortNum Number 10 排序值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887873410
token String

删除菜单

API地址 : /cmsmanager/menus/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [64]
 |-0 Number 64 标识

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887873410
token String

菜单,权限列表集合

API地址 : /cmsmanager/menus/getMenus

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— menus Array 菜单集合
      |— redirect String 重定向
      |— name String /store/account/info 权限标识
      |— path String 页面路径
      |— icon String 菜单图标
      |— childs Array 子项集合
         |— redirect String 重定向
         |— path String 页面路径
         |— icon String 菜单图标
         |— name String /store/account/info 权限标识
         |— childs Array [] 子项集合
         |— id Number 952 菜单id
         |— menuName String 账户信息 菜单名称
         |— component String shopAccountLayOut 组件
         |— hidden Boolean true 是否可见 true可见 false不可见
      |— id Number 592 菜单id
      |— menuName String 店铺 菜单名称
      |— component String layout 组件
      |— hidden Boolean true 是否可见 true可见 false不可见
   |— perms Array ["/activity/save/save","/messageSet/list/data"] 权限
      |— 0 String /activity/save/save 权限标识
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559814808300
token String

校验菜单标识是否唯一

API地址 : /cmsmanager/menus/name/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number
name String 菜单标识

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一 false 不唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554887733493
token String

菜单修改为可以权限分配

API地址 : /cmsmanager/menus/openAuth

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [64]
 |-0 Number 64

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554884575832
token String

菜单修改为关闭权限分配

API地址 : /cmsmanager/menus/closeAuth

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [64]
 |-0 Number 64

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554884575832
token String

分页列表

API地址 : /cmsmanager/logBackups/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
backupName String 备份名称
startTime String 备份数据开始时间
endTime String 备份数据结束时间
beginDate String 备份开始时间
endDate String 备份结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— backupName String 1 备份名称
      |— createTime String 2019-07-25 10:40:43 备份时间
      |— endTime Number 2019-07-25 10:40:43 结束时间
      |— id Number 1
      |— remark String 1 备注
      |— startTime Number 1564022423000 开始时间
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 10:40:59
token String

详情

API地址 : /cmsmanager/logBackups/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— backupName String 1 备份名称
   |— createTime String 2019-07-25 10:40:43 备份时间
   |— dataCount Number 1 数量
   |— endTime Number 2019-07-25 10:40:43 结束时间
   |— remark String 1 备注
   |— startTime Number 2019-07-25 10:40:43 开始时间
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 10:43:57
token String

唯一性校验

API地址 : /cmsmanager/logBackups/unique/backupName

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
backupName String 备份名称
id String id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一, false 不唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 10:43:57
token String

恢复

API地址 : admin/logBackups/restore

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 成功 false 失败
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 10:43:57
token String

新建备份

API地址 : admin/logBackups/save

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
backupName String 备份名称
startTime String 开始时间
endTime String 结束时间
remark String 备注

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-25 10:43:57
token String

日志统计(用户名)

API地址 : /cmsmanager/log/statistics/username

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isToday Boolean true 今日统计(不填默认) false 历史统计
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— type String system 用户名
   |— value String 2 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561364807327
token String

日志统计(操作结果)

API地址 : /cmsmanager/log/statistics/result

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
cycle Number 0 0小时 1天 2月 3年 默认0
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— data Array
      |— 18 String 2 key日期时间 value 数量
      |— name String 成功 状态
   |— fields Array ["17","18"] 日期时间集合(横坐标数据)
      |— 0 String 17
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561365300974
token String

日志统计(事件类型)

API地址 : /cmsmanager/log/statistics/eventType

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
cycle Number 0 0小时 1天 2月 3年 默认0
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— data Array
      |— 2019-06-18 String 2 key 时间 value 数量
      |— name String 系统事件 时间类型
      |— 2019-06-19 String 2 key 时间 value 数量
   |— fields Array ["2019-06-15","2019-06-18","2019-06-19"]
      |— 0 String 2019-06-15 时间集合(横坐标数据)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561365622725
token String

日志统计(操作类型)

API地址 : /cmsmanager/log/statistics/operationType

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
cycle Number 0 0小时 1天 2月 3年
startTime String 开始时间
endTime String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— data Array
      |— 2019-06-24 Number 5 key 日期时间 value 数量
      |— name String 查询 操作类型
   |— fields Array ["2019-06-24"]
      |— 0 String 2019-06-24 日期时间集合(横坐标)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561365904760
token String

日志策略(详情)

API地址 : /cmsmanager/logConfigs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— dangerSmsTmpId String 312312 短信告警通知模板id
   |— dangerValue Number 200 告警阈值
   |— id Number 1
   |— noticeEmailList String 2581817531@qq.com 通知邮箱列表,多个使用 ;分隔
   |— noticeSmsList String 18579154396 通知短信列表,多个使用 ;分隔
   |— size String 0.02M 表大小
   |— warnSmsTmpId String 1123123 短信预警通知模板id
   |— warnValue Number 100 预警阈值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561442927190
token String

日志策略(修改)

API地址 : /cmsmanager/logConfigs

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dangerSmsTmpId String 312312 短信告警通知模板id
dangerValue Number 200 告警阈值
id Number 1
noticeEmailList String 2581817531@qq.com 通知邮箱列表,多个使用 ;分隔
noticeSmsList String 18579154396 通知短信列表,多个使用 ;分隔
warnSmsTmpId String 1123123 短信预警通知模板id
warnValue Number 100 预警阈值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561442927190
token String

实时日志

API地址 : /cmsmanager/logs/realTime

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
lastTimeFileSize Number 开始读取大小位置

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— contents Array ["2019-07-08 16:31:47.589 [main] INFO o.s.boot.web.embedded.tomcat.TomcatWebServer - Tomcat started on port(s): 8080 (http) with context path ''","2019-07-08 16:31:47.591 [main] INFO com.jeecms.admin.CmsAdminApplication - Started CmsAdminApplication in 17.075 seconds (JVM running for 17.843)","2019-07-08 16:31:48.387 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.SchedulerFactoryBean - Starting Quartz Scheduler now, after delay of 2 seconds","2019-07-08 16:31:48.402 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.LocalDataSourceJobStore - Freed 0 triggers from 'acquired' / 'blocked' state.","2019-07-08 16:31:48.406 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.LocalDataSourceJobStore - Recovering 0 jobs that were in-progress at the time of the last shut-down.","2019-07-08 16:31:48.406 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.LocalDataSourceJobStore - Recovery complete.","2019-07-08 16:31:48.408 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.LocalDataSourceJobStore - Removed 0 'complete' triggers.","2019-07-08 16:31:48.410 [Quartz Scheduler [schedulerFactoryBean]] INFO o.s.scheduling.quartz.LocalDataSourceJobStore - Removed 0 stale fired job entries.","2019-07-08 16:31:48.413 [Quartz Scheduler [schedulerFactoryBean]] INFO org.quartz.core.QuartzScheduler - Scheduler schedulerFactoryBean_$_NON_CLUSTERED started.","2019-07-08 16:31:57.530 [http-nio-8080-exec-1] INFO org.apache.tomcat.util.http.parser.Cookie - A cookie header was received [1559609913,1559723399,1560242194] that contained an invalid cookie. That cookie will be ignored.Note: further occurrences of this error will be logged at DEBUG level."]
      |— 0 String 2019-07-08 16:31:47.589 [main] INFO o.s.boot.web.embedded.tomcat.TomcatWebServer - Tomcat started on port(s): 8080 (http) with context path '' 每行数据
   |— lastTimeFileSize Number 346067 文件大小
   |— newRow Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562574717785
token String

系统日志

API地址 : /cmsmanager/logs/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名
clientIp String 客户端请求IP地址
subEventType String 事件子类型
logLevel Number 日志级别(1-高 2-中 3-低)
operateType Number 操作类型(1-查询 2-新增 3-修改 4-删除 5-导出 6-导入 7-上传 8-下载)
requestResult Number 请求结果(1-成功 2-失败)
beginDate String 开始时间
endDate String 结束时间
logCategory Number "系统_1", "业务_2", "审计_3", "安全_4"

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— logType Number 1 信息 2 警告
      |— clientIp String 192.168.0.194 客户端请求IP地址
      |— createTime Number 1562574875000 请求时间
      |— eventType Number 1 事件类型(1-系统事件 2-业务事件)
      |— id Number 10947
      |— logCategory Number 1 日志分类(1-系统日志)
      |— logLevel Number 3 日志级别(1-高 2-中 3-低)
      |— method String GET 请求方式method,post,get等
      |— operateType Number 1 操作类型(1-查询 2-新增 3-修改 4-删除 5-导出 6-导入 7-上传 8-下载)
      |— requestResult Number 1 请求结果(1-成功 2-失败)
      |— subEventType String 事件子类型
      |— timeConsuming Number 54 请求耗时(毫秒单位)
      |— uri String /admin/orgs/orgname/unique 日志请求地址
      |— username String system 操作用户名
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 10380
   |— totalPages Number 1038
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562574875688
token String

新增实时日志数量

API地址 : /cmsmanager/logs/getNewLog

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
lastTimeFileSize String 原文件大小

响应参数

名称 类型 初始值 说明
code Number 200
data Number 1353 行数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562575179208
token String

导出日志

API地址 : /cmsmanager/logs/export

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名
clientIp String 客户端请求IP地址
subEventType String 事件子类型
logLevel Number 日志级别(1-高 2-中 3-低)
operateType Number 操作类型(1-查询 2-新增 3-修改 4-删除 5-导出 6-导入 7-上传 8-下载)
requestResult Number 请求结果(1-成功 2-失败)
beginDate String 开始时间
endDate String 结束时间
logCategory Number "系统_1", "业务_2", "审计_3", "安全_4"

响应参数

名称 类型 初始值 说明

日志详情

API地址 : /cmsmanager/logs/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— remark String 日志详情
   |— browser String chrome 75 浏览器名称
   |— clientIp String 192.168.0.193 客户端IP
   |— createTime Number 1562382161000 操作时间
   |— eventType Number 1 日志事件类型(1-系统 2-业务)
   |— httpStatusCode String 200 请求时httpStatusCode代码,如:200,400,404等
   |— id Number 889
   |— logCategory Number 1 日志分类("系统_1", "业务_2", "审计_3", "安全_4", "告警_5")
   |— logLevel Number 3 日志级别(1-高 2-中 3-低)
   |— logType Number 1 日志类别(1-信息 2-警告)
   |— method String GET 请求方式method,post,get等
   |— operateType Number 1 操作类型(1-查询 2-新增 3-修改 4-删除 5-导出 6-导入 7-上传 8-下载)
   |— os String 操作系统
   |— paramData String {"mesCode":["test1"],"id":["45"]} 请求参数内容
   |— requestResult Number 1 请求结果(1-成功 2-失败)
   |— subEventType String 事件子类型
   |— timeConsuming Number 43 请求耗时(毫秒单位)
   |— uri String /admin/messageTpl/mesCode/unique 日志请求地址
   |— userAgent String chrome 75 用户代理
   |— username String system 操作用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562575527962
token String

告警日志

API地址 : /cmsmanager/logs/alarm/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginDate String 开始时间
endDate String 结束时间
subEventType String 事件子类型(告警模块)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime Number 1562316909000 告警时间
      |— id Number 62
      |— logLevel Number 1 日志级别(1-高 2-中 3-低)
      |— logType Number 2 日志类别(1-信息 2-警告)
      |— subEventType String 事件子类型(告警模块)
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562576417668
token String

导出告警日志

API地址 : /cmsmanager/logs/alarm/export

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
subEventType String 告警模块
beginDate String 开始时间
endDate String 结束时间

响应参数

名称 类型 初始值 说明

数据库备份

API地址 : /cmsmanager/databaseBackup/backup

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 启动一个数据库备份任务

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
remark String 数据库备份的备注

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-08 11:24:15
token String

数据库还原

API地址 : /cmsmanager/databaseBackup/recovery/{backupId}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 启动一个数据库还原任务

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-08 11:24:15
token String

数据库备份文件下载

API地址 : /cmsmanager/databaseBackup/download/{backupId}

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明

数据库备份列表

API地址 : /cmsmanager/databaseBackup/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— errMsg String 备份或还原失败的信息
      |— humanFileSize String 41.95 MB 文件大小
      |— createTime String 2019-08-03 10:57:45 备份时间
      |— filename String 1564801058356.jcbak 备份文件名
      |— id Number 1 backupId
      |— remark String 备份的备注
      |— state Number 1 状态 1 备份中; 2 还原中; 3 备份成功; 4 还原成功; 5 备份失败; 6 还原失败
   |— first Boolean true
   |— last Boolean false
   |— size Number 20
   |— totalElements Number 26
   |— totalPages Number 2
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-08 11:27:07
token String

删除备份

API地址 : /cmsmanager/databaseBackup/delete/{backupId}

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-08 11:24:15
token String

新建站内信

API地址 : /cmsmanager/message

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 新建站内信

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
title String 系统通知 标题
content String 交钱了,赶紧的 内容
userId Array [1,12,22,23,24] 用户ID
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557812175358
token String

发件箱

API地址 : /cmsmanager/message/outbox

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 发件箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startTime String 开始时间
endTime String 结束时间
username String 用户名
title String 标题
content String 内容
page String 页数
size String 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— content String 交钱了,赶紧的 内容
      |— createTimes String 2019-05-14 创建时间
      |— id Number 22 消息ID
      |— title String 系统通知 标题
      |— username String system 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557813769422
token String

消息详情

API地址 : /cmsmanager/message

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 消息详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 消息ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— username String 收件人
   |— sendUserName String 发件人
   |— content String 交钱了,赶紧的 内容
   |— createTime Number 1557806415000 创建时间
   |— id Number 12 消息ID
   |— title String 系统通知 标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557813221039
token String

删除消息(发件箱)

API地址 : /cmsmanager/message/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除消息(删除发件箱消息,删除对收件箱有影响)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12] 消息ID
 |-0 Number 12

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557813419433
token String

收件箱

API地址 : /cmsmanager/systemmessage/inbox

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 收件箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Boolean true 已读,false 未读
startTime String 开始时间
endTime String 结束时间
title String 标题
content String 内容
page String 页数
size String 数量
sendUserName String 发件人名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— sendUserName String 发件人名称
      |— content String 交钱了,赶紧的 内容
      |— coreUserMessageId Null null 用户消息状态ID
      |— createTimes String 2019-05-14 创建时间
      |— messageId Number 22 消息ID
      |— status Number 0 0未读1已读
      |— title String 系统通知 标题
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557814736492
token String

查看消息

API地址 : /cmsmanager/systemmessage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查看消息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
messageId Number 消息ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— eventStatus Boolean false true->请求成功(不需要显示重置按钮),false->请求失败(显示重置按钮)
   |— requestType Number 1 请求状态:1-重置内容密级
   |— requestParameter String {"requestStatus":2,"secretIds":[394],"type":1} 请求参数
   |— sendUserName String 发件人名称
   |— content String 交钱了,赶紧的 内容
   |— createTime Number 1557812175000 创建时间
   |— id Number 22 消息id
   |— title String 系统通知 标题
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557815309651
token String

标记已读

API地址 : /cmsmanager/systemmessage

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 标记已读

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12] 消息ID集合
 |-0 Number 12

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557815782227
token String

删除收件箱

API地址 : /cmsmanager/systemmessage/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除收件箱

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12]
 |-0 Number 12

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557815782227
token String

收件箱(系统消息+私信)未读数量

API地址 : /cmsmanager/systemmessage/number

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 收件箱(系统消息+私信)未读数量

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— unreadMessage Number 0 未读数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557816053751
token String

查询详情

API地址 : /cmsmanager/email

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— isEnable Boolean false 是否开启:true->开启,false->关闭
   |— emailName String 1747868121@qq.com 邮箱账号
   |— emailPassword String 123 邮箱密码
   |— isGloable Boolean true 是否全局配置:true-是,false-否
   |— isSsl Boolean true 是否使用sll协议:false-否 true-是
   |— smtpPort String 3306 SMTP 端口号
   |— smtpService String 百度云(测试) SMTP 服务器
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555056661930
token String

修改email全局配置

API地址 : /cmsmanager/email

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isGloable Boolean true 是否全局配置:true-是,false-否,isGloable必填为true
smtpService String 百度云(测试) SMTP 服务器
smtpPort String 3306 SMTP 端口
emailName String 1747868121@qq.com 邮箱账号
emailPassword String 123 邮箱密码
isSsl Boolean true 是否使用sll协议:false-否,true-是
id Number 12 标识
isEnable Boolean true 是否开启

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555057111779
token String

发送测试邮件

API地址 : /cmsmanager/email/calibration

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
smtpService String 百度云(测试) SMTP 服务器
smtpPort String 3306 SMTP 端口
emailName String 1747868121@qq.com 邮箱账号
emailPassword String 123 邮箱密码
isSsl Boolean true 是否使用sll协议:false-否,true-是
toAddress String 1747868121@qq.com 测试邮箱接收方账号

响应参数

名称 类型 初始值 说明
code Number 200
data Number 1 返回的数据,0--发送成功,1-->发送失败-->未知异常,2-->发送失败-->非法邮箱
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555063825553
token String

新增API

API地址 : /cmsmanager/apis

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
requestMethod Number 2 请求方式 1、GET;2、POST;3、 DELETE ;4、 UPDATE ;5 、PUT
apiName String 新增菜单 API名称
apiUrl String /menuMather API地址
useScene String 获取API列表信息 使用场景
sortNum Number 10 排序值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554944114190
token String

查询API详情

API地址 : /cmsmanager/apis/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->api标识

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— apiName String API列表 API名称
   |— apiUrl String /apilist api地址
   |— id Number 1 标识
   |— perms String api权限标识
   |— requestMethod Number 1 请求方式 1、GET;2、POST;3、 DELETE ;4、 UPDATE ;5 、PUT
   |— sortNum Number 10 排序值
   |— useScene String 获取API列表信息 使用场景
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554944158577
token String

API列表分页

API地址 : /cmsmanager/apis/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 1 页码
size Number 10 该页条数
apiName String api列表 API名称
apiUrl String /apis API地址

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— apiName String API列表 API名称
      |— apiUrl String /apilist API地址
      |— id Number 12 标识
      |— perms String API权限标识
      |— requestMethod Number 1 请求方式 1、GET;2、POST;3、 DELETE ;4、 UPDATE ;5 、PUT
      |— sortNum Null null 排序值
      |— useScene String 获取API列表信息 使用场景
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554944420834
token String

API修改

API地址 : /cmsmanager/apis

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
apiName String API列表 API名称
apiUrl String /apilist API地址
id Number 1 标识
requestMethod Number 1 请求方式 1、GET;2、POST;3、 DELETE ;4、 UPDATE ;5 、PUT
useScene String 获取API列表信息 使用场景

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554944754140
token String

校验路径(url地址)是否唯一

API地址 : /cmsmanager/apis/path/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
url String /menus API地址
id Number 1 修改是校验此项必填
requestMethod Number 1 请求方式 1、GET;2、POST;3、 DELETE ;4、 UPDATE ;5 、PUT

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true false表示已经存在,true表示不存在
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554945934334
token String

修改排序值

API地址 : /cmsmanager/apis/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sorts Array
 |-id Number 33
 |-sortNum Number 20

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554946208002
token String

API删除

API地址 : /cmsmanager/apis/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12] id数组
 |-0 Number 12 标识

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554946208002
token String

获取单个云存储信息

API地址 : /cmsmanager/sysOss/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— accessDomain String 访问域名
   |— appId String wx9f02cd3c95d353b9 APPID
   |— appKey String 9e519180ac08cb3991d492d85fdace8c key或者secret
   |— bucketArea String 330004 地区码
   |— bucketName String tengxunyun bucket名
   |— endPoint String 阿里云end_point
   |— id Number 1 云存储对象ID
   |— ossName String 腾讯云OSS配置信息 名称
   |— ossType Number 1 存储类型(1腾讯云cos 2阿里云oss 3七牛云)
   |— secretId String 9e519180ac08cb3991d492d85fdace8c secret_id
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554794120894 时间戳
token String 系统验证token

云存储信息分页查询

API地址 : /cmsmanager/sysOss/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 1 页数
size Number 10 每页的最大条数
ossName String 阿里 名称
ossType Number 2 存储类型(1腾讯云cos 2阿里云oss 3七牛云)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的数组
      |— id Number 2 OSS云存储对象ID
      |— ossName String 阿里云OSS配置信息 名称
      |— ossType Number 2 存储类型(1腾讯云cos 2阿里云oss 3七牛云)
   |— first Boolean true 第一条数据
   |— last Boolean true 最后一条数据
   |— size Number 10 大小
   |— totalElements Number 1 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554794545021 时间戳
token String 系统验证token

添加云存储信息

API地址 : /cmsmanager/sysOss

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
appId String AppId(存储类型为腾讯云时必填)
secretId String 9e519180ac08cb3991d492d85fdace8c secretId
ossType Number 3 存储类型(1腾讯云cos 2阿里云oss 3七牛云)
bucketName String 7niuyun bucket名
ossName String 七牛云OSS配置信息 名称
bucketArea String 地区码(存储类型为腾讯云时必填)
endPoint String 阿里云end_point(存储类型为阿里云时必填)
accessDomain String www.qiniuyun.com 访问域名(存储类型为阿里云或者七牛云时必填)
appKey String 9e519180ac08cb3991d492d85fdace8c key或者secret

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554794971832 时间戳
token String 系统验证token

修改云存储信息

API地址 : /cmsmanager/sysOss

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 3 云存储对象ID
appId String AppId(存储类型为腾讯云时必填)
secretId String 22222 secretId
ossType Number 3 存储类型(1腾讯云cos 2阿里云oss 3七牛云)
bucketName String 7niuyun bucket名
ossName String 七牛云OSS配置信息 名称
bucketArea String 地区码(存储类型为腾讯云时必填)
endPoint String 阿里云end_point(存储类型为阿里云时必填)
accessDomain String www.qiniuyun.com 访问域名(存储类型为阿里云或者七牛云时必填)
appKey String 64e647c56e02e9a75fece3535b014acf key或者secret

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554794971832 时间戳
token String 系统验证token

删除云存储信息

API地址 : /cmsmanager/sysOss/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [3,4] 云存储ID集合
 |-0 Number 3 云存储ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554794971832 时间戳
token String 系统验证token

云存储列表

API地址 : /cmsmanager/sysOss/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 5 云存储id
   |— ossName String 七牛云OSS配置信息 云存储名称
   |— ossType Number 3 存储类型(1腾讯云cos 2阿里云oss 3七牛云)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1559696479820
token String

获取单个FTP信息

API地址 : /cmsmanager/ftp/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— encoding String utf-8 编码
   |— ftpName String ftpName 名称
   |— ftpPath String www.jeecms.com/src/data 路径
   |— id Number 1 FTP对象的ID
   |— ip String 127.0.0.1 IP地址
   |— password String 123456jeecms 登录密码
   |— port Number 8080 端口号
   |— timeout Null null 超时时间
   |— url String www.jeecms.com 访问URL
   |— username String wulongwei 登录名称
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554796545271 时间戳
token String 系统验证token

FTP信息分页

API地址 : /cmsmanager/ftp/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 1 页数
size Number 10 条数
ftpName String http FTP名称

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array 返回的数组
      |— encoding String GBK 编码
      |— ftpName String http FTP名称
      |— ftpPath String www.JSPGOU.com/src/data 路径
      |— id Number 2 FTP对象ID
      |— ip String 127.0.0.1 IP地址
      |— url String www.JSPGOU.com 访问URL
   |— first Boolean true 第一条
   |— last Boolean true 最后一条
   |— size Number 10 大小
   |— totalElements Number 1 总条数
   |— totalPages Number 1 总页数
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554796887995 时间戳
token String 系统验证token

新增FTP信息

API地址 : /cmsmanager/ftp

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ftpName String http FTP名称
ip String 127.0.0.1 IP地址
port Number 8080 端口号
username String 天王盖地虎 登录名
password String Kh2+07MaeeQ= 登录密码(3DES对密码值进行加密)
encoding String utf-8 编码
timeout Number 超时时间
ftpPath String www.JSPGOU.com/src/data 路径
url String www.JSPGOU.com 访问URL

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554797156795 时间戳
token String 系统验证token

修改FTP信息

API地址 : /cmsmanager/ftp

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 12 FTP对象ID
ftpName String http FTP名称
ip String 127.0.0.1 IP地址
port Number 8080 端口号
username String 天王盖地虎 登录用户名
password String Kh2+07MaeeQ= 为空则默认不修改密码,登录密码(3DES对密码值进行加密)
encoding String GBK 编码
timeout Number 超时时间
ftpPath String www.JSPGOU.com/src/data 路径
url String www.JSPGOU.com 访问URL

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554797156795 时间戳
token String 系统验证token

删除FTP信息

API地址 : /cmsmanager/ftp/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2,12] FTP对象Id集合
 |-0 Number 1 FTP对象ID

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1554797156795 时间戳
token String 系统验证token

FTP信息列表

API地址 : /cmsmanager/ftp/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— encoding String GBK 编码
      |— ftpName String http ftp名称
      |— ftpPath String www.JSPGOU.com/src/data 路径
      |— id Number 2 ftp对象id
      |— ip String 127.0.0.1 IP
      |— url String www.JSPGOU.com 访问URL
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1554796887995
token String

查询区域层级列表

API地址 : /cmsmanager/area/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 进入区域设置无参数进行层次查询,查询出所有的根节点,再通过area的父节点id值进行下区域查询

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
parentId Number 1 父节点id值,不传默认查询所有根节点区域信息

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— areaCode String 130100 区域编号
   |— areaDictCode String 2 区域类型(1省级,2市级,3区级)
   |— areaName String 石家庄市 区域名称
   |— createTime Number 1552356460000 创建时间
   |— id Number 39 区域id值
   |— isChild Boolean false 是否为根节点,true为是,false为不是
   |— nodeIds Array [3,39] 节点列表ID。从父节点到自身
      |— 0 Number 3 自身节点值
   |— parentId Number 3 父级节点id
   |— remark String 备注
   |— sortNum Number 48 排序值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555144713713
token String

查询区域结构树信息

API地址 : /cmsmanager/area/tree

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— areaDictCode String 1 区域类型(1省级,2市级,3区级)
   |— areaCode String 110000 区域编号
   |— areaName String 北京 区域名称
   |— id Number 1 标识
   |— children Array 子集对象
      |— areaDictCode String 1
      |— areaCode String 110100 区域编号
      |— areaName String 北京市 区域名称
      |— id Number 35 标识
      |— children Array 子集对象
         |— areaDictCode String 1
         |— areaCode String 110101 区域编号
         |— areaName String 东城区 区域名称
         |— id Number 408 标识
         |— parentId Number 35 父节点id值
      |— parentId Number 1 父节点id值
   |— parentId Null null 父节点id值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555145785216
token String

修改区域排序值

API地址 : /cmsmanager/area/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sorts Array Sort对象数组
 |-id Number 1 标识
 |-sortNum Number 100 排序值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146120165
token String

删除区域信息

API地址 : /cmsmanager/area/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除单个区域信息以及其子集(传多个也仅删除首个)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array 4
 |-0 Number 4

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146120165
token String

获取单个区域详情

API地址 : /cmsmanager/area/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id} -> 区域标识

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— areaCode String 120000 区域编号
   |— areaDictCode String 1 区域类型(1省级,2市级,3区级)rea_type)
   |— areaName String 天津 区域名称
   |— id Number 2 区域id值
   |— nodeIds Array [2] 节点列表ID。从父节点到自身
      |— 0 Number 2 自身节点值
   |— remark String 备注
   |— sortNum Number 11 排序值
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146460434
token String

新增区域信息

API地址 : /cmsmanager/area

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新增时需校验areaCode

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
areaCode String 130001 编码(唯一)
areaName String 深圳 名称
parentId Null null 父级ID,为空默认新增顶级区域
sortNum Number 10 排序值
remark String 深圳市 备注
areaDictCode String 1 区域类型(1省级,2市级,3区级)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146936210
token String

修改区域信息

API地址 : /cmsmanager/area

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改前,需要校验areaCode值

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 标识
areaCode String 130001 编码(唯一)
areaName String 深圳 名称
parentId Number 父级ID,为空默认新增顶级区域
sortNum Number 10 排序值
remark String 深圳市 备注
areaDictCode String 1 区域类型(1省级,2市级,3区级)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146936210
token String

校验区域编号

API地址 : /cmsmanager/area/code/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 返回的数据,false代表AreaCode不可用,true则说明这个AreaCode可用

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
areaCode String 12001 区域编号
id Number 1 标识

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true 返回的数据,false代表AreaCode不可用,true则说明这个AreaCode可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146936210
token String

刷新缓存

API地址 : /cmsmanager/area/cache

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555146936210
token String

通过code获取第三方登录配置

API地址 : /cmsmanager/thirds

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
code String QQ 第三方登陆标识(QQ WECHAT WEIBO )

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— appId String appId 应用id
   |— appKey String appKey 应用密钥
   |— id Number 1 应用id
   |— isEnable Boolean true 是否启用(false-否 true-是)
   |— reMark String 备注
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1555576578855 时间戳
token String 系统验证token

添加/修改第三方登录信息

API地址 : /cmsmanager/thirds

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 id为空时添加,存在时修改
code String QQ 第三方登陆标识(QQ WECHAT WEIBO )
appId String appId 应用id
appKey String appKey 应用密钥
isEnable Boolean true 是否启用(false-否 true-是)
reMark String 备注

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1555577108337
token String

修改人员密级信息

API地址 : admin/userSecrets

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 私密 人员密级名称
contentSecretIds Array [12,22] 内容密级id数组
 |-0 Number 12 内容密级id
annexSecretIds Array [13] 附件密级id数组
 |-0 Number 13 附件密级id
id Number 人员密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

列表分页

API地址 : /cmsmanager/userSecrets/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 页码
size Number 条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— annexSecretNames String 机密、公开 附件密级名称
      |— contentSecretNames String 公开 内容密级名称
      |— id Number 12 人员密集id
      |— name String 公开 人员密级id
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 6
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556243459332
token String

通过id获取人员密级信息

API地址 : /cmsmanager/userSecrets/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 43 人员密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 43 人员密级id
   |— name String 私人 人员密级名称
   |— sysSecrets Array 内容/附件密级
      |— id Number 12 密级id
      |— name String 机密 密级名称
      |— secretType Number 1 密级类型(1内容密级 2附件密级类型)
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556246455858
token String

添加人员密级

API地址 : admin/userSecrets

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 私密
contentSecretIds Array [12,22] 内容密级id数组
 |-0 Number 12 内容密级id
annexSecretIds Array [13] 附件密级id数组
 |-0 Number 13 附件密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

删除人员密级

API地址 : /cmsmanager/userSecrets/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 人员密级id数组
 |-0 Number 人员密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

校验人员密级名称是否可用

API地址 : /cmsmanager/userSecrets/name/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 错误代码无用

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 人员密级名称
id Number 人员密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 可用,false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

人员密级列表

API地址 : /cmsmanager/userSecrets/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 人员密级列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 12 密级id
   |— name String 公开 密级名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556243459332
token String

分页查询

API地址 : /cmsmanager/secrets/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
secretType Number 1 密级类型(1内容密级 2附件密级类型)

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— content Array
      |— id Number 12 内容/附件密级id
      |— name String 机密 内容/附件密级名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556186710967
token String

添加

API地址 : /cmsmanager/secrets

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 绝密
secretType String 1 密级类型(1内容密级 2附件密级类型)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556187254213
token String

修改

API地址 : admin/secrets

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 内容/附件密级id
name String 内容/附件密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

删除

API地址 : /cmsmanager/secrets/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
secretIds Array [275] 密级id集合
 |-0 Number 275
type Number 2 密级类型(1内容密级 2附件密级类型)
requestStatus Number 2 请求状态:1-删除密级、2-删除内容密级和修改内容

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— code String 481028566915088544 内容重置标识(校验内容重置是否完成)
   |— predictionTimeConsuming Number 29 预测耗时(单位:秒,用于进度条使用)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-08-20 09:15:47
token String

通过id获取详情

API地址 : /cmsmanager/secrets/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 内容/附件密级id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 1 内容/附件密级id
   |— name String 公开 内容/附件密级名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556247672861
token String

列表

API地址 : /cmsmanager/secrets/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
secretType Number 密级类型(1内容密级 2附件密级类型)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 22 密级id
   |— name String 私有 密级名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556247986742
token String

校验密级名称是否可用

API地址 : /secrets/name/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 错误代码无用

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 密级名称
id Number 密级id
secretType Number 密级类型(1内容密级 2附件密级)

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 可以,false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556245508366
token String

列表分页

API地址 : admin/contentTags/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
tagName String tag词名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime String 创建时间
      |— id Number 53 tag词id
      |— refCounter Number 0 使用次数
      |— tagName String 内容 tag词名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556591396318
token String

添加

API地址 : /cmsmanager/contentTags

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
tagName String 关键,内容 tag名称(可以用中英文逗号分割tag名称,添加多个)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556590015371
token String

修改

API地址 : /cmsmanager/contentTags

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
tagName String 关键 tag词名称
id Number tag词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556590015371
token String

删除

API地址 : /cmsmanager/contentTags/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [52,53] tag词id数组
 |-0 Number 52 tag词id数组项

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556590015371
token String

通过id获取

API地址 : /cmsmanager/contentTags/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number tag词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 52 tag词id
   |— refCounter Number 0 使用次数
   |— tagName String 我是tag词 tag词名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556594046441
token String

重名校验

API地址 : /cmsmanager/contentTags/tagName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 tagid
tagName String alia tag名称

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true可用 false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

添加

API地址 : /cmsmanager/sensitiveWords

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sensitiveWord String 法轮功 敏感词(多个用中/英文逗号隔开)
replaceWord String *** 替换词
dealWithType Number 1 处理方式(1覆盖,2跳过)默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556591980884
token String

修改

API地址 : /cmsmanager/sensitiveWords

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 12 敏感词id
sensitiveWord String 法轮功 敏感词名称
replaceWord String flg 替换词

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556591980884
token String

敏感词列表分页

API地址 : /cmsmanager/sensitiveWords/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 敏感词列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sensitiveWord String 敏感词名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime Number 1556591981000 创建时间
      |— createUser String anonymousUser 创建人
      |— id Number 12 敏感词id
      |— replaceWord String flg 替换词
      |— sensitiveWord String 法轮功 敏感词
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556592791695
token String

删除

API地址 : /cmsmanager/sensitiveWords/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [12,3] 敏感词id数组
 |-0 Number 12 敏感词id数组项

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556593308745
token String

通过id获取

API地址 : /cmsmanager/sensitiveWords/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 敏感词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— createTime Number 1556531752000 创建时间
   |— createUser String anonymousUser 创建人
   |— id Number 1 敏感词id
   |— replaceWord String xiaohui 替换词
   |— sensitiveWord String 小灰 敏感词名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556594206035
token String

导入

API地址 : /cmsmanager/sensitiveWords/import

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
file File excel文件
dealWithType Number 重复数据处理方式(1覆盖,2跳过)默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556594206035
token String

重名校验

API地址 : /cmsmanager/sensitiveWords/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 敏感词id
sensitiveWord String alia 敏感词

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 可用 false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

下载模板

API地址 : /cmsmanager/sensitiveWords/download

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明

添加

API地址 : /cmsmanager/searchWords

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
word String 灭霸,无限手套 搜索词(可用中/英文逗号隔开生成多个)
sortNum Number 1
isRecommend Boolean true 是否推荐

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556603579891
token String

修改

API地址 : /cmsmanager/searchWords

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 搜索词id
word String 钢铁侠 搜索词名称
sortNum Number 1 排序值
isRecommend Boolean true 是否推荐

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556603885988
token String

通过id获取

API地址 : /cmsmanager/searchWords/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 搜索词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number 1 搜索词id
   |— isRecommend Boolean true 是否推荐
   |— searchCount Number 0 搜索次数
   |— sortNum Number 1 排序值
   |— word String 钢铁侠 搜索词名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556604824975
token String

删除

API地址 : /cmsmanager/searchWords/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [2] 搜索词id数组
 |-0 Number 2 搜索词id数组项

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556604972138
token String

分页列表

API地址 : /cmsmanager/searchWords/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
isRecommend Boolean 是否推荐
word String 搜索词
page_sort String searchCount搜索次序 sortNum固定顺序
page_sort_dir String asc升序 desc降序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 1
      |— isRecommend Boolean true
      |— searchCount Number 0
      |— sortNum Number 1
      |— word String 钢铁侠
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556605064529
token String

校验是否唯一

API地址 : admin/searchWords/unique/word

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number
word String 搜索词

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true是唯一 false 不是唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556604972138
token String

添加

API地址 : /cmsmanager/hotWordCategorys

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
cateName String 复联 热词名称
channelId Array [1] 栏目id数组
 |-0 Number 1 栏目id数组项
applyScope Number 2 应用范围(1所有栏目2指定栏目)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556607633923
token String

通过id获取

API地址 : /cmsmanager/hotWordCategorys/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 热词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— applyScope Number 2 应用范围(1全部2指定栏目)
   |— cateName String 复联 热词名称
   |— channels Array 栏目id数组
      |— id Number 1 栏目id
   |— id Number 1 热词id
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556608034615
token String

修改

API地址 : /cmsmanager/hotWordCategorys

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 热词id
cateName String 复联 热词名称
channelId Array [1] 栏目id数组
 |-0 Number 1 栏目id数组项
applyScope Number 2 应用范围(1全部2指定栏目)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556608371830
token String

删除

API地址 : /cmsmanager/hotWordCategorys/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 热词id数组
 |-0 Number 1 热词id数组项

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556608602317
token String

列表分页

API地址 : /cmsmanager/hotWordCategorys/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
cateName String 热词名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— applyScope Number 2 应用范围(1全部2指定栏目)
      |— cateName String 复联 热词名称
      |— id Number 12 热词id
      |— range String 新闻 热词应用栏目名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 1
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556608674775
token String

重名校验

API地址 : /cmsmanager/hotWordCategorys/cateName/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 热词分类id
cateName String alia 热词分类名称

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 可用 false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

热词分类列表

API地址 : /cmsmanager/hotWordCategorys/list

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— cateName String test 分类名称
   |— id Number 62 分类id
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-12 15:05:33
token String

添加

API地址 : /cmsmanager/hotWords/

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
hotWordCategoryId Number 12 热词分类id
hotWord String 钢铁侠 热词名称
linkUrl String http://localhost:8080 链接地址
isTargetBlank Boolean false 是否新窗口打开(true 是 false 否)
remark String 备注 备注
dealWithType Number 1 重复热词处理(1覆盖2跳过)默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556609341109
token String

通过id获取

API地址 : /cmsmanager/hotWords/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 热词id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— clickCount Number 0 点击次数
   |— hotWord String 钢铁侠 热词名称
   |— id Number 1 热词id
   |— isTargetBlank Boolean false 是否新窗口打开(true 是, false 不是)
   |— linkUrl String http://localhost:8080 链接地址
   |— remark String 备注 备注
   |— useCount Number 0 使用次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556609649133
token String

修改

API地址 : /cmsmanager/hotWords/

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 热词id
hotWord String 钢铁侠 热词名称
linkUrl String http://localhost:8080 链接地址
isTargetBlank Boolean false 是否新窗口打开(true 是 false 不是)
remark String 备注 备注

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556610783262
token String

列表分页

API地址 : /cmsmanager/hotWords/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
hotWord String 热词名称
hotWordCategoryId Number 热词分类id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— cateName String 分类名称
      |— clickCount String 点击次数
      |— useCount String 使用次数
      |— hotWord String 钢铁侠 热词名称
      |— id Number 1 热词id
      |— isTargetBlank Boolean false 是否新窗口打开(true是 false 不是)
      |— linkUrl String http://localhost:8080 链接地址
      |— remark String 备注 备注
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556611208585
token String

删除

API地址 : /cmsmanager/hotWords/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 热词id数组
 |-0 Number 1 热词id数组项

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1556611361762
token String

唯一性校验

API地址 : /cmsmanager/hotWords/unique/hotWord

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
hotWord String 热词名称
id Number 热词id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一 false 不唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562576417668
token String

添加机关代字

API地址 : /cmsmanager/contentMarks/agency

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 机关代字(可用逗号隔开)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

删除机关代字

API地址 : /cmsmanager/contentMarks/agency/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 机关代字id数组
 |-0 String 1 机关代字id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

机关代字分页

API地址 : /cmsmanager/contentMarks/agency/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 机关代字名称

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number
      |— createTime Number 1558410822000 创建时间
      |— createUser String system 创建人
      |— markName String 我真的是测试用的 机关代字
      |— sortNum Number 10 排序
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558431735534
token String

年号分页

API地址 : /cmsmanager/contentMarks/year/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 年号

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number
      |— createTime Number 1558410822000 创建时间
      |— createUser String system 创建人
      |— markName String 我真的是测试用的 年号
      |— sortNum Number 10 排序
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558433899908
token String

添加年号

API地址 : /cmsmanager/contentMarks/year

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 年号(可用逗号分割)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558433899908
token String

删除年号

API地址 : /cmsmanager/contentMarks/year/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 年号id数组
 |-0 String 1 年号id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558433899908
token String

获取机关代字详情

API地址 : /cmsmanager/contentMarks/agency/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 机关代字id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id Number
   |— createTime Number 1558410822000 创建时间
   |— createUser String system 创建人
   |— markName String 我真的是测试用的 机关代字
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558488939047
token String

获取年号详情

API地址 : /cmsmanager/contentMarks/year/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 年号id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— id String
   |— createTime Number 1558410822000 创建时间
   |— createUser String system 创建人
   |— markName String 2018 年号
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558488939047
token String

机关代字排序

API地址 : /cmsmanager/contentMarks/agency/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
fromId Number 1 拖动元素ID
toId Number 2 拖拽至目标ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558488939047
token String

年号排序

API地址 : /cmsmanager/contentMarks/year/sort

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
fromId Number 1 拖动元素ID
toId Number 2 拖拽至目标ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558488939047
token String

修改机关代字

API地址 : /cmsmanager/contentMarks/agency

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 机关代字

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

修改年号

API地址 : /cmsmanager/contentMarks/year

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 年份

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

快速录入年号

API地址 : /cmsmanager/contentMarks/year/entry

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginYear Number 起始年号
endYear Number 结束年号
excludeYear Array 排除年号数组
 |-0 Number 2014

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

机关代字唯一校验

API地址 : /cmsmanager/contentMarks/agency/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 机关代字
id Number 机关代字id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一 false 不唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

年号唯一校验

API地址 : /cmsmanager/contentMarks/year/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
markName String 年号
id String 年号id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 唯一 false 不唯一
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558423889690
token String

添加微信开放平台设置

API地址 : /cmsmanager/weChatSetUp

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String jeecms 应用名称
appId String wx9f02cd3c95d353b9 所属公众号的AppId
appSecret String 022dad46a168ddfbe79d5e3368c19769 所属公众号的AppSecret
messageDecryptKey String Z0y5SznkCVPgG73DxVfYylBgRbdfejT6M87lyq5i5Gp 消息加解密Key
messageValidateToken String DvN1lBKmC1ffoW5R 消息校验Token

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557217771812 时间戳
token String 系统验证token

显示微信开放平台信息

API地址 : /cmsmanager/weChatSetUp

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
   |— appId String wx9f02cd3c95d353b9 api地址(服务开发方的appid)
   |— appSecret String 022dad46a168ddfbe79d5e3368c19769 AppSecret
   |— id Number 32 微信开放平台对象ID
   |— messageDecryptKey String Z0y5SznkCVPgG73DxVfYylBgRbdfejT6M87lyq5i5Gp 消息加解密Key
   |— messageValidateToken String DvN1lBKmC1ffoW5R 消息校验Token
   |— name String jeecms 名称
requestUrl String 请求地址
timestamp Number 1557218374685 时间戳
token String 系统验证token

修改微信开放平台设置

API地址 : /cmsmanager/weChatSetUp

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 42 微信开放平台对象ID
name String 金磊科技 名称
appId String wx9f02cd3c95d353b9 api地址(服务开发方的appid)
appSecret String 022dad46a168ddfbe79d5e3368c19769 AppSecret
messageDecryptKey String Z0y5SznkCVPgG73DxVfYylBgRbdfejT6M87lyq5i5Gp 消息加解密Key
messageValidateToken String DvN1lBKmC1ffoW5R 消息校验Token

响应参数

名称 类型 初始值 说明
code Number 200 返回的状态码
data Object 返回的数据
message String 操作成功 返回的消息
redirectUrl String 重定向地址
requestUrl String 请求的地址
timestamp Number 1557219202472 时间戳
token String 系统验证token

获取组织/角色/用户维度 站群权限数据

API地址 : /cmsmanager/dataPerm

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 查询组织权限数据
roleId Number 查询角色权限数据
userId Number 查询用户权限数据
dataType Number 5

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— assigned Boolean 当前组织/角色/用户是否单独分配权限
   |— dataIds Array []
   |— menus Array []
   |— moreDataIds Array []
   |— sites Array 站群权限数据
      |— name String 站点名称
      |— canAssign Boolean false 当前登录用户是否可分配该站点权限
      |— children Array 子站点
         |— canAssign Boolean false 当前登录用户是否可可分配
         |— children Array []
         |— hasPerm Boolean false
         |— id Number 52
         |— parentId Number 1
      |— hasPerm Boolean false 当前组织/角色/用户是否有该站点的权限
      |— id Number 1
      |— parentId Null null 父站点ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557372824725
token String

获取组织/角色/用户维度 站点权限数据

API地址 : /cmsmanager/dataPerm

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 查询组织权限数据
roleId Number 查询角色权限数据
userId Number 查询用户权限数据
dataType Number 1 数据类型

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— assigned Boolean 是否单独分配的权限
   |— dataIds Array
      |— name String 站点名称
      |— children Array 子站点
         |— childs Array []
         |— id Number 84
         |— parentId Number 1
         |— rowDatas Array 站点操作
            |— canAssign Boolean false 当前登录用户是否可分配
            |— hasPerm Boolean false 当前组织/角色/用户是否有该站点的权限
            |— operation Number 0 操作数值
      |— id Number 1 站点ID
      |— parentId Null null 父站点ID
      |— rowDatas Array
         |— canAssign Boolean true
         |— hasPerm Boolean true
         |— operation Number 0
   |— menus Array []
   |— moreDataIds Array []
   |— sites Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557389163135
token String

获取组织/角色/用户维度 栏目类权限数据

API地址 : /cmsmanager/dataPerm

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 查询组织权限数据
roleId Number 查询角色权限数据
userId Number 查询用户权限数据
dataType Number 2 2栏目
siteId Number 站点ID 必填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— assigned Boolean 是否单独分配的权限
   |— dataIds Array []
   |— menus Array []
   |— moreDataIds Object 栏目类权限数据
      |— name String 站点名称
      |— siteId Number 1
      |— units Array 站点内栏目权限数据
         |— name String 栏目名称
         |— children Array 子栏目
            |— name String 栏目名称
            |— children Array []
            |— id Number 732
            |— parentId Number 1
            |— rowDatas Array
               |— canAssign Boolean false
               |— hasPerm Boolean false
               |— operation Number 0
         |— id Number 1
         |— parentId Null null 父栏目id
         |— rowDatas Array 栏目操作权限数组
            |— canAssign Boolean true 当前登录用户是否可分配
            |— hasPerm Boolean true 当前组织/角色/用户是否有该站点的权限
            |— operation Number 0 操作
   |— sites Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557389844334
token String

获取组织/角色/用户维度 文档类权限数据

API地址 : /cmsmanager/dataPerm

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 查询组织权限数据
roleId Number 查询角色权限数据
userId Number 查询用户权限数据
dataType Number 3 3文档
siteId Number 站点ID(必填)

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— assigned Boolean 是否单独分配的权限
   |— dataIds Array []
   |— menus Array []
   |— moreDataIds Object 栏目类权限数据
      |— name String 站点名称
      |— siteId Number 1
      |— units Array 站点内栏目权限数据
         |— name String 栏目名称
         |— children Array 子栏目
            |— children Array []
               |— name String 栏目名称
            |— id Number 732
            |— parentId Number 1
            |— rowDatas Array
               |— canAssign Boolean false
               |— hasPerm Boolean false
               |— operation Number 0
         |— id Number 1
         |— parentId Null null 父栏目id
         |— rowDatas Array 栏目操作权限数组
            |— canAssign Boolean true 当前登录用户是否可分配
            |— hasPerm Boolean true 当前组织/角色/用户是否有该站点的权限
            |— operation Number 0 操作
   |— sites Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557389844334
token String

获取组织/角色/用户维度 菜单权限

API地址 : /cmsmanager/dataPerm

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 查询组织权限数据
roleId Number 查询角色权限数据
userId Number 查询用户权限数据
dataType String 4

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— assigned Boolean 是否单独分配的权限
   |— dataIds Array []
   |— menus Array 菜单类权限
      |— hidden Boolean 是否隐藏
      |— name String 菜单名称
      |— canAssign Boolean false 当前登录用户是否可分配
      |— children Array 子菜单
         |— hidden Boolean 是否隐藏
         |— name String 菜单名称
         |— assigned Boolean false
         |— canAssign Boolean false
         |— hasPerm Boolean false
         |— id Number 63
         |— parentId Number 12
      |— hasPerm Boolean false 当前组织/角色/用户是否有该站点的权限
      |— id Number 12
      |— parentId Null null 父菜单
   |— moreDataIds Array []
   |— sites Array []
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557392153770
token String

组织/角色/用户 修改站群权限

API地址 : /cmsmanager/dataPerm

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataType Number 5 权限类型 1站点 2栏目 3文档 4菜单 5可管理站点(站群)
orgId Number 1 组织ID
siteDatas Array 站群权限
 |-siteId Number 1 站点ID(0为新增站点)
 |-selected Boolean true true选中,false未选中
roleId String 调整角色权限 必填
userId Number 调整用户权限 必填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557380276859
token String

组织/角色/用户 修改菜单权限

API地址 : /cmsmanager/dataPerm

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataType Number 4 权限类型 1站点 2栏目 3文档 4菜单 5可管理站点(站群)
orgId Number 1 组织ID
menus Array 菜单权限
 |-menuId Number 1 菜单ID(0为新增菜单)
 |-selected Boolean true true选中,false未选中
roleId String 调整角色权限 必填
userId Number 调整用户权限 必填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557380276859
token String

组织/角色/用户 修改站点数据权限

API地址 : /cmsmanager/dataPerm

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataType Number 1 权限类型 1站点 2栏目 3文档 4菜单 5可管理站点(站群)
orgId Number 1 调整组织权限 必填
dataIds Array 站点数据权限
 |-siteId Number 1 站点ID(0为新增站点)
 |-rowDatas Array 站点操作数据
  |-operation Number 0 操作值
  |-selected Boolean true 是否选中
roleId Number 调整角色权限 必填
userId Number 调整用户权限 必填

响应参数

名称 类型 初始值 说明

组织/角色/用户 修改栏目类和文档类 数据权限

API地址 : /admin/dataPerm

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataType Number 2 权限类型 1站点 2栏目 3文档 4菜单 5可管理站点(站群)
orgId Number 1 调整组织权限 必填
moreDataIds Object 栏目权限数据
 |-siteId Number 1
 |-units Array 现有栏目权限
  |-keyId Number 1 栏目ID(0为新增栏目)
  |-rowDatas Array 栏目操作权限
   |-operation Number 0 操作
   |-selected Boolean true 是否选中
roleId Number 调整角色权限 必填
userId Number 调整用户权限 必填

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557397910994
token String

获取文档栏目权限分配站点列表

API地址 : /cmsmanager/dataPerm/site

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgId Number 组织ID
roleId Number 角色ID
userId Number 用户Id
dataType Number 数据类型( 2栏目 3文档)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 1 站点ID
   |— name String jeecms主站 站点名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561682960436
token String

站点数据权限读取-组织角色

API地址 : /cmsmanager/dataPerm/site/org

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点Id

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— children Array []
      |— id Null null
      |— ops Array 子节点权限信息
         |— canAssign Boolean true 是否可分配
         |— hasPerm Boolean true 是否有该权限
         |— operation Number 1 具体操作值
      |— orgId Null null 组织ID
      |— orgName String 组织名称
      |— parentId Null null
      |— roleId Number 1 角色ID
      |— roleName String 角色 角色名称
   |— id Number 1
   |— ops Array 组织权限
      |— canAssign Boolean true 是否可分配
      |— hasPerm Boolean true 是否有该权限
      |— operation Number 1 具体操作值
   |— orgId Number 1
   |— orgName String 研发部
   |— parentId Null null
   |— roleId Null null
   |— roleName String
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562410345565
token String

站点数据权限读取-用户

API地址 : /cmsmanager/dataPerm/site/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
orgid Number 查询组织id
roleid String 查询角色ID
key String 查询用户关键词
page Number
size Number

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— ops Array 用户对站点的权限
         |— canAssign Boolean true 当前登录用户是否可分配
         |— hasPerm Boolean true 是否有该栏目的权限
         |— operation Number 0 具体操作值
      |— user Object
         |— roleNames String 角色名
         |— orgName String 组织名
         |— realname String 真实姓名
         |— id Number 24
         |— username String ljw 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557395591190
token String

站点站群权限读取-组织角色

API地址 : /cmsmanager/dataPerm/ownerSite/org

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 子节点
      |— children Array []
      |— id Null null
      |— org Null null
      |— orgId Null null 组织id
      |— orgName String 组织名
      |— parentId Null null
      |— role Object
         |— id Number 1 角色ID
         |— roleName String 角色 角色名称
      |— roleId Number 1 角色ID
      |— roleName String 角色 角色名称
      |— siteOwner Object 权限
         |— canAssign Boolean true 是否可分配
         |— hasPerm Boolean false 是否有权限
         |— name String jeecms主站 站点名称
         |— site Object
            |— id Number 1
            |— name String jeecms主站
   |— id Number 1
   |— org Object
      |— id Number 1
      |— name String 研发部
   |— orgId Number 1
   |— orgName String 研发部
   |— parentId Null null
   |— role Null null
   |— roleId Null null
   |— roleName String
   |— siteOwner Object
      |— canAssign Boolean true
      |— hasPerm Boolean true
      |— name String jeecms主站
      |— site Object
         |— id Number 1
         |— name String jeecms主站
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562410540832
token String

站点站群权限读取-用户

API地址 : /cmsmanager/dataPerm/ownerSite/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
orgid Number 查询的组织
roleid Number 查询的角色
key String 查询的关键词
page Number
size Number

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— siteOwner Object 权限
         |— assigned Boolean false 是否单独分配的权限
         |— canAssign Boolean true 当前登录用户是否可分配
         |— hasPerm Boolean false 是否有该栏目的权限
         |— site Object
            |— id Number 1
            |— name String jeecms主站
      |— user Object
         |— roleNames String 所属角色名
         |— orgName String 组织名
         |— realname String 真实姓名
         |— id Number 24
         |— username String ljw 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557396224189
token String

站点数据权限分配-组织角色

API地址 : /cmsmanager/dataPerm/site/org

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataId Number 1 站点ID
dataType Number 1 数据类型 1
perms Array 权限信息
 |-roleId String 角色ID
 |-orgId Number 1 组织ID
 |-ops Array 组织对站点的权限
  |-operation Number 1 操作
  |-selected Boolean true 是否选中
   |-operation Number 1 操作
   |-selected Boolean true 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399415693
token String

站点数据权限分配-用户

API地址 : /cmsmanager/dataPerm/site/user

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataId Number 1 站点ID
dataType Number 1 数据类型 1
perms Array 权限信息
 |-userId Number 1 用户id
 |-ops Array 操作权限
  |-operation Number 1 操作
  |-selected Boolean true 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399699468
token String

站点站群权限分配-组织角色

API地址 : /cmsmanager/dataPerm/ownerSite/org

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
perms Array 权限信息
 |-userId Number 用户ID
 |-roleId Number 角色ID
 |-orgId Number 1 组织ID
 |-selected Boolean false 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399699468
token String

站点站群权限分配-用户

API地址 : /cmsmanager/dataPerm/ownerSite/user

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
permOwner String user 权限分配的主体是组织角色org 用户是user
siteId Number 1 站点ID
perms Array 权限信息
 |-dataId Number 1 用户ID
 |-selected Boolean true 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399699468
token String

栏目权限读取-用户

API地址 : /cmsmanager/dataPerm/channel/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID
dataType Number 权限类型(2 栏目类 3文档类)
orgid Number 查询的组织
roleid Number 查询的角色
key String 查询的关键词
page Number
size Number

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— ops Array 操作权限
         |— canAssign Boolean true 当前登录用户是否可分配
         |— hasPerm Boolean false 是否有该栏目的权限
         |— operation Number 0 具体操作值
      |— user Object 用户
         |— roleNames String 角色名
         |— orgName String 组织名
         |— realname String 真实姓名
         |— id Number 24
         |— username String ljw 用户名称
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 4
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557394490310
token String

栏目权限读取-组织角色

API地址 : /cmsmanager/dataPerm/channel/org

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
channelId Number 栏目ID
dataType Number 权限类型(2 栏目类 3文档类)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array 组织下角色和子组织信息(roleId不为空则改成是角色权限,否则取orgId代表这层是组织的权限信息)
      |— children Array []
      |— id Null null
      |— ops Array
         |— canAssign Boolean true
         |— hasPerm Boolean true
         |— operation Number 1
      |— orgId Null null
      |— orgName String
      |— parentId Null null
      |— roleId Number 1
      |— roleName String 角色
   |— id Number 1
   |— ops Array 组织操作权限
      |— canAssign Boolean true 是否可分配
      |— hasPerm Boolean true 是否有权限
      |— operation Number 1 操作值
   |— orgId Number 1 组织ID
   |— orgName String 研发部 组织名
   |— parentId Null null
   |— roleId Null null 角色ID
   |— roleName String 角色名
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562410101038
token String

栏目权限分配-组织角色

API地址 : /cmsmanager/dataPerm/channel/org

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataId Number 1 栏目ID
dataType Number 2 数据类型 2栏目 3内容
perms Array 权限信息
 |-roleId Number 角色ID
 |-orgId Number 1 组织ID
 |-ops Array 组织对栏目的权限
  |-operation Number 1 操作
  |-selected Boolean true 是否选中
   |-operation Number 1 操作
   |-selected Boolean true 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399415693
token String

栏目权限分配-用户

API地址 : /cmsmanager/dataPerm/channel/user

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dataId Number 1 栏目ID
dataType Number 2 数据类型 2栏目 3内容
perms Array 权限信息
 |-userId Number 1 用户id
 |-ops Array 操作权限
  |-operation Number 1 操作
  |-selected Boolean true 是否选中

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1557399699468
token String

资源空间树形结构

API地址 : /cmsmanager/resourceSpaces/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— children Array 子类资源空间
         |— id Number 39 资源空间id
         |— isShare Number 2 是否分享(1未分享2下属资源被分享3已分享)
         |— name String 文档11 资源空间名称
         |— parentId Number 36 父级资源空间id
      |— id Number 36 资源空间id
      |— isShare Number 2 是否分享(1未分享2下属资源被分享3已分享)
      |— name String 文档1 资源空间名称
      |— parentId Number 35 父级资源空间id
   |— id Number 35
   |— isShare Number 2
   |— name String 文档
   |— parentId Null null
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558943729188
token String

共享资源空间树形结构

API地址 : admin/resourceSpaces/sharePage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 用户id

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— children Array
      |— children Array []
         |— userId Number 用户id
      |— id Number 46 资源空间id
      |— isShare Number 2 共享状态(1-未分享 2-下属资源被分享 3-已分享)
      |— name String 图片 资源类型名称
      |— parentId Null null 父级id
      |— userName String system 用户名
   |— name String system 用户名
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-17 10:53:53
token String

添加资源空间

API地址 : /cmsmanager/resourceSpaces

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
name String 文档19 资源空间名称
parentId Number 父级资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558945138248
token String

修改资源空间名称

API地址 : /cmsmanager/resourceSpaces

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 资源空间id
name String 照片 资源空间名称

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558945316153
token String

删除资源空间

API地址 : /cmsmanager/resourceSpaces/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [72] 资源空间id数组
 |-0 Number 72 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558945439926
token String

移动资源空间

API地址 : /cmsmanager/resourceSpaces/move

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 41 资源空间id
parentId Number 36 资源空间父级id
sortNum Number 排序值

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558945439926
token String

资源空间共享

API地址 : /cmsmanager/resourceSpaces/share

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 资源空间id
orgIds Array [1] 组织id数组(3个数组至少一个有值)
 |-0 Number 1
roleIds Array [1] 角色id数组(3个数组至少一个有值)
 |-0 Number 1
userIds Array [12] 用户id数组(3个数组至少一个有值)
 |-0 Number 12

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558945439926
token String

共享资源列表

API地址 : /cmsmanager/resourceSpaceDatas/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 资源空间id
username String 用户名
alias String 文件名
resourceType String 资源类型

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— duration String 时长
      |— createUser String 共享人
      |— shareTime String 共享时间
      |— suffix String 后缀名
      |— alias String tset 资源别名
      |— createTime Number 1558686152000 创建时间
      |— dimensions String 资源尺寸;比如图片200*300
      |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
      |— shareStatus Number 2 共享状态(1-未分享 2-已分享)
      |— size Number 0 资源大小
      |— id Number 1 资源id
      |— url String test 资源路径
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558947417101
token String

我的资源列表

API地址 : /cmsmanager/resourceSpaceDatas/user/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
shareStatus Number 共享状态(1-未分享 2-已分享)
resourceType Number 文件类型(1图片 2视频 3音频 4附件)
beginCreateTime String 开始起始时间
endCreateTime String 最后创建时间
alias String 资源名
page_sort String 时间(createTime)文件大小(size)
page_sort_dir String desc 降序 asc 升序
id Number 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— duration String 时长
      |— shareTime String 共享时间
      |— sizeUnit String 资源大小(带单位)
      |— suffix String 后缀名
      |— alias String tset 资源别名
      |— createTime Number 1558686152000 创建时间
      |— dimensions String 资源尺寸;比如图片200*300
      |— id Number 2 资源id
      |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
      |— shareStatus Number 2 共享状态(1-未分享 2-已分享)
      |— size Number 0 资源大小
      |— url String test 资源路径
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558948475310
token String

删除资源

API地址 : /cmsmanager/resourceSpaceDatas/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 资源id数组
 |-0 Number 1 资源id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558948475310
token String

获取资源详细信息

API地址 : /cmsmanager/resourceSpaceDatas/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 资源id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— duration String 时长
   |— sizeUnit String 资源大小(带单位)
   |— suffix String 后缀名
   |— alias String jeecms 资源名称
   |— createTime Number 1558604632000 创建时间
   |— createUser String sysytem 创建人
   |— dimensions String 资源尺寸;比如图片200*300
   |— resourceType Number 1 文件类型(1图片 2视频 3音频 4附件)
   |— size Number 0 资源大小
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558949720031
token String

保存到我的资源

API地址 : /cmsmanager/resourceSpaceDatas

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 资源id数组
 |-0 Number 1 资源id
spaceId Number 1 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Object {}
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

资源重命名

API地址 : /cmsmanager/resourceSpaceDatas

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 资源id
alias String test 资源名

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

移动资源

API地址 : /cmsmanager/resourceSpaceDatas/shift

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,2] 资源id数组
 |-0 Number 1 资源id
storeResourcesSpaceId Number 1 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

下载资源到本地

API地址 : /cmsmanager/resourceSpaceDatas/download

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1,12] 资源id数组
 |-0 Number 1 资源id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

共享我的资源

API地址 : /cmsmanager/resourceSpaceDatas/share

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array 1 资源id
 |-0 Number 1 1
orgIds Array [1] 组织id数组(3个至少一个不为空)
 |-0 Number 1
roleIds Array [1] 角色id数组3个至少一个不为空)
 |-0 Number 1
userIds Array [12] 用户id数组3个至少一个不为空)
 |-0 Number 12

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

取消分享资源

API地址 : /cmsmanager/resourceSpaceDatas/unShare

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 资源数组id
 |-0 Number 1 资源id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

取消分享资源空间

API地址 : /cmsmanager/resourceSpaces/unShare

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ids Array [1] 资源空间id数组
 |-0 Number 1 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

资源重名校验

API地址 : /cmsmanager/resourceSpaceDatas/alia/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 资源id
alias String alias 资源别名
spaceId Number 资源空间id

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 名称可用 fasle 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

资源空间重名校验

API地址 : /cmsmanager/resourceSpaces/name/unique

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 1 资源空间id
name String name 资源空间名称

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true 可用, false 不可用
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1558950093856
token String

共享设置

API地址 : /cmsmanager/resourceSpaceDatas/share

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
orgIds Array [1,2] 组织id数组
 |-0 Number 1
userIds Array [1,2] 用户id数组
 |-0 Number 1
roleIds Array [1,2] 角色id数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561605844605
token String

获取共享设置信息

API地址 : /cmsmanager/resourceSpaceDatas/share

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 500
data Object
   |— orgIds Array [1,2] 组织id数组
      |— 0 Number 1
   |— userIds Array [1,2] 用户id数组
      |— 0 Number 1
   |— roleIds Array [1,2] 角色id数组
      |— 0 Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1561617044851
token String

保存单点登录

API地址 : /cmsmanager/sso

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 保存单点登录

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
openSso String 1 1开启0关闭
appId String HasawefasHZDA4654613 应用APPID
appSecret String eyJhbGciOiJIUzUxMiJ9 应用Seccret

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-29 16:46:17
token String

设置详情

API地址 : /cmsmanager/sso

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 设置详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— openSso Boolean 是否开启,1开启,0关闭
   |— appId String SSO应用APPID
   |— appSecret String SSO应用APPID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-10-29 16:46:17
token String

根据TOKEN获取用户信息

API地址 : /cmsmanager/sso/getInfo

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 前台需要判断data数据是否为空

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
authToken String 令牌

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— JEECMS-Auth-Token String eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzeXN0ZW0iLCJjcmVhdGVkIjoxNTczNDUyNTUyMDQ0LCJ1c2VyU291cmNlIjoiYWRtaW4iLCJleHAiOjE1NzM0Njk3NTJ9.LK_oFOSciFFwTJtwHhX3fT3NUWRcGQGfyETIskr-3WY6B5nfvOpnw5rBffEbp52zzNMtsvPh1pt76m1eZA-Org token令牌
   |— siteId Number 1
   |— siteName String jeecms演示站
   |— roleIds Array []
   |— auth Object
      |— lastLoginIP String 0:0:0:0:0:0:0:1
      |— lastLoginTime Number 1573452166462
      |— menus Array
         |— children Array
            |— children Array []
            |— component String views/WorkPlace/Index
            |— hidden Boolean true
            |— icon String
            |— id Number 654
            |— menuName String 工作台首页
            |— name String workplaceIndex
            |— parentId Number 653
            |— path String /workplace/index
            |— redirect String
            |— sortNum Number 1
         |— component String layouts/RouteView
         |— hidden Boolean false
         |— icon String gongzuotai
         |— id Number 653
         |— menuName String 工作台
         |— name String workplace
         |— parentId Null null
         |— path String /workplace
         |— redirect String /workplace/index
         |— sortNum Number 1
      |— routings Array
         |— apiUrl String /admin/sites/on
         |— requestMethod String POST
      |— userName String system
   |— orgId Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-11 14:09:12
token String

单点登录应用信息

API地址 : /cmsmanager/sso/status

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 单点登录应用信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— loginUrl String http://192.168.0.135:8080/login.html 跳转URL
   |— appId String HasawefasHZDA4654613 应用ID
   |— appSecret String yHet_gUEiBccGOIma99P9APKs_rP_qUl 秘钥
   |— open Boolean true 是否开启单点登录
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-11-18 10:18:39
token String

三元管理查询详情

API地址 : /cmsmanager/safe/manage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 操作序号对应的操作 组织管理: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-发布静态页、30-权限分配 工作流:31-新建、32-编辑、33-删除

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— auditAdminIds Array [1] 审计管理员id集合
      |— 0 Number 1
   |— auditAdmins Array 审计管理员集合
      |— userExt Object 内容扩展对象
         |— realname String 陈胖虎 用户真实姓名
      |— roleNames String 超级管理员 角色名称
      |— orgName String 金磊科技 组织名称
      |— id Number 1 管理员id
      |— username String system 管理员名称
   |— enable Boolean true 是否开启:true->开启,false->关闭
   |— haveOperatings Array [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,30,31,32] 拥有的操作集合
      |— 0 Number 1
   |— safeAdminIds Array [1] 安全管理员id集合
      |— 0 Number 1
   |— safeAdmins Array 安全管理员集合
      |— userExt Object
         |— realname String
      |— roleNames String
      |— orgName String
      |— id Number 1 管理员id
      |— username String system 管理员名称
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-22 13:55:55
token String

管理员列表分页

API地址 : /cmsmanager/users/safe/manage/page

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String sy 用户名/真实姓名
orgid Number 1 组织id
roleid Number 1 角色id
page Number 1 页码
size Number 1 分页大小
notIds Array [1] 需要排除的用户id集合
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— enabled Boolean true 管理员状态:true->开启,false->关闭
      |— id Number 1203 管理员id
      |— managerAble Boolean true 该管理员是否可以管理
      |— orgName String 1 组织名称
      |— roleNames String 系统管理员 角色名称
      |— userExt Object 用户对象扩展对象
         |— realname String 1 用户真实姓名
      |— username String test2 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-11 17:28:47
token String

分页查询三元审核

API地址 : /cmsmanager/safe/manage/operate/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Number 1 操作状态:1-待审核,2-审核成功,3-审核失败
module Number 1 模块:1-组织、2-角色、3-用户、4-三元管理、5-站点、6-栏目、7-工作流
page Number 1 页码
size Number 1 每页最大的容纳条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— siteType Number 1 null->非站点修改,1->站点主体,2->站点扩展,3->修改站点模板
      |— operating Number 1 20-站点修改,26-栏目修改
      |— showLink Boolean 1 true->显示链接显示表单,false->不显示链接显示表单
      |— createTime String 2020-05-11 17:55:25 申请时间
      |— requestUserName String system(陈胖虎) 申请人
      |— id Number 822 序号
      |— modulePrompt String 三元管理设置 所属模块
      |— operatingDetails String 处理安全管理员,安全管理员修改成:test1,test2 操作详情
      |— operatingPrompt String 变更三元角色 操作类型
      |— status Number 1 状态:1-待审核、2=已审核
      |— updateTime Null null 审核时间
      |— auditUserName String 审核人
   |— first Boolean true
   |— last Boolean false
   |— size Number 20
   |— totalElements Number 70
   |— totalPages Number 4
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-14 17:21:49
token String

通过状态查询数量

API地址 : /cmsmanager/safe/manage/operate

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Number 1 不填->全部,1-待审核,2-已审核,3-审核不通过
type Number 1 1-安全管理员、2-审计管理员

响应参数

名称 类型 初始值 说明
code Number 200
data Number 1 数量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-14 17:32:25
token String

修改站点、栏目查询操作详情

API地址 : /cmsmanager/safe/manage/operate/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: {id}->日志id 返回的数据只有当操作是站点修改或栏目修改才有这个功能,该功能返回的数据都是和站点详情,栏目详情格式一致

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— dataField Object
      |— isListChannel Boolean false
      |— resourceId Object
         |— alias String 9c1412c804ab1fbc3a5c06fcd759cba4
         |— suffix String .jpg
         |— url String /u/cms/www/202001/14154955tqqz.jpg
         |— resourceType Number 1
      |— tplMobile String
      |— seoDescription String SEO描述
      |— display Boolean true
      |— contribute Boolean true
      |— link Object
         |— linkTarget Boolean true
         |— link String www.baidu.com
      |— pageSize Number 20
      |— seoTitle String SEO标题
      |— commentControl Number 1
      |— txt String 栏目描述
      |— contentTpls Array
         |— select Boolean false
         |— tplMobile String
         |— tplPc String content/newsAlone.html
         |— modelId Number 1071
      |— tplPc String
      |— channelParentId Number 1747
      |— channelName String 栏目1
      |— channelPath String lm1
      |— viewControl Number 3
      |— seoKeywork String SEO关键字
      |— workflowId Number 11
   |— modelName String 测试模型
   |— renderingField Object
      |— formListBase Array
         |— preview String DParentColumnPreview
         |— editor String DParentColumnEditor
         |— groupType Number 1
         |— icon String jia
         |— index Number 1
         |— groupIndex Number 1
         |— type String parentColumn
         |— disableFields Array ["label","name","isRequired"]
            |— 0 String label
         |— sortWeight Number 1
         |— hiddenFields Array ["options"]
            |— 0 String options
         |— dragable Boolean true
         |— prop String parentColumn_1587717756454_971218
         |— name String 上级栏目
         |— isCustom Boolean false
         |— canDelete Boolean false
         |— value Object
            |— isRequired Boolean true
            |— isOtherOption Boolean false
            |— isOtherOptionRequired Boolean false
            |— defaultValue String
            |— name String channelParentId
            |— options Array []
            |— tip String
            |— label String 上级栏目
            |— otherOption Object
               |— label String 其他
               |— value Number 999
   |— id Number 2401
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-14 17:46:10
token String

操作三元管理日志

API地址 : /cmsmanager/safe/manage/operate

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 1. 分页列表传值一定是true

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 802 日志id
status Number 1 操作状态:1-通过、2-不通过
check Boolean true 校验:true->校验,false->不校验直接执行

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true->显示弹窗,为null或者false->操作成功
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-14 17:32:25
token String

三元管理校验操作

API地址 : /cmsmanager/safe/manage/check/operating

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 三元管理校验操作是否含有操作日志,含有操作日志的无法进行修改操作 1. 如果拥有返回值则直接弹窗,并且不调取修改接口 2. 如果没有拥有返回值,则直接调取修改接口

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
operatings Array [1] 操作集合,操作对应的值和查询详情中的一一对应
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data String 组织管理[新建、编辑、成员管理],角色管理[编辑、成员管理],用户管理[新建、编辑、修改密码],三元管理设置[开启/关闭、修改应用模块、变更三元角色],站点管理[新建、编辑、开启/关闭、发布静态页],模块下存在待审核事项,无法取消三员审核业务,请处理后再操作! 返回值
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-26 08:55:54
token String

修改三元管理

API地址 : /cmsmanager/safe/manage

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
enable Boolean true true->开启三元管理,false->关闭三元管理
operatings Array [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,30] 操作集合
 |-0 Number 1 操作值,具体值请对应:三元管理查询接口
safeUserIds Array [1] 安全管理员集合
 |-0 Number 1 管理员id
auditUserIds Array [1] 审计管理员集合
 |-0 Number 1 管理员id集合

响应参数

名称 类型 初始值 说明
code Number 812
data Object
message String 操作已提交至三元管理
redirectUrl String
requestUrl String /cmsadmin/safe/manage
timestamp String 2020-05-26 12:38:47
token String

分页查询三元审核日志

API地址 : /cmsmanager/safe/manage/operate/log/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Number 1 操作状态:1-待审核,2-审核成功,3-审核失败
module Number 1 模块:1-组织、2-角色、3-用户、4-三元管理、5-站点、6-栏目、7-工作流
page Number 1 页码
size Number 1 每页最大的容纳条数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— siteType Number 1 null->非站点修改,1->站点主体,2->站点扩展,3->修改站点模板
      |— operating Number 1 20-站点修改,26-栏目修改
      |— showLink Boolean 1 true->显示链接显示表单,false->不显示链接显示表单
      |— createTime String 2020-05-11 17:55:25 申请时间
      |—  requestUserName String system(陈胖虎) 申请人
      |— id Number 822 序号
      |— modulePrompt String 三元管理设置 所属模块
      |— operatingDetails String 处理安全管理员,安全管理员修改成:test1,test2 操作详情
      |— operatingPrompt String 变更三元角色 操作类型
      |— status Number 1 状态:1-待审核、2=已审核
      |— updateTime Null null 审核时间
      |— auditUserName String 审核人
   |— first Boolean true
   |— last Boolean false
   |— size Number 20
   |— totalElements Number 70
   |— totalPages Number 4
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-14 17:21:49
token String

校验安全管理员用户权限

API地址 : /cmsmanager/safe/manage/check/user/menu

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 校验用户所选择的用户是否拥有三元管理的菜单类权限!

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
safeUserIds Array [1,1172] 所选的安全管理员用户id集合
 |-0 Number 1 用户id集合

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-01 16:08:57
token String

是否开启双因子

API地址 : /cmsmanager/config/element/status

请求方式: 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 String 2020-05-28 10:03:41
token String

双因子认证设置

API地址 : /cmsmanager/config/element

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
openElement Boolean true true开启,false关闭
length Number 2 短信验证码长度 1.4位 2.6位 3.8位
valid Number 30 验证码有效期
unit Number 1 验证码单位 1.秒 2.分钟

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:03:51
token String

双因子详情

API地址 : /cmsmanager/config/element

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 双因子详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— elementLength String 2 短信验证码长度 1.4位 2.6位 3.8位
   |— elementUnit String 1 验证码单位 1.秒 2.分钟
   |— elementOpen Boolean true 是否开启,1开启,0关闭
   |— elementValid String 30 验证码有效期
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:18:42
token String

是否强制绑定手机验证

API地址 : /cmsmanager/config/element/hasBind

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 是否强制绑定手机验证

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean false true需要,false不需要
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:05:51
token String

登录验证发送验证码

API地址 : /cmsmanager/config/element/sendLogin

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述: 登录校验

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:03:51
token String

绑定手机发送验证码

API地址 : /cmsmanager/config/element/sendBind

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 绑定手机发送验证码

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mobile String 手机号

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:03:51
token String

绑定手机号

API地址 : /cmsmanager/config/element/bind

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 绑定手机号

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mobile String 手机号
code String 验证码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-05-28 10:03:51
token String

网站概况

API地址 : /cmsmanager/statisticsflow/overview

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点id值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— highest Object
      |— depthNum Number 0.1 跳出率-精确到小数点后4位
      |— ip Number 15 IP数
      |— pv Number 30 PV数
      |— time Number 6 平均访问时长单位秒
      |— uv Number 15 UV数
   |— now Object
      |— depthNum Number 0
      |— ip Number 0
      |— pv Number 0
      |— time Number 0
      |— uv Number 0
   |— yesterday Object
      |— depthNum Number 0
      |— ip Number 0
      |— pv Number 0
      |— time Number 0
      |— uv Number 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-29 09:48:02
token String

网站概述新老客户

API地址 : /cmsmanager/statisticsvisit/summarize

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 网站概述新老客户

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startTime Number 开始时间
endTime Number 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— isNew Boolean true新客户false老客户
   |— jump Number 0 跳出率
   |— name String 老客户 名称
   |— pv Number 15 浏览量
   |— uv Number 1 访客数
   |— visitTime Number 7324.5 评论访问时长(秒)
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-30 09:27:29
token String

网站概述地域分布

API地址 : /cmsmanager/statisticsvisit/summarizeArea

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 网站概述地域分布

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startTime Number 时间戳(毫秒级)
endTime Number 结束时间(毫秒级)

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— name String 上海 名称
   |— value Number 1 数值
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-02 09:45:44
token String

实时访客-在线访问人数

API地址 : /cmsmanager/statisticsflow/realtime/uvnum

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点id值

响应参数

名称 类型 初始值 说明
code Number 200
data Number 7 在线访问人数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-09-20 09:27:02
token String eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzeXN0ZW0iLCJjcmVhdGVkIjoxNTY4OTQyODIyMjczLCJ1c2VyU291cmNlIjoiYWRtaW4iLCJleHAiOjE1Njg5NjAwMjJ9.7nZ7MM-MzDWVoG8fadR99qf--Ko-6bEX2TYUSq2zkaF-5L9F_qtv9NFck1k7uyK_302zrKW4CDzgp7yN1kQfJA

来源类型

API地址 : /cmsmanager/statisticsSource/sourceType

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 开始时间
endTime Number 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient Number 访问来源(1计算机 2移动设备)
newVisitor Boolean true 新客户 false 老客户
showType Number 1 (1pv 2uv 3ip)默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— average Number 3566 平均访问时长
   |— bounce Number 7.68 跳出率
   |— fields Array ["外部链接","直接访问","搜索引擎"] 折线图每条折现对应key
      |— 0 String 外部链接
   |— ips Number 231 ip数
   |— list Array 列表数据
      |— average Number 2500 平均访问时长
      |— bounce Number 6.61 跳出率
      |— ips Number 33 ip数
      |— list Array []
         |— name Number 名称
         |— average Number 平均访问时长
         |— bounce Number 跳出率
         |— ips Number ip数
         |— uvs Number uv数
         |— pvs Number pv数
      |— name String 直接访问 来源类型
      |— pvs Number 333 pv数
      |— uvs Number 33 uv数
   |— objects Array 折线图数据
      |— 外部链接 Number 0 pv/uv/ip数 根据showType
      |— 搜索引擎 Number 0 pv/uv/ip数 根据showType
      |— 直接访问 Number 0 pv/uv/ip数 根据showType
      |— time String 2019-05-06 时间
   |— pie Array 饼图数据
      |— ip Number 99 ip数
      |— ipPercentage Number 42.86 ip数占比
      |— name String 外部链接 来源类型
      |— pv Number 999 pv数
      |— pvPercentage Number 42.86 pv数占比
      |— uv Number 99 uv数
      |— uvPercentage Number 42.86 uv数占比
   |— pvs Number 2331 pv数
   |— uvs Number 231 uv数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 14:35:25
token String

来源网站

API地址 : /cmsmanager/statisticsSource/sourceUrl

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户
showType Number 1pv 2uv 3ip 不传默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— average Number 3566 平均访问时长
   |— bounce Number 7.68 跳出率
   |— fields Array ["www.baidu2.com","www.baidu1.com","www.baidu.com"] 折线图每条折现对应key
      |— 0 String www.baidu2.com
   |— ips Number 231 ip数
   |— objects Array 折线图
      |— www.baidu2.com Number 0 网站1数据
      |— www.baidu1.com Number 0 网站2数据
      |— time String 2019-05-06 时间
      |— www.baidu.com Number 0 网站3数据
   |— pie Array 饼图
      |— ip Number 55 ip数
      |— ipPercentage Number 23.81 ip数占比
      |— name String www.baidu2.com 网站
      |— pv Number 555 pv数
      |— pvPercentage Number 23.81 pv数占比
      |— uv Number 55 uv数
      |— uvPercentage Number 23.81 uv数占比
   |— pvs Number 2331 pv数
   |— uvs Number 231 uv数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 15:07:23
token String

搜索引擎

API地址 : /cmsmanager/statisticsSource/searchEngine

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户
showType Number 1 1 pv 2 uv 3 ip 不传默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— average Number 5400 平均访问时长
   |— bounce Number 7.71 跳出率
   |— fields Array ["百度2","百度"] 折线图每条折现对应key
      |— 0 String 百度2
   |— ips Number 99 ip数
   |— list Array 列表
      |— average Number 3600 平均访问时长
      |— bounce Number 3.31 跳出率
      |— ips Number 44 ip数
      |— list Array []
      |— name String 百度 搜索引擎
      |— proportion Number 44.45 占比
      |— pvs Number 444 pv数
      |— uvs Number 44 uv数
   |— objects Array 折线图数据
      |— 百度2 Number 0 折线1数据
      |— 百度 Number 0 折线2数据
      |— time String 2019-05-06 时间
   |— pie Array 饼图
      |— ip Number 55 ip数
      |— ipPercentage Number 55.56 ip数占比
      |— name String 百度2 搜索引擎
      |— pv Number 555 pv数
      |— pvPercentage Number 55.56 pv数占比
      |— uv Number 55 uv数
      |— uvPercentage Number 55.56 uv数占比
   |— pvs Number 999 pv数
   |— uvs Number 99 uv数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 15:09:52
token String

外部链接(域名)

API地址 : /cmsmanager/statisticsSource/domain

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户
showType Number 1pv 2uv 3ip 不传默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— average Number 2700 平均访问时长
   |— bounce Number 8.01 跳出率
   |— fields Array ["www.baidu1.com","www.baidu.com"] 折线图每条折现对应key
      |— 0 String www.baidu1.com
   |— ips Number 99 ip数
   |— objects Array 折线图
      |— www.baidu1.com Number 0 折线1数据
      |— time String 2019-05-06 时间
      |— www.baidu.com Number 0 折线2数据
   |— pie Array 饼图
      |— ip Number 66 ip数
      |— ipPercentage Number 66.67 ip数占比
      |— name String www.baidu1.com 域名
      |— pv Number 666 pv数
      |— pvPercentage Number 66.67 pv数占比
      |— uv Number 66 uv数
      |— uvPercentage Number 66.67 uv数占比
   |— pvs Number 999 pv数
   |— uvs Number 99 uv数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 15:13:45
token String

外部链接(URL)

API地址 : /cmsmanager/statisticsSource/url

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户
showType Number 1pv 2uv 3ip 不传默认1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— average Number 2700 平均访问时长
   |— bounce Number 8.01 跳出率
   |— fields Array ["www.baidu1.com","www.baidu.com"] 折线图每条折现对应key
      |— 0 String www.baidu1.com
   |— ips Number 99 ip数
   |— objects Array 折线图
      |— www.baidu1.com Number 0 折线1
      |— time String 2019-05-06 时间
      |— www.baidu.com Number 0 折线2
   |— pie Array 饼图
      |— ip Number 66 ip数
      |— ipPercentage Number 66.67 ip数占比
      |— name String www.baidu1.com url
      |— pv Number 666 pv数
      |— pvPercentage Number 66.67 pv数占比
      |— uv Number 66 uv数
      |— uvPercentage Number 66.67 uv数占比
   |— pvs Number 999 pv数
   |— uvs Number 99 uv数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-07 15:15:51
token String

外部链接(URL)分页

API地址 : /cmsmanager/statisticsSource/url/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime String 1556781034000 开始时间
endTime String 1564729835000 结束时间
siteId Number 1 站点
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— average Number 7200 平均访问时长
      |— bounce Number 7.927927927927928 跳出率
      |— ips Number 55 ip数
      |— name String www.baidu2.com url
      |— proportion Number 23.80952380952381 占比
      |— pvs Number 555 浏览量
      |— uvs Number 55 访客数
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-02 16:00:01
token String

外部链接(域名)分页

API地址 : /cmsmanager/statisticsSource/domain/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime String 1556781034000 开始时间
endTime String 1564729835000 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— average Number 7200 平均访问时长
      |— bounce Number 7.927927927927928 跳出率
      |— ips Number 55 ip数
      |— name String www.baidu2.com url
      |— proportion Number 23.80952380952381 占比
      |— pvs Number 555 浏览量
      |— uvs Number 55 访客数
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-02 16:00:01
token String

来源网站分页

API地址 : /cmsmanager/statisticsSource/sourceUrl/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime String 1556781034000 开始时间
endTime String 1564729835000 结束时间
siteId Number 1 站点
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 IP数正序 5 IP数倒序 6 跳出率正序 7 跳出率倒序 8 平均访问时长正序 9 平均访问时长倒序
accessSourceClient String 访问来源(1计算机 2移动设备)
newVisitor String true 新客户 false 老客户

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— average Number 7200 平均访问时长
      |— bounce Number 7.927927927927928 跳出率
      |— ips Number 55 ip数
      |— name String www.baidu2.com url
      |— proportion Number 23.80952380952381 占比
      |— pvs Number 555 浏览量
      |— uvs Number 55 访客数
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-02 16:09:45
token String

访问页面

API地址 : /cmsmanager/statisticsAccessPage/accessPage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
newVisitor Boolean true true 新访客 false 老访客
sorceUrlType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 贡献下游浏览量正序 5 贡献下游浏览量倒序 6 平均停留时长正序 7 平均停留时长倒序
page Number 10
size Number 1
url String 地址

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— averageTime String 01:52:40 平均停留时长(HH:mm:ss)
   |— page Object
      |— content Array
         |— proportion Number 占比
         |— averageTime String 01:52:40 平均停留时长(HH:mm:ss)
         |— pageViews Number 0 贡献下游浏览量
         |— pvs Number 1 浏览量
         |— url String asada 页面地址
         |— uvs Number 1 访客数
      |— first Boolean true
      |— last Boolean true
      |— size Number 20
      |— totalElements Number 20
      |— totalPages Number 1
   |— pageViews Number 51 贡献下游浏览量
   |— pvs Number 61 浏览量
   |— uvs Number 5 访客数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562385181203
token String

入口页面

API地址 : /cmsmanager/statisticsAccessPage/entrancePage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
beginTime Number 2019-08-06 开始时间
endTime Number 2019-09-08 结束时间
siteId Number 1 站点id
sortType Number 1 0 PV正序 1 PV倒序 2 UV正序 3 UV倒序 4 贡献下游浏览量正序 5 贡献下游浏览量倒序 6 平均停留时长正序 7 平均停留时长倒序
page Number 10
size Number 1
url String 地址

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— bounce Number 跳出率
   |— average Number 0 平均访问时长
   |— averageTime String 00:00:00 平均访问时长(HH:mm:ss)
   |— page Object 分页列表
      |— content Array
         |— proportion Number 占比
         |— average Number 0 平均访问时长
         |— averageTime String 00:00:00 平均访问时长(HH:mm:ss)
         |— bounce Number 300 跳出率
         |— pageViews Number 0 贡献浏览量
         |— pvs Number 1 浏览量
         |— url String www.baidu.com/2/41 页面url
         |— uvs Number 1 访客数
      |— first Boolean true
      |— last Boolean true
      |— size Number 20
      |— totalElements Number 6
      |— totalPages Number 1
   |— pageViews Number 51 贡献浏览量
   |— pvs Number 61 浏览量
   |— uvs Number 10 访客数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562391972358
token String

今天地域分布

API地址 : /cmsmanager/statisticsvisit/timearea

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 今天地域分布

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份
visitor Boolean null true新客户false老客户

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— ips Number 2 ip数
   |— ipsList Array ip集合
      |— decimal Number 0.5 所占比例
      |— type String 湖南 省份
      |— value Number 1 浏览量
   |— jump Number 0.2 跳出率
   |— pv Number 6 浏览量
   |— pvList Array 浏览量集合
      |— decimal Number 0.17 所占比例
      |— type String 湖南 省份
      |— value Number 1 浏览量
   |— uv Number 2 访客数
   |— uvList Array 访客数列表
      |— decimal Number 0.5 浏览量集合
      |— type String 湖南 所占比例
      |— value Number 1 省份
   |— visitTime Number 301.5 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562116396832
token String

今天列表分页

API地址 : /cmsmanager/statisticsvisit/timepage

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 今天列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份
visitor Boolean null true新访客false老访客
orderType Number null 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— page Object
      |— content Array
         |— cityList Array 城市列表
            |— ips Number 1 ip数
            |— jump Number 0.2 跳出率
            |— name String 长沙 城市名称
            |— pv Number 1 浏览量
            |— uv Number 1 访客数
            |— visitTime Number 301.5 平均访问时长
         |— ips Number 1 ip数
         |— jump Number 0.2 跳出率
         |— name String 湖南 省份名称
         |— pv Number 1 浏览量
         |— uv Number 1 访客数
         |— visitTime Number 301.5 平均访问时长
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 2
      |— totalPages Number 1
   |— collect Object 汇总数据
      |— ips Number 2 ip数
      |— jump Number 0.4 跳出率
      |— name String 当前列表汇总 名称
      |— pv Number 6 浏览量
      |— uv Number 2 访客数
      |— visitTime Number 603 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562118806035
token String

地域分布

API地址 : /cmsmanager/statisticsvisit/area

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 地域分布

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime Number 1567094400000 开始时间
endTime Number 1567094400000 结束时间
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份名称
visitor Boolean null true新访客false老访客
orderType Number null 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean null true 正序false 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— ips Number 15 ip数
   |— ipsList Array ip集合
      |— decimal Number 0.34 所占比例
      |— type String 湖南 省份名
      |— value Number 5 访问次数
   |— jump Number 0.1 跳出率
   |— pv Number 30 浏览量
   |— pvList Array 浏览量集合
      |— decimal Number 0.34 所占比例
      |— type String 湖南 省份名
      |— value Number 10 访问次数
   |— uv Number 15 访客数
   |— uvList Array 访客数集合
      |— decimal Number 0.34 所占比例
      |— type String 湖南 省份名
      |— value Number 5 访问次数
   |— visitTime Number 6 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562124328662
token String

地域分布列表分页

API地址 : /cmsmanager/statisticsvisit/areapage

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 地域分布列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime Number 1567094400000 开始时间
endTime Number 1567094400000 结束时间
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份
visitor Boolean null true新访客false老访客
orderType Number null 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean null 排序方式true 正序 flase 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— page Object page对象
      |— content Array
         |— cityList Array 城市列表
            |— ips Number 5 ip数
            |— jump Number 0.1 跳出率
            |— name String 长沙 城市名称
            |— pv Number 10 浏览量
            |— uv Number 5 访客数
            |— visitTime Number 6 平均访问时长
         |— ips Number 5 ip数
         |— jump Number 0.1 跳出率
         |— name String 湖南 省级名称
         |— pv Number 10 浏览量
         |— uv Number 5 访客数
         |— visitTime Number 6 平均访问时长
      |— first Boolean true
      |— last Boolean true
      |— size Number 20
      |— totalElements Number 2
      |— totalPages Number 1
   |— collect Object 汇总数据
      |— ips Number 15 ip数
      |— jump Number 0.2 跳出率
      |— name String 当前列表汇总 名称
      |— pv Number 30 浏览量
      |— uv Number 15 访客数
      |— visitTime Number 12 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562124483050
token String

今天设备信息

API地址 : /cmsmanager/statisticsdevice/timedevice

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 今天设备信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点信息

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— visitTimes String 平均访问时长(时分秒格式)
   |— ips Number 2 ip数
   |— ipsList Array ip集合
      |— type String 计算机 设备名称
      |— value Number 2 访问次数
   |— jump Number 0.2 跳出率
   |— pv Number 6 浏览量
   |— pvList Array 浏览量列表
      |— type String 计算机 设备名称
      |— value Number 6 访问次数
   |— uv Number 2 访客数
   |— uvList Array 访客数集合
      |— type String 计算机 设备名称
      |— value Number 2 访问次数
   |— visitTime Number 301.5 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562125264678
token String

今天设备列表

API地址 : /cmsmanager/statisticsdevice/time

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 今天设备列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
orderType Number 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean 排序方式true 正序 flase 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array 列表数据
      |— deviceList Array 具体设备信息
         |— visitTimes String 访问时长(时分秒格式)
         |— ips Number 2 ip数
         |— jump Number 0.2 跳出率
         |— name String Windows10 设备名称
         |— pv Number 6 浏览量
         |— uv Number 2 访客数
         |— visitTime Number 301.5 平均访问时长
      |— ips Number 2 ip数
      |— jump Number 0.2 跳出率
      |— name String 计算机 设备名称
      |— pv Number 6 浏览量
      |— uv Number 2 访客数
      |— visitTime Number 301.5 平均访问时长
   |— collect Object 汇总数据
      |— ips Number 2 ip数
      |— jump Number 0.2 跳出率
      |— name String 当前列表汇总 名称
      |— pv Number 6 浏览量
      |— uv Number 2 访客数
      |— visitTime Number 301.5 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562125361588
token String

设备信息

API地址 : /cmsmanager/statisticsdevice/device

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 设备信息

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime String 2019-07-02 开始时间
endTime String 2019-07-02 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— visitTimes String 平均访问时长(时分秒格式)
   |— ips Number 15 ip数
   |— ipsList Array ip数集合
      |— type String 计算机 设备类型
      |— value Number 15 访问次数
   |— jump Number 0.1 跳出率
   |— pv Number 30 浏览量
   |— pvList Array 浏览量集合
      |— type String 计算机 设备类型
      |— value Number 3 访问次数
   |— uv Number 15 访客数
   |— uvList Array 访客数集合
      |— type String 计算机 设备类型
      |— value Number 15 访问次数
   |— visitTime Number 6 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562126153488
token String

设备列表

API地址 : /cmsmanager/statisticsdevice/devices

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 设备列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime String 2019-07-02 开始时间
endTime String 2019-07-02 结束时间
orderType Number null 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean null 排序方式true 正序 flase 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array 集合数据
      |— deviceList Array 具体设备信息
         |— visitTimes String 平均访问时长(时分秒格式)
         |— ips Number 15 ip数
         |— jump Number 0.1 跳出率
         |— name String Windows10 设备名称
         |— pv Number 30 浏览量
         |— uv Number 15 访客数
         |— visitTime Number 6 平均访问时长
      |— ips Number 15 ip数
      |— jump Number 0.1 跳出率
      |— name String 计算机 设备名称
      |— pv Number 30 浏览量
      |— uv Number 15 访客数
      |— visitTime Number 6 平均访问时长
   |— collect Object 汇总数据
      |— visitTimes String 访问时长(时分秒格式)
      |— ips Number 15 ip数
      |— jump Number 0.1 跳出率
      |— name String 当前列表汇总 设备名称
      |— pv Number 30 浏览量
      |— uv Number 15 访客数
      |— visitTime Number 6 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562126390209
token String

今天新老用户

API地址 : /cmsmanager/statisticsvisit/timeuser

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 今天新老用户

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份名称
orderType Number 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean 排序方式true 正序 flase 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array 列表数据
      |— ips Number 2 ip数
      |— jump Number 0.2 跳出率
      |— name String 新客户 名称
      |— pv Number 5 浏览量
      |— uv Number 2 访客数
      |— visitPage Number 2.5 平均访问页数
      |— visitTime Number 301.5 平均访问时长
   |— collect Object 汇总数据
      |— ips Number 2 ip数
      |— jump Number 0.2 跳出率
      |— name String 当前列表汇总 名称
      |— pv Number 5 浏览量
      |— uv Number 2 访客数
      |— visitPage Null null 平均访问页数
      |— visitTime Number 301.5 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562132592649
token String

新老客户数据

API地址 : /cmsmanager/statisticsvisit/user

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 新老客户数据

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime String 2019-07-02 开始时间
endTime String 2019-07-02 结束时间
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份
orderType Number null 排序类型1.浏览量2.访客数3.IP数4.跳出率5.平均访问时长
order Boolean null 排序方式true 正序 flase 倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— list Array 集合数据
      |— ips Number 15 ip数
      |— jump Number 0.1 跳出率
      |— name String 新客户 名称
      |— pv Number 30 浏览量
      |— uv Number 15 访客数
      |— visitPage Number 2 平均访问页数
      |— visitTime Number 6 平均访问时长
   |— collect Object 汇总数据
      |— ips Number 15 ip数
      |— jump Number 0.1 跳出率
      |— name String 当前列表汇总 名称
      |— pv Number 30 浏览量
      |— uv Number 15 访客数
      |— visitPage Null null 平均访问页数
      |— visitTime Number 6 平均访问时长
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562132968964
token String

访问页数

API地址 : admin/statisticsaccess/pageInfo

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 访问名称

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1
startTime String 2019-06-28 开始时间
endTime String 2019-06-28 结束时间
sourceType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份名称
visitor Boolean true新访客false老访客
orderType Number 排序类型1.浏览次数2.比例
order Boolean true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 2 总数
   |— value Array
      |— decimal Number 1 所占比例
      |— type String 11-20页 访问页数
      |— value Number 2 访问次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562057154628
token String

今天访问页数

API地址 : /cmsmanager/statisticsaccess/timePage

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 实时访问页数

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String 省份
visitor Boolean null true新客户false老客户
orderType Number null 排序类型1.浏览次数2.比例
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 2 总数
   |— value Array
      |— decimal Number 1 所占比例
      |— type String 11-20页 访问页数
      |— value Number 2 次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562057154628
token String

访问深度

API地址 : /cmsmanager/statisticsaccess/highInfo

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 访问深度

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime String 2019-06-28 开始时间
endTime String 2019-06-28 结束时间
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String null 省份
visitor Boolean null true新客户false老客户
orderType Number null 排序方式1访问次数2.比例
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 16 总数
   |— value Array
      |— decimal Number 0.94 所占比例
      |— type String 7页 访问深度
      |— value Number 15 访问次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562057906445
token String

今天访问深度

API地址 : /cmsmanager/statisticsaccess/timeHigh

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 今天访问深度

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String null 省份
visitor Boolean null true新客户false老客户
orderType Number null 排序方式1.访问次数2.所占比例
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 16 总数
   |— value Array
      |— decimal Number 0.94 比例
      |— type String 7页 访问深度
      |— value Number 15 访问次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562057906445
token String

访问时长

API地址 : /cmsmanager/statisticsaccess/timeInfo

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 访问时长

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
startTime String 2019-06-28 开始时间
endTime String 2019-06-28 结束时间
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String null 省份
visitor Boolean null true新客户false老客户
orderType Number null 排序方式1.访问次数2.比例
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 16 总数
   |— value Array
      |— decimal Number 0.94 比例
      |— type String 30-60分钟 访问时长
      |— value Number 15 访问次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562058668184
token String

今天访问时长

API地址 : /cmsmanager/statisticsaccess/time

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 今天访问时长

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点ID
sourceType Number null 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
province String null 省份
visitor Boolean null true新访客false老访客
orderType Number null 排序方式1.访问次数2.比例
order Boolean null true正序false倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 16 总数
   |— value Array
      |— decimal Number 0.94 比例
      |— type String 30-60分钟 访问时长
      |— value Number 15 访问次数
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562058668184
token String

实时访客图表数据

API地址 : /cmsmanager/statisticsflow/realtime

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点id值

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— pv Number 0 PV数
   |— time String 17:02 时间
   |— uv Number 0 UV数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-29 17:28:28
token String

实时访客列表数据

API地址 : /cmsmanager/statisticsflow/realtime/page

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 访问时长:当访问时长为0时,前台显示正在访问 province和city传入的规则是,如果只传入city不进行匹配检索,如果要检索city必须把province传入

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点
sorceUrlType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问
accessSourceClient Number 1 访问来源(1:PC 2:移动端)
time Number null 访问时间
newVisitor Boolean true 是否新用户
isLogin Boolean false 是否登录
minFrequency Number 0 最小访问频次
maxFrequency Number 100 最大访问频次
minDepth Number null 最小访问深度
maxDepth Number null 最大访问深度
duration Number null 访问时长:1. 0-30s,2. 31-60s,3. 61-90s,4. 91-180s,5. 181-300s,6. 301-600s,7. 600以上
entranceUrl String null 入口页面模糊检索条件
userName String null 用户名模糊检索条件
accessIp String null ip地址检索条件
sortTerm Number 1 排序条件:1.访问时间、2.访问时长、3.访问页数
order Boolean false true正序,false倒序
page Number 1 页码
size Number 1 每页最大值
area Number 1 筛选条件为区域的区域ID值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— accessIp String 115.152.78.163 访问ip
      |— accessPage Number 1 访问页数
      |— accessTime Number 60 访问
      |— areaName String 南昌 访问时长,如果访问时长为0,则为正在访问
      |— createTime Number 1562211955000 访问时间
      |— entranceUrl String www.baidu.com/7/985/788 入口页面
      |— id Number 1 序号
      |— sourceUrl String 来源网址,为空时显示直接访问
      |— userName String 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 200
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562234595408
token String

趋势分析-图表数据

API地址 : /cmsmanager/statisticsflow/image

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 访问时长单位为秒,对应设计图转换显示。 province和city传入的规则是,如果只传入city不进行匹配检索,如果要检索city必须把province传入

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 2 站点id
minTime Number 1561959902000 最小时间
maxTime Number 1562305502000 最大时间
showStyle Number 2 显示方式:1.小时、2.日、3.周、4.月
sorceUrlType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
city String 南昌 城市
province String 江西
accessSourceClient Number 1 访问来源(1:PC 2:移动端)
newVisitor Boolean true 是否新用户
showType Number 1 1-pv值,2-UV值,3-IP值,4-跳出率,5-平均访问时长

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— array Array 统计数值集合
      |— showTime String 1 显示在底层的时间
      |— date String 2019-07-02 时间
      |— uv Number 0 UV
      |— time Number 0 评论访问时长,单位秒
      |— depthNum Number 0 跳出率,精确到小数点后4位
      |— pv Number 0 PV数
      |— ip Number 0 IP数
   |— total Object 统计总数之
      |— depthNum Number 0 跳出率,精确到小数点后4位
      |— ip Number 0
      |— pv Number 0
      |— time Number 0
      |— uv Number 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-07-30 09:14:34
token String

趋势分析-列表数据

API地址 : /cmsmanager/statisticsflow/page

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 底下需要控制一个问题,如果列表的大小为0,那么汇总数据不该显示。 访问时长单位为秒,对应设计图转换显示。 province和city传入的规则是,如果只传入city不进行匹配检索,如果要检索city必须把province传入

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 2 站点id
minTime Number 1561959902000 最小时间
maxTime Number 1562305502000 最大时间
showStyle Number 2 显示方式:1.小时、2.日、3.周、4.月
sorceUrlType Number 1 来源网站类型 (1-搜索引擎 2-外部链接 3-直接访问)
accessSourceClient Number 1 访问来源(1:PC 2:移动端)
newVisitor Boolean true 是否新用户
sortTerm Number 2 排序条件:1.日期,2.浏览量,3.访客数,4.ip,5.跳出率,6.平均访问时长
order Boolean true true正序,false倒序
page Number 1 页码
size Number 1 每页最大容纳数
area Number 1 区域ID值

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— total Object 储存汇总数据的对象
      |— depthNum Number 0.1
      |— ip Number 15
      |— pv Number 30
      |— time Number 6
      |— uv Number 15
   |— vos Object 储存分页列表数据
      |— content Array
         |— date String 2019-07-01 时间
         |— depthNum Number 0.1 跳出率->精确到小数点后4位
         |— id Number 1 序号
         |— ipNum Number 5 ip值
         |— pvNum Number 10 pv值
         |— timeNum Number 6 访问时间
         |— uvNum Number 5 UV值
      |— first Boolean true
      |— last Boolean true
      |— size Number 100
      |— totalElements Number 3
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562307860298
token String

今日流量

API地址 : /cmsmanager/statisticsflow/overview

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 其它接口调用对应的分析图表接口

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 1 站点id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— highest Object 历史最高
      |— depthNum Number 0.1 跳出率->精确到小数点后4位
      |— ip Number 5 IP值
      |— pv Number 10 pv值
      |— time Number 6 平均访问时间
      |— uv Number 5 uv值
   |— now Object 今日
      |— depthNum Number 0
      |— ip Number 5
      |— pv Number 8
      |— time Number 315
      |— uv Number 5
   |— yesterday Object 昨日
      |— depthNum Number 0
      |— ip Number 0
      |— pv Number 0
      |— time Number 0
      |— uv Number 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562315559236
token String

登录

API地址 : /cmsmanager/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 验证码
sessionId String 图形验证码返回的sessionId
siteId Number 当前登录站点ID
codeMessage String 开启双因子传递验证码

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— needChangePassword Boolean 需要修改密码 true需要修改密码
   |— nextNeedCaptcha Boolean true 需要显示验证码,false不需要
   |— JEECMS-Auth-Token String eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiIsImNyZWF0ZWQiOjE1MzE0NTA0MTc0NTQsInVzZXJTb3VyY2UiOiJwbGF0Zm9ybSIsImV4cCI6MTUzMjA1NTIxN30.bha4cjbU-Pj1Rg-kHEhaotWZ4H4JrpxjDbKV2cMDvsLZmjHn-j1PkJIAe5VPdXLekPb6YQ5t9eedJRwqJvYAkg 授权token
   |— auth Object 用户权限
      |— lastLoginTime String 最后登录时间
      |— userName String 用户名称
      |— lastLoginIP String 最后登录ip
      |— routings Array ["权限标识"] 权限标识
         |— 0 String 权限标识
      |— menus Array 路由权限标识
         |— children Array 路由权限子节点
            |— children Array []
            |— component String /index.ashx 页面路径(pagePath)
            |— iconClass String /menu.jpg 菜单图标
            |— id Number 155 标识id
            |— isParent Boolean false 是否为父节点true表示是
            |— isShow Boolean true 是否可见,true表示可见
            |— name String 菜单四 菜单名称
            |— path String /inde4 路由标识(routingIdentifier)
            |— redirect String /sdas 重定向路由标识
         |— component String /index.ashx
         |— iconClass String /menu.jpg
         |— id Number 136
         |— isShow Boolean true
         |— name String 所有权限
         |— parentId Number 0
         |— path String /index
         |— redirect String /sdas
message String Successful!
redirectUrl String
requestUrl String
timestamp Number 1531450417558

退出

API地址 : /cmsmanager/logout

请求方式: post

请求参数类型: form-data

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
token String
AUTHTOKEN String 开启单点登录时需要传递,该值为SSO认证中心颁发的Token值

响应参数

名称 类型 初始值 说明
code Number 200
data Object null
message String Successful!
redirectUrl String
requestUrl String
timestamp Number 1531993092435

上传

API地址 : /cmsmanager/upload/o_upload

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
uploadFile Function 文件类型的哦
spaceId Number 资源文件夹ID
uploadPath String 上传路径,可用于模板上传指定路径上传文件
typeStr String 类型 File文件 Flash Flash Image图片 Media视频 Audio音频 为空则默认Image
mark Boolean 是否使用水印 (true则使用,否则根据站点配置决定是否使用水印)
modelId Number 模型ID(如果是内容管理使用上传,则是内容模型ID,如果是栏目管理使用上传,则使用栏目模型ID)在栏目和内容管理上则必填
fieldName String 模型字段名称(在栏目、内容管理功能上此字段必填,以检查字段上设置的上传校验)
addToRes Boolean false 是否添加到资源库

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— videoCover Object 封面图
   |— dimensions String 1368*599 图片的尺寸
   |— fileSize Number 56 文件大小
   |— fileUrl String /u/gou/www/201806/211453580wtv.png 路径
   |— origName String QQ图片20180621140542.png 文件原始名称
   |— resourceId Number 8 资源唯一标识符ID
message String 操作成功!
redirectUrl String
requestUrl String
timestamp Number 1529564038299

上传文库文档

API地址 : /cmsmanager/upload/document

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 上传文库文档

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
modelId Number 模型ID
uploadFile File 文件

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— duration Number 时间
   |— dimensions String 1368*599 尺寸
   |— fileSize Number 56 文件大小
   |— fileUrl String /wenku/www/201907/311511090lmr.doc 路径
   |— origName String QQ图片20180621140542.png 名称
   |— resourceId String 8 资源ID
message String 操作成功!
redirectUrl String
requestUrl String
timestamp Number 1529564038299

传入中文返回首字母string

API地址 : /language/pinyin

请求方式: get

请求参数类型: url-params

是否启用Header信息:否

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
text String 你好分割数据 传入的string字符串

响应参数

名称 类型 初始值 说明
code Number 200
data String jw 首字母string
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563156699151
token String

自动摘要

API地址 : /language/summary

请求方式: post

请求参数类型: application/json

是否启用Header信息:否

描述: 如果再新建内容是使用了此接口,请注意对应着模型规定的字数进行裁剪

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
text String 你好helloWord 字符串主体
size Number 100 返回的字符串的大小
keySentence Number 10 摘要的关键句子需要几个

响应参数

名称 类型 初始值 说明
code Number 200
data String 你好helloWord
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1563157371375
token String

导入文档

API地址 : /cmsmanager/contentext/docImport

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 导入文档

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
type Number 1.直接导入(不做任何处理)2.清除格式3.仅导入文字
uploadFile File 文件

响应参数

名称 类型 初始值 说明
code Number 200
data String

实习目的:尽快熟悉公司的工作内容,运转方式,为以后的步入社会打下基础;


实习单位:江西金磊科技发展有限公司;


岗位介绍:负责产品的维护以及编写相应的代码,同客户沟通,产品讨论,主管派发任务,按时并高质量的完成相关的工作;





这次实习也让我深刻了解到,在工作中和同事保持良好的关系是很重要的。做事首先要学做人,要明白做人的道理,一个人掌握的信息多、技能多,能帮助别人的地方也多,帮助别人多了,别人也愿意帮助你,而你的人脉也广了,掌握的信息也越来越多。这样就形成一个良性循环。要改变一个人的行为首先得改变他的思想,大多数时候你以什么心态对别人,就会得到怎样的回报。深刻的意识到自己再不能处于独处的状态了。独来独往,别人不主动自己也不理会。把自己个在自己自己的小空间了。总担心别人的看法,把别人想的难以接近。开放的态度使人更快更好的成长。最后,感谢我的同事对我的帮助,真诚的说声谢谢!


html字符串
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2019-08-03 10:44:46
token String

读取微信图片

API地址 : /common/loadingImage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
imageUrl String http://mp.qq.wdd.com 微信图片URL

响应参数

名称 类型 初始值 说明

检测应用是否授权

API地址 : /cmsmanager/authorizations

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— auth Boolean true true已授权登录
   |— mobile String 18870852070 登录账户
message String 成功
redirectUrl String
requestUrl String
timestamp String 2020-01-09 15:24:08
token String

部署产品信息

API地址 : /cmsmanager/authorizations/product

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— version String x1.1.0 产品版本号
   |— productAppId String 4XYBO*3bAk5d3cAk5d3aAk5d39zkdc3YMk5g 产品APPID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-01-09 15:25:32
token String

授权登录应用

API地址 : /cmsmanager/authorizations

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
mobile String 18870852070 手机号
code String 792710 验证码

响应参数

名称 类型 初始值 说明
code Number 200
data String 18870852070 授权账户
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-01-09 15:28:55
token String

开始检测

API地址 : /cmsmanager/siteHealth/start

请求方式: post

请求参数类型: form-data

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 16001
data Object 任务ID
message String 站点已有正在检测扫描任务
redirectUrl String
requestUrl String /admin/siteHealth/start
timestamp String 2020-03-06 16:34:14
token String

结束检测

API地址 : /cmsmanager/siteHealth/stop

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 检测任务ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-03-06 15:51:57
token String

查询检测进度

API地址 : /cmsmanager/siteHealth/getProcess

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
id Number 任务ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— errorCount Number 2 错链数
   |— linkCount Number 373 链接总数
   |— processes Array 已执行任务和正在执行的任务
      |— beginTime Number 1583481020000 开始时间
      |— checkItem Number 14 任务类型1 系统版本 2 辅助插件 3 安全设置检测 4内容更新 * 5访问分析 6内容回收站 7站点回收站 8数据备份文件 9未用文件 10 未用模板 * 11未用静态页面12 首页打开速度 13 SEO信息检测 14 错链检测
      |— endTime Number 1583481118000 完成时间
      |— id Number 142
      |— siteHealthId Number 242
   |— run Boolean false true还在运行中,false已完成
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-03-06 15:52:05
token String

错链列表查询

API地址 : /cmsmanager/siteHealth/getErrorLink

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— id Number 1912
      |— linkSource String http://www.nc.gov.cn/ 错链来源网页地址
      |— linkUrl String v.cn/jxzw/resources/jxzw/bscx/ycbpqd/ncycbp.html 错链地址
      |— siteHealthId Number 242
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-03-06 16:04:03
token String

网站信息

API地址 : /cmsmanager/sitegeneral/info

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— addChannel Object 新建栏目数
      |— high Number 0 历史最高
      |— sum Number 51 累计
      |— today Number 0 今日
      |— yesterday Number 0 昨日
   |— addComment Object 新增评论数
      |— high Number 0
      |— sum Number 9
      |— today Number 1
      |— yesterday Number 0
   |— contentPublish Object 内容发布数
      |— high Number 12
      |— sum Number 7
      |— today Number 0
      |— yesterday Number 12
   |— wechatPublish Object 微信文章发布数
      |— high Number 0
      |— sum Number 0
      |— today Number 0
      |— yesterday Number 0
   |— weiboPublish Object 微博文章发布数
      |— high Number 0
      |— sum Number 0
      |— today Number 0
      |— yesterday Number 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-28 16:06:21
token String

今日流量扩展

API地址 : /cmsmanager/statisticsflow/overview

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 今日流量扩展

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— highest Object 最高
      |— depthNum Number 0 跳出率-精确到小数点后4位
      |— depthNumString String 跳出率-精确到小数点后4位字符串
      |— ip Number 92 IP数
      |— pv Number 209 浏览量
      |— time Number 1320 平均访问时长
      |— timeString String 平均访问时长字符串
      |— uv Number 64 浏览人数
   |— now Object 今日
      |— depthNum Number 0
      |— depthNumString String
      |— ip Number 1
      |— pv Number 42
      |— time Number 732
      |— timeString String
      |— uv Number 1
   |— sum Object 累计
      |— depthNum Null null
      |— depthNumString String --
      |— ip Number 1
      |— pv Number 42
      |— time Null null
      |— timeString String --
      |— uv Number 130
   |— yesterday Object 昨日
      |— depthNum Number 0
      |— depthNumString String
      |— ip Number 0
      |— pv Number 0
      |— time Number 0
      |— timeString String
      |— uv Number 0
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-28 16:19:35
token String

流量贡献值

API地址 : /cmsmanager/sitegeneral/views

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 流量贡献值

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— channel Number 12 栏目浏览量
   |— channelList Array 栏目集合
      |— name String 新闻 栏目名称
      |— value Number 4 浏览量
   |— content Number 27 内容浏览量
   |— contentList Array 内容集合
      |— name String 习近平会见韩国总统文在寅 内容标题
      |— value Number 3 浏览量
   |— index Number 3 首页浏览量
   |— other Number 0 其他浏览量
   |— sum Number 42 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-28 17:16:31
token String

内容发布统计-栏目数据(饼状图/柱状图)

API地址 : /cmsmanager/sitegeneral/channel

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容发布统计-栏目数据(饼状图/柱状图)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startDate String 开始时间(累计可不用传)
endDate String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— publishs Array
      |— name String 求职简历 栏目名称
      |— value Number 4 发布数
   |— sum Number 58 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-28 17:40:31
token String

栏目数据表格

API地址 : /cmsmanager/sitegeneral/channel/data

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 栏目数据表格

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startDate String 开始时间,累计可不传
endDate String 结束时间
page Number 页数
size Number 数量
sort Boolean 排序 true降序 false升序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 58 发布总数
   |— page Object
      |— content Array
         |— name String 新闻 栏目名称
         |— realName String --
         |— value Number 50 发布数
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 4
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 09:15:08
token String

内容发布统计-用户数据(饼状图/柱状图)

API地址 : /cmsmanager/sitegeneral/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容发布统计-用户数据(饼状图/柱状图)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间,累计可不传
endDate String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— publishs Array
      |— name String system 用户名称
      |— value Number 87 发布数
   |— sum Number 87 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:07:16
token String

用户数据表格

API地址 : /cmsmanager/sitegeneral/user/data

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户数据表格

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间,累计可不传
endDate String 结束时间
sort Boolean 排序类型,true倒序 false顺序
key String 关键字
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 145 总数
   |— page Object
      |— content Array
         |— name String system 用户名
         |— realName String 管理 真实姓名
         |— value Number 145 发布数
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 1
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:14:01
token String

内容发布统计-组织数据(饼状图/柱状图)

API地址 : /cmsmanager/sitegeneral/org

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容发布统计-组织数据(饼状图/柱状图)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间
endDate String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— publishs Array
      |— name String 金磊科技 组织名称
      |— value Number 1798 发布数
   |— sum Number 1798 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:25:43
token String

组织数据表格

API地址 : /cmsmanager/sitegeneral/org/data

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 组织数据表格

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间,累计可不传
endDate String 结束时间
sort Boolean true倒序,false升序
key String 关键字
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 8 总数
   |— page Object
      |— content Array
         |— name String 金磊科技 组织名称
         |— realName String --
         |— value Number 8 发布数
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 1
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:31:09
token String

内容发布统计-站点数据(饼状图/柱状图)

API地址 : /cmsmanager/sitegeneral/site

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容发布统计-站点数据(饼状图/柱状图)

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间,累计不传
endDate String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— publishs Array
      |— name String jeecms演示站 站点名称
      |— value Number 453 发布数
   |— sum Number 453 总数
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:34:38
token String

站点数据表格

API地址 : /cmsmanager/sitegeneral/site/data

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 站点数据表格

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
startDate String 开始时间,累计不传
endDate String 结束时间
sort Boolean true倒序,false升序
key String 关键字
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— sum Number 58 总数
   |— page Object
      |— content Array
         |— name String jeecms演示站 站点名称
         |— realName String --
         |— value Number 58 发布数
      |— first Boolean true
      |— last Boolean true
      |— size Number 10
      |— totalElements Number 1
      |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 10:36:41
token String

内容数据统计-按栏目列表分页

API地址 : /cmsmanager/sitegeneral/statistics/channel

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startDate String 开始时间,累计不传
endDate String 结束时间
sortType Number 排序类型 0发布时间 1.阅读量 2.阅读人数 3.点赞数 4.评论数
sort Boolean true倒序 false升序
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentCount Number 17 评论数
      |— likeCount Number 60 点赞数
      |— name String 要闻 栏目名称
      |— peopleCount Number 262 阅读人数
      |— readCount Number 645 阅读量
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 11:08:45
token String

内容数据统计-按单篇内容列表分页

API地址 : /cmsmanager/sitegeneral/statistics/content

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容数据统计-按单篇内容列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startDate String 开始时间,累计不传
endDate String 结束时间
sortType Number 排序类型 0发布时间 1.阅读量 2.阅读人数 3.点赞数 4.评论数
sort Boolean true倒序,false升序
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— commentCount Number 17 评论数
      |— likeCount Number 60 点赞数
      |— name String 习近平会见中国红十字会第十一次全国会员代表大会代表 标题
      |— peopleCount Number 262 阅读人数
      |— publishTime String 2019-11-29 发布时间
      |— readCount Number 645 阅读量
      |— url String http://192.168.0.200:8700/preview?contentId=2307&type=content 预览地址
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 11:19:37
token String

内容数据统计-总数

API地址 : /cmsmanager/sitegeneral/statistics/data

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容数据统计-总数

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
siteId Number 站点ID
startDate String 开始时间
endDate String 结束时间
flag Boolean true栏目,false内容

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— commentCount Number 17 评论总数
   |— likeCount Number 60 点赞数
   |— peopleCount Number 262 阅读人数
   |— readCount Number 645 阅读量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 11:23:02
token String

导出用户数据

API地址 : /cmsmanager/sitegeneral/excel/user

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 导出用户数据

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String 关键字
startDate String 开始时间
endDate String 结束时间
sort String true倒序,false升序

响应参数

名称 类型 初始值 说明

导出组织数据

API地址 : /cmsmanager/sitegeneral/excel/org

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 导出组织数据

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String 关键字
startDate String 开始时间,累计不传
endDate String 结束时间
sort Boolean true倒序,false升序

响应参数

名称 类型 初始值 说明

导出站点数据

API地址 : /cmsmanager/sitegeneral/excel/site

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 导出站点数据

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String 关键字
startDate String 开始时间,累计不传
endDate String 结束时间
sort Boolean true倒序,false升序

响应参数

名称 类型 初始值 说明

内容浏览记录

API地址 : /cmsmanager/content/view/record

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 内容浏览记录

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容ID
startDate String 开始时间,累计不传
endDate String 结束时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— commentCount Number 6 评论数
   |— likeCount Number 12 点赞数
   |— map Array 地图数据
      |— name String 江西 省份名称
      |— value Number 45 阅读量
   |— mobile Number 3 移动设备访问量
   |— mobilePrecent Number 7 移动设备百分比
   |— pc Number 45 PC访问量
   |— pcPrecent Number 93 PC百分比
   |— peopleCount Number 47 阅读人数
   |— readCount Number 48 阅读量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 14:21:19
token String

访问地域表格

API地址 : /cmsmanager/content/view/table

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 访问地域表格

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
contentId Number 内容ID
startDate String 开始时间,累计不传
endDate String 结束时间
sortType Number 排序类型
sort Boolean true倒序,false升序

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— commentCount Number 4 评论数
   |— peopleCount Number 46 阅读人数
   |— province String 江西 省份
   |— readCount Number 45 阅读量
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 14:41:22
token String

校验规则名称

API地址 : /cmsmanager/pfrule/unique/name

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 校验规则名称

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleName String 规则名
ruleId Number 规则ID,修改必传

响应参数

名称 类型 初始值 说明
code Number 200
data Boolean true true通过false不通过
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-29 17:02:30
token String

保存规则

API地址 : /cmsmanager/pfrule

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 保存规则

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleName String 第一次规则 规则名称
ruleType Number 1 评分类型 1.网站发布 2.微信文章发布 3.微博文章发布
ruleObject Number 1 评分对象 1.栏目,2.用户,3.组织,4.站点,5.公众号,6.微博号
rules Array 规则列表
 |-siteId Number 1 站点ID
 |-selectId Array ["1747"] 选择ID
  |-0 String 1747
 |-number Object 数量评分
  |-sumPublish Number 10 总发布数
  |-publishScore Number 2.5 总发布数得分
  |-publishReduce Number 5 总发布数少于设置条数
  |-publishReduceUnit Boolean true 总发布数少于算法类型 true.加 false.减
  |-publishReduceScore Number 1.5 总发布数少于设置分数
  |-publishAdd Number 50 总发布数多于设置条数
  |-publishAddUnit Boolean true 总发布数多于算法类型 true.加 false.减
  |-publishAddScore Number 2.5 总发布数多于设置分数
 |-time Object 时效性评分
  |-everyDayPublish Number 50 每天都发布得到分数
  |-noDayPublish Number 1.5 一天未发布减去分数
  |-noDayPublishMax Number 1.5 一天未发布最多减去分数
 |-site Object 网站质量评分
  |-contentView Number 2 有1篇内容访问量达到设置
  |-contentViewAdd Number 5 有1篇内容访问量达到设置加分数
  |-contentViewMax Number 20.5 有1篇内容访问量最大分数
  |-contentLike Number 10 有1篇内容点赞达到设置
  |-contentLikeAdd Number 5 有1篇内容点赞达到设置加分数
  |-contentLikeMax Number 10.5 有1篇内容点赞最大分数
  |-contentComment Number 2 有1篇内容评论达到设置
  |-contentCommentAdd Number 10.5 有1篇内容评论达到设置加分数
  |-contentCommentMax Number 12.5 有1篇内容评论最大分数
 |-wechat Object 微信质量评分
  |-fansIncrease Number 2 净增粉丝个数
  |-fansIncreaseScore Number 5.5 净增粉丝得分
  |-fansReduce Number 5 粉丝每少个数
  |-fansReduceUnit Boolean true 粉丝每少个数算法类型 true.加 false.减
  |-fansReduceScore Number 2.5 粉丝每少设置分数
  |-fansAdd Number 5 粉丝每多个数
  |-fansAddUnit Boolean true 粉丝每多个数算法类型 true.加 false.减
  |-fansAddScore Number 2.5 粉丝每多设置分数
  |-contentRead Number 50 有1篇内容阅读量到达设置
  |-contentReadAdd Number 2.5 有1篇内容阅读量达到设置加分数
  |-contentReadMax Number 10.5 有1篇内容阅读量最大分数
  |-contentShare Number 10 有1篇内容分享次数到达设置
  |-contentShareAdd Number 10 有1篇内容分享次数达到设置加分数
  |-contentShareMax Number 20.5 有1篇内容分享次数最大分数
  |-contentSource Number 50 有1篇内容原文页阅读次数到达设置
  |-contentSourceAdd Number 25 有1篇内容原文页阅读次数达到设置加分数
  |-contentSourceMax Number 20.5 有1篇内容原文页阅读次数最大分数
 |-weibo Object 微博质量评分
  |-fansIncrease Number 20 净增粉丝个数
  |-fansIncreaseScore Number 20.5 净增粉丝得分
  |-fansReduce Number 10 粉丝每少个数
  |-fansReduceUnit Boolean true 粉丝每少个数算法类型 true.加 false.减
  |-fansReduceScore Number 2.5 粉丝每少设置分数
  |-fansAdd Number 1 粉丝每多个数
  |-fansAddUnit Boolean true 粉丝每多个数算法类型 true.加 false.减
  |-fansAddScore Number 3.5 粉丝每多设置分数
  |-contentForward Number 5 有1篇内容转发数到达设置
  |-contentForwardAdd Number 2.5 有1篇内容转发数达到设置加分数
  |-contentForwardMax Number 5.5 有1篇内容转发数最大分数
  |-contentComment Number 2 有1篇内容评论数到达设置
  |-contentCommentAdd Number 2.5 有1篇内容评论数达到设置加分数
  |-contentCommentMax Number 3.5 有1篇内容评论数最大分数
  |-contentLike Number 5 有1篇内容点赞达到设置
  |-contentLikeAdd Number 2.5 有1篇内容点赞达到设置加分数
  |-contentLikeMax Number 3.5 有1篇内容点赞最大分数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 10:36:11
token String

规则列表分页

API地址 : /cmsmanager/pfrule/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 规则列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
sort Boolean 排序类型,false顺序,true倒序

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime String 2020-06-30 10:36:09 创建时间
      |— createUser String system 创建人
      |— id Number 38 id主键
      |— ruleName String 微博规则 规则名称
      |— ruleType Number 3 评分类型 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 String 2020-06-30 10:47:50
token String

复制规则

API地址 : /cmsmanager/pfrule/copy

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 复制规则

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleId Number 规则ID
ruleName String 规则名称

响应参数

名称 类型 初始值 说明
code Number 200
data Number 55 规则ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 11:17:43
token String

删除规则

API地址 : /cmsmanager/pfrule/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除规则

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleId Number 规则ID

响应参数

名称 类型 初始值 说明
code Number 200
data Number 55
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 11:17:43
token String

规则详情

API地址 : /cmsmanager/pfrule/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 规则详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— ruleObject Number 1 评分对象 1.栏目,2.用户,3.组织,4.站点,5.公众号,6.微博号
   |— id Number 23 规则ID
   |— numbers Array
      |— array Array 数组对象
         |— role String 角色
         |— org String 所属组织
         |— id Number id主键
         |— name String 名称
      |— everyDayPublish Number 50 每天都发布得到分数
      |— id Number 2 评分规则数量ID
      |— noDayPublish Number 1.5 一天未发布减去分数
      |— noDayPublishMax Number 1.5 一天未发布最多减去分数
      |— publishAdd Number 50 总发布数多于设置条数
      |— publishAddScore Number 2.5 总发布数多于设置分数
      |— publishAddUnit Boolean true 总发布数多于算法类型 true.加 false.减
      |— publishReduce Number 5 总发布数少于设置条数
      |— publishReduceScore Number 1.5 总发布数少于设置分数
      |— publishReduceUnit Boolean true 总发布数少于算法类型 true.加 false.减
      |— publishScore Number 2.5 总发布数得分
      |— ruleId Number 23 评分规则id
      |— selectId String [1747] 对应评分对象,多个用逗号隔开
      |— site Object 网站对象
         |— contentComment Number 2 有1篇内容评论达到设置
         |— contentCommentAdd Number 10.5 有1篇内容评论达到设置加分数
         |— contentCommentMax Number 12.5 有1篇内容评论最大分数
         |— contentLike Number 10 有1篇内容点赞达到设置
         |— contentLikeAdd Number 5 有1篇内容点赞达到设置加分数
         |— contentLikeMax Number 10.5 有1篇内容点赞最大分数
         |— contentView Number 2 有1篇内容访问量达到设置
         |— contentViewAdd Number 5 有1篇内容访问量达到设置加分数
         |— contentViewMax Number 20.5 有1篇内容访问量最大分数
         |— id Number 2 主键
         |— ruleNumberId Number 2 评分规则数量id
      |— siteId Number 1 站点ID
      |— sumPublish Number 10 总发布数
      |— wechat Object 微信对象
         |— contentRead Number 50 有1篇内容阅读量到达设置
         |— contentReadAdd Number 2.5 有1篇内容阅读量达到设置加分数
         |— contentReadMax Number 10.5 有1篇内容阅读量最大分数
         |— contentShare Number 10 有1篇内容分享次数到达设置
         |— contentShareAdd Number 10 有1篇内容分享次数达到设置加分数
         |— contentShareMax Number 20.5 有1篇内容分享次数最大分数
         |— contentSource Number 50 有1篇内容原文页阅读次数到达设置
         |— contentSourceAdd Number 25 有1篇内容原文页阅读次数达到设置加分数
         |— contentSourceMax Number 20.5 有1篇内容原文页阅读次数最大分数
         |— fansAdd Number 5 粉丝每多个数
         |— fansAddScore Number 2.5 粉丝每多设置分数
         |— fansAddUnit Boolean true 粉丝每多个数算法类型 true.加 false.减
         |— fansIncrease Number 2 净增粉丝个数
         |— fansIncreaseScore Number 5.5 净增粉丝得分
         |— fansReduce Number 5 粉丝每少个数
         |— fansReduceScore Number 2.5 粉丝每少设置分数
         |— fansReduceUnit Boolean true 粉丝每少个数算法类型 true.加 false.减
         |— id Number 2 主键
         |— ruleNumberId Number 14 规则数量ID
      |— weibo Object 微博用户
         |— contentComment Number 2 有1篇内容评论数到达设置
         |— contentCommentAdd Number 2.5 有1篇内容评论数达到设置加分数
         |— contentCommentMax Number 3.5 有1篇内容评论数最大分数
         |— contentForward Number 5 有1篇内容转发数到达设置
         |— contentForwardAdd Number 2.5 有1篇内容转发数达到设置加分数
         |— contentForwardMax Number 5.5 有1篇内容转发数最大分数
         |— contentLike Number 5 有1篇内容点赞达到设置
         |— contentLikeAdd Number 2.5 有1篇内容点赞达到设置加分数
         |— contentLikeMax Number 3.5 有1篇内容点赞最大分数
         |— fansAdd Number 1 粉丝每多个数
         |— fansAddScore Number 3.5 粉丝每多设置分数
         |— fansAddUnit Boolean true 粉丝每多个数算法类型 true.加 false.减
         |— fansIncrease Number 20 净增粉丝个数
         |— fansIncreaseScore Number 20.5 净增粉丝得分
         |— fansReduce Number 10 粉丝每少个数
         |— fansReduceScore Number 2.5 净增粉丝得分
         |— fansReduceUnit Boolean true 粉丝每少个数算法类型 true.加 false.减
         |— id Number 2 主键
         |— ruleNumberId Number 18 规则数量ID
   |— ruleName String 网站规则 规则名称
   |— ruleType Number 1 评分类型 1.网站发布 2.微信文章发布 3.微博文章发布
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 11:32:45
token String

修改规则

API地址 : /cmsmanager/pfrule

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述: 修改规则

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleName String 第一次规则
ruleType Number 1
ruleObject Number 1
rules Array
 |-id Number 数量与质量ID
 |-siteId Number 1
 |-selectId Array ["1747"]
  |-0 String 1747
 |-number Object
  |-sumPublish Number 10
  |-publishScore Number 2.5
  |-publishReduce Number 5
  |-publishReduceUnit Boolean true
  |-publishReduceScore Number 1.5
  |-publishAdd Number 50
  |-publishAddUnit Boolean true
  |-publishAddScore Number 2.5
 |-time Object
  |-everyDayPublish Number 50
  |-noDayPublish Number 1.5
  |-noDayPublishMax Number 1.5
 |-site Object
  |-contentView Number 2
  |-contentViewAdd Number 5
  |-contentViewMax Number 20.5
  |-contentLike Number 10
  |-contentLikeAdd Number 5
  |-contentLikeMax Number 10.5
  |-contentComment Number 2
  |-contentCommentAdd Number 10.5
  |-contentCommentMax Number 12.5
 |-wechat Object
  |-fansIncrease Number 2
  |-fansIncreaseScore Number 5.5
  |-fansReduce Number 5
  |-fansReduceUnit Boolean true
  |-fansReduceScore Number 2.5
  |-fansAdd Number 5
  |-fansAddUnit Boolean true
  |-fansAddScore Number 2.5
  |-contentRead Number 50
  |-contentReadAdd Number 2.5
  |-contentReadMax Number 10.5
  |-contentShare Number 10
  |-contentShareAdd Number 10
  |-contentShareMax Number 20.5
  |-contentSource Number 50
  |-contentSourceAdd Number 25
  |-contentSourceMax Number 20.5
 |-weibo Object
  |-fansIncrease Number 20
  |-fansIncreaseScore Number 20.5
  |-fansReduce Number 10
  |-fansReduceUnit Boolean true
  |-fansReduceScore Number 2.5
  |-fansAdd Number 1
  |-fansAddUnit Boolean true
  |-fansAddScore Number 3.5
  |-contentForward Number 5
  |-contentForwardAdd Number 2.5
  |-contentForwardMax Number 5.5
  |-contentComment Number 2
  |-contentCommentAdd Number 2.5
  |-contentCommentMax Number 3.5
  |-contentLike Number 5
  |-contentLikeAdd Number 2.5
  |-contentLikeMax Number 3.5
id Number 规则ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 14:11:45
token String

开始评分

API地址 : /cmsmanager/pfscore

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 开始评分

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleId Number 23 规则ID
startDate String 2020-06-01 开始周期
endDate String 2020-06-30 结束周期
saturday Boolean true 是否排除礼拜六
sunday Boolean true 是否排除礼拜天
excludeDate Array 排除日期集合

响应参数

名称 类型 初始值 说明
code Number 200
data Number 13 周期ID
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 14:34:43
token String

删除评分周期

API地址 : /cmsmanager/pfscore/delete

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 删除评分周期

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dateId Number 周期ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 16:26:41
token String

查看绩效列表分页

API地址 : /cmsmanager/pfscore/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 查看绩效列表分页

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dateId Number 周期ID
key String 关键字
sortType Number 排序类型1.数量评分 2.时效性评分 3.质量评分 4.绩效总分
sort Boolean true倒序false升序
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— rank Number 排名
      |— scoreObj Number 评分对象 1.栏目,2.用户,3.组织,4.站点,5.公众号,6.微博号
      |— id Number 84 周期ID
      |— massScore Number 0 质量得分
      |— name String 新闻 名称
      |— numberScore Number 4 数量得分
      |— sumScore Number 4 总分
      |— timeScore Number 0 时效得分
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 17:51:35
token String

绩效评分导出excel

API地址 : /cmsmanager/pfscore/excel

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 绩效评分导出excel

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
dateId Number 周期ID
key String 关键字
sortType Number 排序类型1.数量评分 2.时效性评分 3.质量评分 4.绩效总分
sort Boolean true倒序false顺序

响应参数

名称 类型 初始值 说明

绩效详情

API地址 : /cmsmanager/pfscore/{id}

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 绩效详情

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— shows Object 是否显示对象
      |— weiboLike Boolean 是否显示内容点赞数该行数据
      |— weiboComment Boolean 是否显示内容评论数该行数据
      |— weiboTransmit Boolean 是否显示内容转发数该行数据
      |— weiboFans Boolean 是否显示净增粉丝数该行数据
      |— wechatSource Boolean 是否显示原文页阅读次数该行数据
      |— wechatShare Boolean 是否显示内容分享次数该行数据
      |— wechatRead Boolean 是否显示内容阅读量该行数据
      |— wechatFans Boolean 是否显示净增粉丝数该行数据
      |— siteComment Boolean 是否显示内容评论数该行数据
      |— siteLike Boolean 是否显示内容点赞数该行数据
      |— siteView Boolean 是否显示内容访问量该行数据
      |— noday Boolean 是否显示一天未发布该行数据
      |— everyday Boolean 是否显示每天都发布该行数据
      |— publish Boolean 是否显示总发布数该行数据
      |— numberId Number 时效性主键
   |— details Object
      |— sumPublish Number 发布总数
      |— everyDayScore Number 0 每天发布得分
      |— id Number 84 详情ID
      |— noDay Number 0 未发布天数
      |— noDayScore Number 0 未发布得分
      |— numberScore String 2.5+2.5=4.0 得分算法计算公式
      |— scoreId Number 84 评分ID
      |— sumScore Number 4 总分
   |— detailsSite Object
      |— contentComment Number 0 内容评论量数
      |— contentCommentOver Number 2 内容评论量达到数
      |— contentCommentScore Number 0 内容评论量得分
      |— contentLike Number 0 内容点赞数
      |— contentLikeOver Number 10 内容点赞达到数
      |— contentLikeScore Number 0 内容点赞得分
      |— contentView Number 0 内容访问量数
      |— contentViewOver Number 2 内容访问量达到数
      |— contentViewScore Number 0 内容访问量得分
      |— id Number 64 主键
      |— scoreId Number 84 评分ID
   |— detailsWechat Null null 微信对象
   |— detailsWeibo Null null 微博对象
   |— name String 新闻 名称
   |— rank Number 0 排名
   |— scoreObj Number 1 评分对象 1.栏目,2.用户,3.组织,4.站点,5.公众号,6.微博号
   |— sum Number 4 总分
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:06:16
token String

数量评分查看明细

API地址 : /cmsmanager/pfscore/details/number

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 数量评分查看明细

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
detailsId Number 数量评分查看明细

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— channelName String 财经 栏目名称
      |— commentCount Number null 评论数
      |— contentTitle String 标题 标题
      |— contentUrl String http://192.168.0.200:8700/preview?contentId=36562&type=content 预览地址
      |— id Number 1585 主键
      |— likeCount Number 0 点赞数
      |— publishTime Number 1591162841000 发布时间
      |— scoreDetailsId Number 84 详情ID
      |— type Number 1 1.数量评分 2.质量评分访问量 3. 质量评分点赞数 4.质量评分评论数
      |— viewCount Number 0 阅读量
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:16:07
token String

时效性评分查看明细

API地址 : /cmsmanager/pfscore/details/time

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 时效性评分查看明细

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
detailsId Number 评分详情ID

响应参数

名称 类型 初始值 说明
code Number 200
data Array
   |— id Number 64
   |— publishCount Number 2 次数
   |— publishDate String 2020-06-03 日期
   |— scoreDetailsId Number 84
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:24:54
token String

质量评分访问量查看明细

API地址 : /cmsmanager/pfscore/details/views

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 质量评分访问量查看明细

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
detailsId Number 评分详情ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— channelName String 财经
      |— commentCount Null null
      |— contentTitle String
      |— contentUrl String http://192.168.0.200:8700/preview?contentId=36562&type=content
      |— id Number 1585
      |— likeCount Null null
      |— publishTime Number 1591162841000
      |— scoreDetailsId Number 84
      |— type Number 1
      |— viewCount Null null
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:16:07
token String

质量评分点赞查看明细

API地址 : /cmsmanager/pfscore/details/like

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 质量评分点赞查看明细

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
detailsId Number 详情ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— channelName String 财经
      |— commentCount Null null
      |— contentTitle String
      |— contentUrl String http://192.168.0.200:8700/preview?contentId=36562&type=content
      |— id Number 1585
      |— likeCount Null null
      |— publishTime Number 1591162841000
      |— scoreDetailsId Number 84
      |— type Number 1
      |— viewCount Null null
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:16:07
token String

质量评分评论查看明细

API地址 : /cmsmanager/pfscore/details/comment

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 质量评分评论查看明细

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
detailsId Number 详情ID

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— channelName String 财经
      |— commentCount Null null
      |— contentTitle String
      |— contentUrl String http://192.168.0.200:8700/preview?contentId=36562&type=content
      |— id Number 1585
      |— likeCount Null null
      |— publishTime Number 1591162841000
      |— scoreDetailsId Number 84
      |— type Number 1
      |— viewCount Null null
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 18:16:07
token String

评分列表

API地址 : /cmsmanager/pfrule/scorelist

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 评分列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
ruleId Number 规则ID
sort Boolean true倒序,false升序
size Number 数量
page Number 页数

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— excludeDate String 排除日期
      |— ruleId String 规则ID
      |— id Number 84 主键
      |— startDate Number 开始时间
      |— endDate String 结束时间
      |— status Number 计算状态 1.完成,0.计算中 2失败
      |— saturday Number 是否排除礼拜六
      |— sunday Number 是否排除礼拜天
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 1
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-06-30 17:51:35
token String

用户密级设置-待设置列表

API地址 : /cmsmanager/usersecret/nosetpage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户密级设置-待设置列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String 关键字
orgid Number 组织ID
roleid Number 角色ID
page Number 页数
size Number 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime String 2020-02-20 15:53:46 创建时间
      |— createUser String system 创建人
      |— email String 邮箱
      |— enabled Boolean true true启用false禁用
      |— id Number 1172 用户ID
      |— orgName String 金磊科技 组织名
      |— roleNames String 角色名
      |— userExt Object
         |— linephone String 座机
         |— realname String 真名
      |— userSecret Null null 用户密级对象
      |— username String test 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-28 11:34:41
token String

用户密级设置-已设置列表

API地址 : /cmsmanager/usersecret/setpage

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 用户密级设置-已设置列表

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
key String 关键字
orgid Number 组织ID
roleid Number 角色ID
enabled Boolean true启用,false禁用
userSecretId Number 用户密级ID
page Number 页数
size String 数量

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— createTime String 2020-02-20 15:53:46
      |— createUser String system
      |— email String
      |— enabled Boolean true
      |— id Number 1172
      |— orgName String 金磊科技
      |— roleNames String
      |— userExt Object
         |— linephone String
         |— realname String
      |— userSecret Null null
      |— username String test
   |— first Boolean true
   |— last Boolean true
   |— size Number 20
   |— totalElements Number 2
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-28 11:34:41
token String

用户密级设置-批量设置密级

API地址 : /cmsmanager/usersecret

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述: 用户密级设置-批量设置密级

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
userSecretId Number 144 用户密级ID
users Array [1] 用户ID数组
 |-0 Number 1

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-28 11:38:14
token String

查询详情

API地址 : /cmsmanager/reinsurance

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
code Number 200
data Object
 |-auditAdmins Array 审计员用户集合
  |-id Number 1 用户id
  |-username String system 用户名
 |-automaticEnable Boolean true 用户设置密级后是否自动启动:true->启动,false->不启动
 |-enable Boolean true 是否开启分保:true->开启,false->不开启
 |-safetyAdmins Array 安全员用户集合
  |-id Number 1 用户id
  |-username String system 用户名
 |-userSecretId Number 145 用户密级id
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 11:44:42
token String

响应参数

名称 类型 初始值 说明

修改分保设置

API地址 : /cmsmanager/reinsurance

请求方式: put

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
userSecretId Number 145 用户密级id
enable Boolean true 是否开启分保:true->开启,false->不开启分保
automaticEnable Boolean true 用户设置密级后是否自动启动:true->启动,false->不启动
safetyAdminIds Array [1] 安全员用户id集合
 |-0 Number 1 用户id
auditAdminIds Array [1] 审计员用户id集合
 |-0 Number 1 用户id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 11:44:40
token String

校验用户是否有菜单权限

API地址 : /cmsmanager/reinsurance/check/user/menu

请求方式: post

请求参数类型: application/json

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
userIds Array [1] 校验的用户id集合
 |-0 Number 1 用户id
status Number 1 1-安全员、2-审计员

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 11:44:40
token String

校验用户菜单权限

API地址 : /cmsmanager/reinsurance/check/admin/menu

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 进入页面校验是否有菜单类权限,如果抛出13187的自定义错误,那么直接跳转无权限页面

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
status Number 1 进入页面的状态:1-用户密级设置、2-用户日志

响应参数

名称 类型 初始值 说明
code Number 200
data Object
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 11:55:10
token String

设置安全员或审计员的人员分页列表

API地址 : /cmsmanager/users/reinsurance/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
page Number 1 页码
size Number 10 每页的大小
key Number 1 用户名和真名
orgid Number 1 组织id
roleid Number 1 角色id
notIds Array [100] 需要排除的用户集合
 |-0 Number 100 用户id

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array 用户对象
      |— enabled Boolean true 是否开启
      |— id Number 1182 用户id
      |— managerAble Boolean true 是否可管理
      |— orgName String 金磊科技 组织名称
      |— roleNames String 角色名称
      |— userExt Object 用户扩展对象
         |— realname String 用户真实姓名
      |— username String 1 用户名
   |— first Boolean true
   |— last Boolean true
   |— size Number 10
   |— totalElements Number 3
   |— totalPages Number 1
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 15:16:55
token String

是否显示分级保护标识

API地址 : /cmsmanager/reinsurance/isShow

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述: 后台登录页,系统头部

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— hasShow Boolean false
   |— name String
   |— userSecret String
message String 操作成功
redirectUrl String
requestUrl String
timestamp String 2020-07-29 10:05:24
token String

用户日志

API地址 : cmsadmin/reinsurance/user/page

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名
clientIp String 客户ip
subEventType String 子事件类型
logLevel String 日志级别
operateType String 操作类型
requestResult String 请求结果
beginDate String 开始时间
endDate String 时间时间

响应参数

名称 类型 初始值 说明
code Number 200
data Object
   |— content Array
      |— logType String 1 信息 2 警告
      |— clientIp String 192.168.0.194 客户端请求IP地址
      |— createTime Number 1562574875000 请求时间
      |— eventType Number 1 事件类型(1-系统事件 2-业务事件)
      |— id Number 10947
      |— logCategory Number 1 日志分类(1-系统日志)
      |— logLevel Number 3 日志级别(1-高 2-中 3-低
      |— method String GET 请求方式method,post,get等
      |— operateType Number 1 操作类型(1-查询 2-新增 3-修改 4-删除 5-导出 6-导入 7-上传 8-下载9登录10退出)
      |— requestResult Number 1 请求结果(1-成功 2-失败)
      |— subEventType String 事件子类型
      |— timeConsuming Number 54 请求耗时(毫秒单位)
      |— uri String /admin/orgs/orgname/unique 日志请求地址
      |— username String system 操作用户名
   |— first Boolean true
   |— last Boolean false
   |— size Number 10
   |— totalElements Number 10380
   |— totalPages Number 1038
message String 操作成功
redirectUrl String
requestUrl String
timestamp Number 1562574875688
token String

导出用户日志

API地址 : cmsadmin/reinsurance/export

请求方式: get

请求参数类型: url-params

是否启用Header信息:是

描述:

Header参数

参数名 说明
JEECMS-Auth-Token 权限验证信息头,可从登陆成功之后返回信息中获取

请求参数

名称 类型 必填 初始值 说明
username String 用户名
clientIp String 客户ip
subEventType String 子事件类型
logLevel String 日志级别
operateType String 操作类型
requestResult String 请求结果
beginDate String 开始时间
endDate String 结束时间

响应参数

名称 类型 初始值 说明

附录1:响应状态码

CODE 公共 说明
100 非法的参数
101 不完整的参数
102 未知错误
103 生产环境下无法操作数据
105 记录未找到
200 成功
301 freemarker错误
320 缺少加密参数
321 解密错误
403 您没有权限访问
404 未找到服务
500 服务器内部错误
501 用户未登录
502 账户被锁定
503 缺少会话信息,请重新登录!
504 验证码错误
506 会话已失效,请重新登录!
507 站点未找到
511 系统防火墙已阻止本次操作
601 无权访问非当前站点数据,非法操作
602 站点已关闭
603 您非站点管理员账户
701 缺少验证ValidateToken参数对象
703 公众号或小程序未授权
810 数据已被删除
10100 上传文件错误
10102 上传IO错误
10103 上传非图片
10104 上传文件格式错误
10105 上传超出限制
10106 上传错误
10107 上传OSS失败
10108 上传文件文件夹错误
10113 没有该组织管理权限
10114 没有该角色管理权限
10115 没有该用户管理权限
10120 热词已存在
10121 热词分类已存在
10122 敏感词已存在
10124 搜索词已存在
10125 TAG词已存在
10126 水印图片不存在
10128 导入模板错误
10129 年号已存在
10130 机关代字已存在
10131 下载IO异常
10132 IO异常
10133 通知短信最多上限100个
10134 通知邮箱最多上限100个
10135 手机格式错误
10136 邮箱格式错误
10137 文件未找到
10138 语言标识已存在
10139 语言标识不能为空
10140 语言名称不能为空
10141 系统默认无法删除
10143 友情链接类型名称已存在
10144 上传设置水印错误
10145 存在孤立连线
10146 存在孤立节点
10147 缺少开始节点
10148 缺少结束节点
10149 存在多个开始节点
10150 开始节点只能连接审核节点
10151 结束节点存在出口线
10152 结束节点没有入口线
10153 同一节点中存在相同动作类型的连线
10154 开始节点没有出口线
10155 连线未指定动作
10157 工作流规则错误
10158 自定义动作类型连线不能连接开始节点
10159 存在缺少通过类型连线的节点
10160 工作流部署错误
10161 存在多个结束节点
10162 开始节点只能连接一个审核节点
10163 自定义的动作类型不能连接结束节点
10164 存在缺少不通过类型连线的节点
10165 工作流名称重复
10166 人员密级已存在
10167 内容密级已存在
10168 附件密级已存在
10217 导出模板错误
10501 邮箱已经存在
10502 电话号码已经存在
10509 不可引用自身的栏目
10510 该栏目已经存在该内容的引用
10511 标题不允许重复
10513 内容必须加密
10515 生成静态html-未找到模板
10516 生成静态html-模板语法错误
10526 不能在下线时间后或下线时间小于发布时间进行发布操作
10527 内容所在栏目未配置工作流
10528 内容未提交流程,不能审核
10529 流程任务不存在,流程已处理或者不是您操作的数据
10530 流程节点不存在
10531 处理意见必填
10532 没有可以撤回的动作
10533 流程已经结束,不允许撤回
10534 流程配置该动作不允许撤回
10535 会签不支持撤回
10536 数据正在流转中,不能再次发起提交审核
11008 没有该栏目的合并权限
11009 栏目不在该站点下
11010 栏目父类id未传或是传入有不同的多个
11503 站点资源目录重复或者为空错误
11504 站点域名重复或者为空错误
11512 站群推送秘钥错误
12500 消息校验Token必须是16位的字母和数字组合
12501 消息加解密Key必须是43位的字母和数字组合
12510 第三方调用失败
12518 微信已经绑定了小程序
12523 上传图片格式错误,仅支持支持bmp/png/jpeg/jpg/gif格式
12524 上传语音格式错误,仅支持支持mp3/wma/wav/amr格式
12525 上传略缩图格式错误,仅支持jpg
12526 上传视频格式错误,仅支持mp4/avi/wmv
12531 标签名称已经存在
12532 参数错误,站点不允许为空
12533 该公众号/小程序已绑定在了站点:{siteName},请解绑后重试或更换公众号重试
12534 该公众号、小程序不在站点下
12537 请求类型错误
12538 默认快捷登录账号下无法取消授权
12539 传入的id的类型错误
12540 菜单状态不对,请检查后重试
12541 小程序模板无法转换成模板
12542 小程序模板被设置为最新无法删除
12543 没有设置最新模板
12544 上线版本状态错误
13001 区域编号已存在
13002 模版ID不能为空
13003 消息内容不能为空
13004 模版标题不能为空
13127 定时任务名称已存在
13128 菜单标识已存在
13131 api地址已存在
13134 AppId不能为空
13135 地区码不能为空
13136 访问域名不能为空
13137 阿里云endPoint不能为空
13138 自动退出周期不能为空
13139 百度推送Token不能为空
13140 所需积分最小值不能大于最大值
13141 设置的所需积分超过范围
13142 模型名称已经存在
13143 栏目名称已经存在
13144 栏目路径已经存在
13145 内容类型名称已经存在
13146 来源名称已经存在
13146 来源名称已经存在
13147 该评论不属于该站点数据,请检查后重新操作
13148 用户或ip已经被禁止,请检查后重新操作
13149 该禁言数据不属于该站点数据,请检查后重新操作
13150 ip地址错误
13151 IP地址不在区间内
13154 不是底层栏目
13155 栏目不允许为空
13156 本站模型中不允许新增会员模型
13157 会员模型已存在,不允许重复创建
13158 会员模型基本信息无法修改
13161 路由地址已经存在
13171 安全管理员或审计管理员传入错误
13175 三元管理未开启,无法进行修改
13183 请保证所选用户中至少有一个用户配置了三员审核菜单权限!
13185 消息模板id传入错误
13187 用户缺少菜单类权限
13188 请保证所选用户中至少有一个用户配置了菜单权限!
14008 账户名或者密码错误
14010 账户已经存在
14023 存在不可操作数据
14024 用户必须是管理员
14507 服务市场未授权
15001 重复的名称
15002 默认类型不允许删除
15003 用户未登录
15004 提交信件超过限制
15005 选项必填
15006 文件类型不允许
15007 文件超过大小
15008 文件数量超过限定
15009 该类型未设置表单
15010 该类型未找到
15011 该信件未找到
15012 信件评分错误,必须是2-10之间
15013 未开启评价!
15014 非自己信件不可评价!
15015 未回复不可评价!
15016 不可重复评价!
15017 不能转到当前信件停留信箱!
15018 信件回复正在审核中,不可再修改!
15023 该信件暂未办理,无法撤销!
16001 站点已有正在检测扫描任务
702 配置开放平台未设置或者请等待10分钟等待微信开放平台推送相关的component_verify_ticket