POST/sms/querySmsConfigPage管理后台

短信配置-分页查询

营销与触达 / 短信·配置· SmsConfigController#querySmsConfigPage

基本信息

  • 接口状态前端在用 置信度 高
  • 接口URLPOSThttps://dscp-dev.hn12301.net/manage-api/sms/querySmsConfigPage
  • 请求方式POST
  • Content-Typeapplication/json
  • 暴露渠道管理后台 前缀 /manage-api
  • 名称来源源码注释
  • 调用方已确认在用 · 管理后台(1 个前端)
  • 需求上下文短信配置、记录基础功能
  • 维护人 / 最后改动liuxu 2025-05-21 最近提交:短信配置、记录基础功能
  • 读写数据表sms_config 反查该表全部接口 →
  • 控制器com.jxxx.dscp.api.controller.sms.SmsConfigController#querySmsConfigPage
  • 源码位置jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/sms/SmsConfigController.java:48
  • 判定依据1 个调用点:dscp-html-manage/src/api/sms/index.ts

请求参数

分页字段来自 AbstractPageRequest:pageNo(不是 pageNum)· pageSize · orderBy

Header 请求参数

参数名参数值是否必填参数类型描述说明
无(渠道统一鉴权头见《认证方式》)

Query 请求参数

参数名参数值是否必填参数类型描述说明
无

路径参数及说明

参数名参数值是否必填参数类型描述说明
无

Body 请求参数

Body 类型 SmsConfigPageRequest
参数名参数值是否必填参数类型描述说明
pageNo…否Integer当前页面
pageSize…否Integer每页记录数
orderBy…否String排序语句
keywords…否String关键字
type…否Integer → sms_config.type
status…否Integer开启状态 → sms_config.status
code…否String编码 → sms_config.code
name…否String名称 → sms_config.name
content…否String配置内容 → sms_config.content
params…否String参数数组 → sms_config.params
remark…否String备注 → sms_config.remark
channelCode…否String短信渠道(阿里腾讯) → sms_config.channel_code
apiKey…否String短信 API 的账号 → sms_config.api_key
apiSecret…否String短信 API 的秘钥 → sms_config.api_secret
callbackUrl…否String短信发送回调 URL → sms_config.callback_url

认证方式

需登录态:Authorization: Bearer <token>(多租户另带 tenant-id);30002 会话失效需重登。详见全局公共参数。

响应参数

data 类型 PageInfo<SmsConfigResponse>
参数名参数值是否必填参数类型描述说明
list…否List<T><SmsConfigResponse>分页数据集合(元素结构见下一行)
id…否Longid → sms_config.id
type…否Integer → sms_config.type
status…否Integer开启状态 → sms_config.status
code…否String编码 → sms_config.code
name…否String名称 → sms_config.name
content…否String配置内容 → sms_config.content
params…否String参数数组 → sms_config.params
remark…否String备注 → sms_config.remark
channelCode…否String短信渠道(阿里腾讯) → sms_config.channel_code
apiKey…否String短信 API 的账号 → sms_config.api_key
apiSecret…否String短信 API 的秘钥 → sms_config.api_secret
callbackUrl…否String短信发送回调 URL → sms_config.callback_url
creator…否String创建者 → sms_config.creator
createTime…否Date创建时间 → sms_config.create_time
updater…否String更新者 → sms_config.updater
updateTime…否Date更新时间 → sms_config.update_time
deleted…否Boolean是否删除 → sms_config.deleted
total…否Long数据总数

响应示例

成功响应示例 code=0

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "list": "[]",
    "id": "1",
    "type": "1",
    "status": "1",
    "code": "\"string\"",
    "name": "\"string\"",
    "content": "\"string\"",
    "params": "\"string\"",
    "remark": "\"string\"",
    "channelCode": "\"string\"",
    "apiKey": "\"string\"",
    "apiSecret": "\"string\""
  }
}
示例来自源码/导出内容,仅结构参考,非线上真实数据。

附录 · 实现细节

调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
涉及数据表:sms_config 反查全部引用接口 →
  • SmsConfigController#querySmsConfigPage
  • SmsConfigService#queryPage(SmsConfigServiceImpl)
  • SmsConfigMapper#queryPage
  • BeanUtils.map → SmsConfigQuery
  • BeanUtils.mapPage → SmsConfigResponse
逻辑摘要:分页查询(smsConfigService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
源码内联注释(旧站解析结果)
  • 设置其他查询条件
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
  • dscp-html-manage/src/api/sms/index.ts:6 管理后台 · request
由 tools/build.py 从 data/apis.json 生成 · 生成时间 2026-09-12 19:49 · 数据口径见说明 · 本页数字非手写,均来自同一份数据