Skip to content

内容

MODULE_NAMEMODULE_DESC入参返参路径
cms_article_list文章列表CmsArListParamsCmsArListRespcms/article/lists
cms_article_detail文章详情CmsArDetailParamsCmsArDetailRespcms/article/info
cms_channel_list栏目列表CmsChListParamsCmsChListRespcms/channel/lists
cms_channel_detail栏目详情CmsChDetailParamsCmsChDetailRespcms/channelapi/info

文章列表

CmsArListParams 类型

ts
interface CMS_AR_LIST_PARAMS {
  start: number; // 游标,0开始
  length: number; // 分页量,默认10
  channel_id: string; // 指定栏目,多个使用使用英文逗号拼接
  search_keywords: string; // 关键字搜索
  show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名参数描述类型是否必填
start游标,0 开始number
length分页量,默认 10number
channel_id指定栏目,多个使用使用英文逗号拼接string
search_keywords关键字搜索string
show_access是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据number

CmsArListResp 类型

ts
interface CMS_AR_LIST_RESP {
  access_limit: string; // string
  access_type: number;
  app_id: number;
  arc_from: string;
  attach: string; // JSON 格式的字符串
  attach_ext: string; // string
  audit_id: number;
  audit_state: number;
  author: string;
  back_img: string;
  channel_id: number;
  company_id: number;
  content: string; // URL 编码的 HTML 内容
  content_clear: number;
  content_mobile: string; // string
  cover: string;
  created_at: string; // 日期时间字符串
  desc: string;
  html_name: string; // string
  icon: string;
  id: number;
  operator_id: number;
  real_channel: string;
  real_template_channel: number;
  real_template_channel_diy: {
    id: number;
    alias: string;
    template_name: string;
  }; // 嵌套对象
  real_template_content: number;
  real_template_content_diy: any[]; // 未指定类型的数组,因此使用 any[]
  real_template_text: number;
  real_template_text_diy: {
    id: number;
    alias: string;
    template_name: string;
  }; // 嵌套对象
  real_template_type: number;
  release_time: string; // 日期时间字符串
  seo_description: string; // string
  seo_keywords: string; // string
  seo_name: string; // string
  show_access: number;
  sort: number;
  state: number;
  tag: string; // string
  tag_name: string;
  template_text: number;
  template_text_diy: any[]; // 未指定类型的数组,因此使用 any[]
  title: string;
  title_sub: string;
  type: string;
  updated_at: string; // 日期时间字符串
  view_num: number;
  is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
参数名参数描述类型默认参照值
title标题string"林更新新活动亮相"
title_sub副标题string""
is_access展示权限number在 show_access 非 0 时有效,1 为有权限 0 为无权限
type类型string"1"
attach附件链接array["https://...", "https://..."]
attach_ext附件扩展string""
access_limit访问限制string""
access_type访问类型number0
content内容string"%3Cp%20style%3D%22..."
icon图标string"https://..."
cover封面图片string"https://..."
idIDnumber24
content_clear清晰内容number0
content_mobile移动端内容string""
arc_from文章来源string""
audit_id审核 IDnumber0
audit_state审核状态number1
author作者string""
back_img背景图片string""
channel_id频道 IDnumber16
app_id应用 IDnumber270
company_id公司 IDnumber102
html_nameHTML 名称string""
created_at创建时间string"2024-04-23 10:05:08"
desc描述string""
operator_id操作员 IDnumber284
real_channel真实频道string"图集"
real_template_channel真实模板频道number118
real_template_channel_diy自定义模板频道object
real_template_content真实模板内容number0
real_template_content_diy自定义模板内容array[]
real_template_text真实模板文字number110
real_template_text_diy自定义模板文字object
real_template_type真实模板类型number3
release_time发布时间string"2024-04-26 11:35:19"
seo_descriptionSEO 描述string""
seo_keywordsSEO 关键词string""
seo_nameSEO 名称string""
show_access显示访问权限number0
sort排序number50
state状态number1
tag标签string""
tag_name标签名称string"新闻,热点,股票,股票 2,股票 1"
template_text模板文字number0
template_text_diy自定义模板文字array[]
updated_at更新时间string"2024-04-26 15:08:05"
view_num浏览次数number19

文章详情

CmsArDetailParams 类型

ts
interface CMS_AR_DETAIL_PARAMS {
  id: number; // id
  show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名参数描述类型是否必填
ididnumber
show_access是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据number

CmsArDetailResp 类型

ts
interface CMS_AR_DETAIL_RESP {
  alias: "pQwFBx7Cx9T6l6TIP";
  app_id: number;
  app_type: number;
  company_id: number;
  created_at: string;
  deleted_at: string;
  diy_app_id: number;
  id: number;
  ip: string;
  is_default: number;
  is_wechat: number;
  json: string;
  operator_id: number;
  order: number;
  router_id: number;
  router_name: string;
  router_url: string;
  state: number;
  template_id: number;
  title: string;
  updated_at: string;
  is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名说明数据类型示例值
title标题string"(勿动!)索尔维在中国市场应用"
jsonJSON 数据string""
template_id模板 IDnumber0
alias别名string"pQwFBx7Cx9T6l6TIP"
is_access展示权限number在 show_access 非 0 时有效,1 为有权限 0 为无权限
app_id应用 IDnumber261
idIDnumber792
order排序number50
router_id路由 IDnumber1
router_name路由名称string"DIY 公共页"
router_url路由 URLstring"/common/index/index"
state状态number1
app_type应用类型number0
company_id公司 IDnumber102
created_at创建时间string"2024-05-30 13:35:59"
deleted_at删除时间(null 表示未删除)string""
diy_app_idDIY 应用 IDnumber0
ipIP 地址string""
is_default默认设置标志number0
is_wechat微信标志number1
operator_id操作员 IDnumber262
updated_at更新时间string"2024-06-05 09:55:59"

栏目列表

CmsChListParams 类型

ts
interface CMS_CH_LIST_PARAMS {
  parent_id: number; // 上级类别id
  show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名参数描述类型是否必填
parent_id上级类别 idnumber
show_access是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据number

CmsChListResp 类型

ts
interface CMS_CH_LIST_RESP {
  app_id: number; // 示例值: 270
  article_count: number; // 示例值: 1
  back_img: string; // 示例值: ""
  company_id: number; // 示例值: 102
  content: string; // 示例值: ""
  content_mobile: string; // 示例值: ""
  cover: string; // 示例值: ""
  created_at: string; // 示例值: "2024-04-23 09:58:16"
  desc: string; // 示例值: ""
  directory: string; // 示例值: ""
  icon: string; // 示例值: ""
  id: number; // 示例值: 14
  is_parent: number; // 示例值: 0
  name: string; // 示例值: "单页"
  name_alias: string; // 示例值: ""
  operator_id: number; // 示例值: 284
  parent_id: number; // 示例值: 0
  real_parent: string; // 示例值: string
  real_top: string; // 示例值: string
  seo_description: string; // 示例值: ""
  seo_keywords: string; // 示例值: ""
  seo_name: string; // 示例值: ""
  show_access: number; // 示例值: 0
  show_hide: number; // 示例值: 0
  sort: number; // 示例值: 50
  state: number; // 示例值: 1
  sub_title: string; // 示例值: ""
  sync_sub: number; // 示例值: 0
  template_channel: number; // 示例值: 6
  template_channel_diy: any[]; // 示例值: []
  template_content: number; // 示例值: 0
  template_content_diy: any[]; // 示例值: []
  template_text: number; // 示例值: 0
  template_text_diy: any[]; // 示例值: []
  template_type: number; // 示例值: 1
  title: string; // 示例值: "单页"
  top_id: number; // 示例值: 0
  type: number; // 示例值: 1
  type_show: number; // 示例值: 2
  updated_at: string; // 示例值: "2024-05-14 09:28:36"
  url_link: string; // 示例值: ""
  url_type: number; // 示例值: 0
  view_num: number; // 示例值: 65
  is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名说明数据类型示例值
title标题string"单页"
is_access展示权限number在 show_access 非 0 时有效,1 为有权限 0 为无权限
top_id顶级 IDnumber0
app_id应用 IDnumber270
article_count文章数量number1
back_img背景图片string""
company_id公司 IDnumber102
content内容string""
content_mobile移动端内容string""
cover封面图片 URLstring""
url_link链接 URLstring""
url_type链接类型number0
view_num查看次数number65
sort排序number50
state状态number1
sub_title副标题string""
sync_sub同步子级number0
template_channel模板频道number6
template_channel_diy自定义模板频道array[]
template_content模板内容number0
template_content_diy自定义模板内容array[]
template_text模板文本number0
template_text_diy自定义模板文本array[]
template_type模板类型number1
created_at创建时间string"2024-04-23 09:58:16"
desc描述string""
directory目录string""
icon图标 URLstring""
idIDnumber14
is_parent是否为父级number0
name名称string"单页"
name_alias名称别名string""
operator_id操作员 IDnumber284
parent_id父级 IDnumber0
real_parent实际父级string""
real_top实际顶级string""
seo_descriptionSEO 描述string""
seo_keywordsSEO 关键词string""
seo_nameSEO 名称string""
show_access显示访问权限number0
show_hide显示隐藏状态number0
type类型number1
type_show显示类型number2
updated_at更新时间string"2024-05-14 09:28:36"

栏目详情

CmsChDetailParams 类型

ts
interface CMS_CH_DETAIL_PARAMS {
  id: number; // id
  show_access: number; // 是否显示权限 0不校验 1展示是否有权限 2只展示有权限数据
}
参数名参数描述类型是否必填
ididnumber
show_access是否显示权限 0 不校验 1 展示是否有权限 2 只展示有权限数据number

CmsChDetailResp 类型

ts
interface CMS_CH_DETAIL_RESP {
  id: number; // 示例值: 123
  name: string; // 示例值: "栏目名称"
  sort: number; // 示例值: 1
  state: number; // 示例值: 1 (开启), 0 (关闭)
  operator_id: number; // 示例值: 456
  created_at: string; // 示例值: "2024-06-20 10:00:00"
  updated_at: string; // 示例值: "2024-06-20 10:30:00"
  top_id: number; // 示例值: 0
  parent_id: number; // 示例值: 0
  is_parent: number; // 示例值: 0 (否), 1 (是)
  name_alias: string; // 示例值: "english_alias"
  directory: string; // 示例值: "directory_name"
  template_content: number; // 示例值: 1
  template_channel: number; // 示例值: 2
  template_text: number; // 示例值: 3
  show_hide: number; // 示例值: 0
  show_access: number; // 示例值: 0 (开放浏览), 1 (禁止浏览)
  type: number; // 示例值: 1 (内部栏目), 2 (外部链接)
  url_link: string; // 示例值: "http://example.com"
  url_type: number; // 示例值: 0, 1, 2
  cover: string; // 示例值: "cover_image_url"
  seo_name: string; // 示例值: "SEO标题"
  seo_keywords: string; // 示例值: "SEO关键词"
  seo_description: string; // 示例值: "SEO描述"
  article_count: number | string; // 示例值: 10 或 string
  sync_sub: number; // 示例值: 0
  view_num: number; // 示例值: 100
  type_show: number; // 示例值: 1, 2, 3
  is_access: number; // 在show_access非0时有效,1为有权限0为无权限
}
属性名说明数据类型示例值
idIDnumber123
name栏目名称string"栏目名称"
is_access展示权限number在 show_access 非 0 时有效,1 为有权限 0 为无权限
type_show栏目类型 1 文本 2 列表 3 单页number1
sort排序number1
state状态 (1: 开启, 0: 关闭)number1
top_id顶级 IDnumber0
parent_id父级 IDnumber0
is_parent是否为父级 (0: 否, 1: 是)number0
directory目录名称string"directory_name"
template_content内容模板number1
template_channel频道模板number2
template_text文本模板number3
show_hide显示隐藏状态number0
show_access访问权限 0 开放浏览 1 禁止浏览number0
type类型 (1: 内部栏目, 2: 外部链接)number1
url_link链接地址string"http://example.com"
url_type链接属性 0 无 1 新窗口打卡 2nofollownumber0
cover封面图片 URLstring"cover_image_url"
seo_nameSEO 标题string"SEO 标题"
seo_keywordsSEO 关键词string"SEO 关键词"
seo_descriptionSEO 描述string"SEO 描述"
article_count文章数量number1
sync_sub子栏目同步number0
view_num浏览次数number100
operator_id操作员 IDnumber456
created_at创建时间string"2024-06-20 10:00:00"
updated_at更新时间string"2024-06-20 10:30:00"
name_alias英文别名string"english_alias"