ujcms
  1. 数据
ujcms
  • 数据
    • 栏目列表_ChannelList
      GET
    • 栏目对象_Channel
      GET
    • 栏目对象ByAlias_Channel
      GET
    • 文章列表_ArticleList
      GET
    • 文章分页_ArticlePage
      GET
    • 文章对象_Article
      GET
    • 上一篇文章_ArticlePrev
      GET
    • 下一篇文章_ArticleNext
      GET
    • 全文检索文章分页_EsArticlePage
      GET
    • 全文检索文章列表_EsArticleList
      GET
    • 区块项列表_BlockItemList
      GET
    • 字典列表_DictList
      GET
    • 模型列表_ModelList
      GET
    • 模型对象_Model
      GET
    • Tag列表_TagList
      GET
    • Tag分页_TagPage
      GET
    • 获取Tag对象
      GET
    • 表单列表_FormList
      GET
    • 表单分页_FormPage
      GET
    • 获取表单对象
      GET
    • 站点列表_SiteList
      GET
    • 站点对象_Site
      GET
    • 投票列表_VoteList
      GET
    • 投票分页_VotePage
      GET
    • 投票对象_Vote
      GET
    • 留言列表_MessageBoardList
      GET
    • 留言分页_MessageBoardPage
      GET
    • 获取留言对象
      GET
    • 留言类型列表_MessageBoardTypeList
      GET
    • 调查问卷列表_SurveyList
      GET
    • 调查问卷分页_SurveyPage
      GET
    • 调查问卷对象_Survey
      GET
    • 文章排行榜列表_LeaderBoardList
      GET
    • 文章排行榜分页_LeaderBoardPage
      GET
  • 内容
    • 栏目接口
      • 获取栏目浏览次数
      • 获取栏目统计数据
    • 文章接口
      • 顶文章
      • 记录下载次数
      • 踩文章
      • 获取文章浏览次数
      • 获取下载参数
      • 获取文章统计数据
    • 站点接口
      • 获取站点缓冲对象,并记录浏览量
      • 获取当前站点对象。如果传递subDir参数,则通过子目录查询当前站点;否则通过当前域名获取对应站点对象,无法获取则返回默认站点
      • 获取站点缓冲对象
    • 投票接口
      • 投票
    • 留言接口
      • 提交留言
    • 调查问卷接口
      • 投票
  • 用户
    • JWT认证接口
      • 刷新TOKEN
      • 退出。一般情况下JWT无需服务器端退出。该方法主要用于记录退出日志
      • 登录
    • 注册接口
      • 用户注册
    • 密码接口
      • 更新密码
      • 重置密码
    • 会员设置接口
      • 更新个人信息
      • 更新手机号码
      • 更新邮箱地址
      • 更新个人头像
    • 用户接口
      • 用户名是否未使用
      • 用户名是否存在
      • 手机号码是否未使用
      • 手机号码是否存在
      • 邮箱地址是否未使用
      • 邮箱地址是否存在
    • 上传接口
      • avatarUpload
      • avatarCrop
  • 系统
    • 环境接口
      • 是否开启双因子登录
      • 获得当前登录用户
      • 获取当前站点列表
      • csrf 参数
      • 获取Config配置
      • 获取客户端SM2加密 public key
    • 验证码接口
      • 尝试验证码是否正确
      • 是否显示验证码。当登录错误超过指定次数后,需要输入验证码
      • 获取验证码Token
    • 短信接口
      • 发送手机短信
      • 发送邮件短信
      • 验证手机短信是否正确
      • 验证邮件短信是否正确
  • 其它
    • 访问统计接口
      • 记录访问统计接口
      • 获取在线访问者数量
  1. 数据

留言列表_MessageBoardList

GET
/api/message-board
留言接口

请求参数

Query 参数
siteId
integer <int64>
可选
站点ID。默认为当前站点
typeId
integer <int64>
类型ID
可选
isRecommended
boolean 
可选
是否推荐。如:true false
isReplied
boolean 
可选
是否回复。如:true false
isAllSite
boolean 
可选
是否获取所有站点调查问卷。如:true false,默认false
offset
integer <int32>
可选
从第几条数据开始获取。默认为0,即从第一条开始获取
limit
integer <int32>
可选
共获取多少条数据。最大不能超过1000

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.ujcms.com/api/message-board'

返回响应

🟢200成功
*/*
OK
Body
array of:
id
integer <int64>
留言ID
必需
siteId
integer <int64>
站点ID
必需
typeId
integer <int64>
类别ID
必需
userId
integer <int64>
留言用户ID
必需
replyUserId
integer <int64>
回复用户ID
可选
title
string 
留言标题
必需
created
string <date-time>
创建日期
必需
replyDate
string <date-time>
回复日期
可选
contact
string 
联系人
可选
nickname
string 
昵称
可选
phone
string 
电话号码
可选
email
string 
电子邮箱
可选
address
string 
联系地址
可选
open
boolean 
是否公开
必需
ip
string 
IP地址
必需
replied
boolean 
是否回复
必需
recommended
boolean 
是否推荐
必需
status
integer <int32>
必需
状态(0:已审核,1:未审核,2:已屏蔽)
text
string 
留言内容
可选
replyText
string 
回复内容
可选
type
object (MessageBoardType_List) 
留言类型 实体类
可选
id
integer <int64>
留言类别ID
必需
siteId
integer <int64>
站点ID
可选
name
string 
名称
可选
description
string 
描述
可选
order
integer <int64>
排列顺序
必需
site
object (Site_List) 
站点实体类
可选
id
integer <int64>
站点ID
必需
parentId
integer <int64>
上级站点ID
可选
orgId
integer <int64>
组织ID
必需
modelId
integer <int64>
模型ID
必需
name
string 
名称
必需
description
string 
描述
可选
protocol
string 
必需
协议(http,https)
domain
string 
域名
必需
正则匹配:
^(?!(uploads|templates|WEB-INF|cp)$)[a-z0-9-.]*
subDir
string 
子目录
可选
正则匹配:
^(?!(uploads|templates|WEB-INF|cp)$)[\w-]*
theme
string 
主题
必需
mobileTheme
string 
手机端主题
必需
pageSize
integer <int32>
每页条数
必需
logo
string 
LOGO
可选
seoTitle
string 
SEO标题
可选
seoKeywords
string 
SEO关键词
可选
seoDescription
string 
SEO描述
可选
staticFile
string 
静态页文件
可选
mobileStaticFile
string 
手机端静态页文件
可选
editorSettings
string 
编辑器设置
可选
status
integer <int32>
必需
状态(0:正常,1:关闭)
depth
integer <int32>
层级
必需
order
integer <int32>
排列顺序
必需
views
integer <int64>
浏览次数
必需
selfViews
integer <int64>
首页浏览次数
必需
todayViews
integer <int32>
今日浏览次数
必需
yesterdayViews
integer <int32>
昨日浏览次数
必需
maxViews
integer <int32>
最高浏览次数
必需
maxDate
string <date-time>
最高浏览日期
必需
mainsJson
string 
可选
自定义主字段JSON
clobsJson
string 
可选
自定义大字段JSON
customs
object 
自定义字段
可选
watermark
object (Site.Watermark_List) 
水印设置
可选
html
object (Site.Html_List) 
静态页配置
可选
messageBoard
object (Site.MessageBoard_List) 
留言板设置
可选
editor
object 
可选
copyFromId
integer <int64>
复制站点ID
可选
copyData
array[string]
复制数据
可选
hasChildren
boolean 
是否有子站点
可选
parent
object (Site_List) 
站点实体类
可选
org
object (Org_List) 
组织实体类
可选
model
object (Model_List) 
模型实体类
可选
enabled
boolean 
可选
url
string 
URL地址
可选
filesPath
string 
可选
模板文件路径。如:/templates/1/default/_files
api
string 
可选
API 接口地址。如:{@code /contextPath/frontend}
mobileStaticUrl
string 
可选
手机端静态URL地址
dynamicUrl
string 
动态URL地址
可选
staticUrl
string 
静态URL地址
可选
normalStaticUrl
string 
可选
PC端静态URL地址
dy
string 
可选
动态地址,含部署路径、子目录,不含域名、端口。如:{@code /contextPath/subDir}
names
array[string]
可选
站点层级名称。从一级栏目到当前栏目的名称列表
template
string 
可选
staticBase
string 
可选
paths
array[object (Site_List) {58}] 
可选
站点层级。从一级站点到当前站点的列表
disabled
boolean 
可选
htmlEnabled
boolean 
可选
title
string 
可选
标题。先获取SeoTitle,如不存在则获取网站名称
targetBlank
boolean 
是否新窗口打开
可选
user
object (User_List) 
用户实体类
可选
id
integer <int64>
用户ID
必需
groupId
integer <int64>
用户组ID
必需
orgId
integer <int64>
组织ID
必需
username
string 
用户名
必需
email
string 
电子邮箱
可选
mobile
string 
手机号码
可选
alias
string 
博客地址
可选
nickname
string 
昵称
可选
realName
string 
真实姓名
可选
gender
integer <int32>
必需
性别(0:保密,1:男,2:女)
avatar
string 
头像URL
可选
passwordModified
string <date-time>
密码修改时间
必需
rank
integer <int32>
等级
必需
type
integer <int32>
必需
类型(1:系统管理员,2:安全管理员,3:审计管理员,4:常规管理员,5:前台会员)
status
integer <int32>
必需
状态(0:正常,1:未激活,2:已锁定,3:已注销)
group
object (Group_List) 
用户组实体类
可选
org
object (Org_List) 
组织实体类
可选
roleList
array[object (Role_List) {19}] 
角色列表
可选
orgList
array[object (Org_List) {11}] 
扩展组织列表
可选
name
string 
可选
用户名和用户真实姓名
location
string 
居住地
可选
created
string <date-time>
创建日期
可选
enabled
boolean 
是否正常状态
可选
root
boolean 
可选
是否超级管理员。ID为1的用户为超级管理员
loginDate
string <date-time>
最后登录日期
必需
loginCount
integer <int32>
登录次数
必需
loginIp
string 
最后登录IP
必需
largeAvatar
string 
大头像
可选
mediumAvatar
string 
中头像
可选
birthday
string <date-time>
出生日期
可选
bio
string 
自我介绍
可选
homepage
string 
个人主页
可选
smallAvatar
string 
小头像
可选
replyUser
object (User_List) 
用户实体类
可选
示例
[
    {
        "id": 0,
        "siteId": 0,
        "typeId": 0,
        "userId": 0,
        "replyUserId": 0,
        "title": "string",
        "created": "2019-08-24T14:15:22Z",
        "replyDate": "2019-08-24T14:15:22Z",
        "contact": "string",
        "nickname": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "open": true,
        "ip": "string",
        "replied": true,
        "recommended": true,
        "status": 0,
        "text": "string",
        "replyText": "string",
        "type": {
            "id": 0,
            "siteId": 0,
            "name": "string",
            "description": "string",
            "order": 0
        },
        "site": {
            "id": 0,
            "parentId": 0,
            "orgId": 0,
            "modelId": 0,
            "name": "string",
            "description": "string",
            "protocol": "string",
            "domain": "string",
            "subDir": "string",
            "theme": "string",
            "mobileTheme": "string",
            "pageSize": 0,
            "logo": "string",
            "seoTitle": "string",
            "seoKeywords": "string",
            "seoDescription": "string",
            "staticFile": "string",
            "mobileStaticFile": "string",
            "editorSettings": "string",
            "status": 0,
            "depth": 0,
            "order": 0,
            "views": 0,
            "selfViews": 0,
            "todayViews": 0,
            "yesterdayViews": 0,
            "maxViews": 0,
            "maxDate": "2019-08-24T14:15:22Z",
            "mainsJson": "string",
            "clobsJson": "string",
            "customs": {
                "property1": {},
                "property2": {}
            },
            "watermark": {
                "enabled": true,
                "overlay": "string",
                "position": 0,
                "dissolve": 0,
                "minWidth": 0,
                "minHeight": 0
            },
            "html": {
                "enabled": true,
                "auto": true,
                "listPages": 0,
                "channel": "string",
                "article": "string",
                "enabledAndAuto": true
            },
            "messageBoard": {
                "enabled": true,
                "loginRequired": true
            },
            "editor": {
                "property1": {},
                "property2": {}
            },
            "copyFromId": 0,
            "copyData": [
                "string"
            ],
            "hasChildren": true,
            "parent": {},
            "org": {
                "id": 0,
                "parentId": 0,
                "name": "string",
                "phone": "string",
                "address": "string",
                "contacts": "string",
                "depth": 0,
                "order": 0,
                "hasChildren": true,
                "names": [
                    "string"
                ],
                "paths": [
                    {}
                ]
            },
            "model": {
                "id": 0,
                "siteId": 0,
                "name": "string",
                "type": "string",
                "scope": 0,
                "order": 0,
                "mains": "string",
                "asides": "string",
                "customs": "string"
            },
            "enabled": true,
            "url": "string",
            "filesPath": "string",
            "api": "string",
            "mobileStaticUrl": "string",
            "dynamicUrl": "string",
            "staticUrl": "string",
            "normalStaticUrl": "string",
            "dy": "string",
            "names": [
                "string"
            ],
            "template": "string",
            "staticBase": "string",
            "paths": [
                {}
            ],
            "disabled": true,
            "htmlEnabled": true,
            "title": "string",
            "targetBlank": true
        },
        "user": {
            "id": 0,
            "groupId": 0,
            "orgId": 0,
            "username": "string",
            "email": "string",
            "mobile": "string",
            "alias": "string",
            "nickname": "string",
            "realName": "string",
            "gender": 0,
            "avatar": "string",
            "passwordModified": "2019-08-24T14:15:22Z",
            "rank": 0,
            "type": 0,
            "status": 0,
            "group": {
                "id": 0,
                "name": "string",
                "description": "string",
                "allAccessPermission": true,
                "type": 0,
                "order": 0,
                "accessPermissions": [
                    0
                ]
            },
            "org": {
                "id": 0,
                "parentId": 0,
                "name": "string",
                "phone": "string",
                "address": "string",
                "contacts": "string",
                "depth": 0,
                "order": 0,
                "hasChildren": true,
                "names": [
                    "string"
                ],
                "paths": [
                    {}
                ]
            },
            "roleList": [
                {
                    "id": 0,
                    "siteId": 0,
                    "name": "string",
                    "description": "string",
                    "allPermission": true,
                    "allGrantPermission": true,
                    "globalPermission": true,
                    "allArticlePermission": true,
                    "allChannelPermission": true,
                    "dataScope": 0,
                    "allStatusPermission": true,
                    "rank": 0,
                    "type": 0,
                    "scope": 0,
                    "order": 0,
                    "permission": "string",
                    "grantPermission": "string",
                    "site": {
                        "id": 0,
                        "parentId": 0,
                        "orgId": 0,
                        "modelId": 0,
                        "name": "string",
                        "description": "string",
                        "protocol": "string",
                        "domain": "string",
                        "subDir": "string",
                        "theme": "string",
                        "mobileTheme": "string",
                        "pageSize": 0,
                        "logo": "string",
                        "seoTitle": "string",
                        "seoKeywords": "string",
                        "seoDescription": "string",
                        "staticFile": "string",
                        "mobileStaticFile": "string",
                        "editorSettings": "string",
                        "status": 0,
                        "depth": 0,
                        "order": 0,
                        "views": 0,
                        "selfViews": 0,
                        "todayViews": 0,
                        "yesterdayViews": 0,
                        "maxViews": 0,
                        "maxDate": "2019-08-24T14:15:22Z",
                        "mainsJson": "string",
                        "clobsJson": "string",
                        "customs": {
                            "property1": {},
                            "property2": {}
                        },
                        "watermark": {
                            "enabled": true,
                            "overlay": "string",
                            "position": 0,
                            "dissolve": 0,
                            "minWidth": 0,
                            "minHeight": 0
                        },
                        "html": {
                            "enabled": true,
                            "auto": true,
                            "listPages": 0,
                            "channel": "string",
                            "article": "string",
                            "enabledAndAuto": true
                        },
                        "messageBoard": {
                            "enabled": true,
                            "loginRequired": true
                        },
                        "editor": {
                            "property1": {},
                            "property2": {}
                        },
                        "copyFromId": 0,
                        "copyData": [
                            "string"
                        ],
                        "hasChildren": true,
                        "parent": {},
                        "org": {
                            "id": 0,
                            "parentId": 0,
                            "name": "string",
                            "phone": "string",
                            "address": "string",
                            "contacts": "string",
                            "depth": 0,
                            "order": 0,
                            "hasChildren": true,
                            "names": [
                                "string"
                            ],
                            "paths": [
                                {}
                            ]
                        },
                        "model": {
                            "id": 0,
                            "siteId": 0,
                            "name": "string",
                            "type": "string",
                            "scope": 0,
                            "order": 0,
                            "mains": "string",
                            "asides": "string",
                            "customs": "string"
                        },
                        "enabled": true,
                        "url": "string",
                        "filesPath": "string",
                        "api": "string",
                        "mobileStaticUrl": "string",
                        "dynamicUrl": "string",
                        "staticUrl": "string",
                        "normalStaticUrl": "string",
                        "dy": "string",
                        "names": [
                            "string"
                        ],
                        "template": "string",
                        "staticBase": "string",
                        "paths": [
                            {}
                        ],
                        "disabled": true,
                        "htmlEnabled": true,
                        "title": "string",
                        "targetBlank": true
                    },
                    "global": true
                }
            ],
            "orgList": [
                {
                    "id": 0,
                    "parentId": 0,
                    "name": "string",
                    "phone": "string",
                    "address": "string",
                    "contacts": "string",
                    "depth": 0,
                    "order": 0,
                    "hasChildren": true,
                    "names": [
                        "string"
                    ],
                    "paths": [
                        {}
                    ]
                }
            ],
            "name": "string",
            "location": "string",
            "created": "2019-08-24T14:15:22Z",
            "enabled": true,
            "root": true,
            "loginDate": "2019-08-24T14:15:22Z",
            "loginCount": 0,
            "loginIp": "string",
            "largeAvatar": "string",
            "mediumAvatar": "string",
            "birthday": "2019-08-24T14:15:22Z",
            "bio": "string",
            "homepage": "string",
            "smallAvatar": "string"
        },
        "replyUser": {
            "id": 0,
            "groupId": 0,
            "orgId": 0,
            "username": "string",
            "email": "string",
            "mobile": "string",
            "alias": "string",
            "nickname": "string",
            "realName": "string",
            "gender": 0,
            "avatar": "string",
            "passwordModified": "2019-08-24T14:15:22Z",
            "rank": 0,
            "type": 0,
            "status": 0,
            "group": {
                "id": 0,
                "name": "string",
                "description": "string",
                "allAccessPermission": true,
                "type": 0,
                "order": 0,
                "accessPermissions": [
                    0
                ]
            },
            "org": {
                "id": 0,
                "parentId": 0,
                "name": "string",
                "phone": "string",
                "address": "string",
                "contacts": "string",
                "depth": 0,
                "order": 0,
                "hasChildren": true,
                "names": [
                    "string"
                ],
                "paths": [
                    {}
                ]
            },
            "roleList": [
                {
                    "id": 0,
                    "siteId": 0,
                    "name": "string",
                    "description": "string",
                    "allPermission": true,
                    "allGrantPermission": true,
                    "globalPermission": true,
                    "allArticlePermission": true,
                    "allChannelPermission": true,
                    "dataScope": 0,
                    "allStatusPermission": true,
                    "rank": 0,
                    "type": 0,
                    "scope": 0,
                    "order": 0,
                    "permission": "string",
                    "grantPermission": "string",
                    "site": {
                        "id": 0,
                        "parentId": 0,
                        "orgId": 0,
                        "modelId": 0,
                        "name": "string",
                        "description": "string",
                        "protocol": "string",
                        "domain": "string",
                        "subDir": "string",
                        "theme": "string",
                        "mobileTheme": "string",
                        "pageSize": 0,
                        "logo": "string",
                        "seoTitle": "string",
                        "seoKeywords": "string",
                        "seoDescription": "string",
                        "staticFile": "string",
                        "mobileStaticFile": "string",
                        "editorSettings": "string",
                        "status": 0,
                        "depth": 0,
                        "order": 0,
                        "views": 0,
                        "selfViews": 0,
                        "todayViews": 0,
                        "yesterdayViews": 0,
                        "maxViews": 0,
                        "maxDate": "2019-08-24T14:15:22Z",
                        "mainsJson": "string",
                        "clobsJson": "string",
                        "customs": {
                            "property1": {},
                            "property2": {}
                        },
                        "watermark": {
                            "enabled": true,
                            "overlay": "string",
                            "position": 0,
                            "dissolve": 0,
                            "minWidth": 0,
                            "minHeight": 0
                        },
                        "html": {
                            "enabled": true,
                            "auto": true,
                            "listPages": 0,
                            "channel": "string",
                            "article": "string",
                            "enabledAndAuto": true
                        },
                        "messageBoard": {
                            "enabled": true,
                            "loginRequired": true
                        },
                        "editor": {
                            "property1": {},
                            "property2": {}
                        },
                        "copyFromId": 0,
                        "copyData": [
                            "string"
                        ],
                        "hasChildren": true,
                        "parent": {},
                        "org": {
                            "id": 0,
                            "parentId": 0,
                            "name": "string",
                            "phone": "string",
                            "address": "string",
                            "contacts": "string",
                            "depth": 0,
                            "order": 0,
                            "hasChildren": true,
                            "names": [
                                "string"
                            ],
                            "paths": [
                                {}
                            ]
                        },
                        "model": {
                            "id": 0,
                            "siteId": 0,
                            "name": "string",
                            "type": "string",
                            "scope": 0,
                            "order": 0,
                            "mains": "string",
                            "asides": "string",
                            "customs": "string"
                        },
                        "enabled": true,
                        "url": "string",
                        "filesPath": "string",
                        "api": "string",
                        "mobileStaticUrl": "string",
                        "dynamicUrl": "string",
                        "staticUrl": "string",
                        "normalStaticUrl": "string",
                        "dy": "string",
                        "names": [
                            "string"
                        ],
                        "template": "string",
                        "staticBase": "string",
                        "paths": [
                            {}
                        ],
                        "disabled": true,
                        "htmlEnabled": true,
                        "title": "string",
                        "targetBlank": true
                    },
                    "global": true
                }
            ],
            "orgList": [
                {
                    "id": 0,
                    "parentId": 0,
                    "name": "string",
                    "phone": "string",
                    "address": "string",
                    "contacts": "string",
                    "depth": 0,
                    "order": 0,
                    "hasChildren": true,
                    "names": [
                        "string"
                    ],
                    "paths": [
                        {}
                    ]
                }
            ],
            "name": "string",
            "location": "string",
            "created": "2019-08-24T14:15:22Z",
            "enabled": true,
            "root": true,
            "loginDate": "2019-08-24T14:15:22Z",
            "loginCount": 0,
            "loginIp": "string",
            "largeAvatar": "string",
            "mediumAvatar": "string",
            "birthday": "2019-08-24T14:15:22Z",
            "bio": "string",
            "homepage": "string",
            "smallAvatar": "string"
        }
    }
]
上一页
投票对象_Vote
下一页
留言分页_MessageBoardPage
Built with