Skip to content

查询渠道类型

POST/web/v1/notification-channel-types/queryWEB

使用可选筛选条件查询通知渠道类型。返回分页结果。

鉴权

需要有效的 JWT token 和 Turnstile 验证。Gateway 校验:enableJwtToken=true, enableTurnstile=true

请求参数

请求体

NotificationChannelTypeQueryRequest:

NameTypeRequiredInDescription
bizIdstringNobody按类型业务 ID 筛选(最长 64 字符)
typeCodestringNobody按类型代码筛选(最长 32 字符,例如 EMAIL)
typeStatusstringNobody按状态筛选:ENABLED, DISABLED
enabledOnlybooleanNobody如果为 true,仅返回已启用的类型

查询参数(分页)

NameTypeRequiredInDescription
pageintegerNoquery页码(从 0 开始)
sizeintegerNoquery每页大小
sortstringNoquery排序字段和方向(例如 displayOrder,asc)

成功响应

成功200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "content": [
      {
        "bizId": "ct_abc123",
        "typeCode": "EMAIL",
        "typeValue": 80010101,
        "typeName": "Email Notification",
        "typeDescription": "Standard email delivery",
        "typeStatus": "ENABLED",
        "displayOrder": 0,
        "iconUrl": null,
        "extraConfig": null,
        "createdAt": "2026-03-21T00:00:00Z",
        "updatedAt": "2026-03-21T00:00:00Z"
      }
    ],
    "totalElements": 1,
    "totalPages": 1,
    "number": 0,
    "size": 20
  }
}

错误响应

错误码描述
4010未授权(JWT token 无效或缺失)
4030Turnstile 验证失败

说明

  • 所有筛选字段均为可选;省略时将返回所有渠道类型。
  • 响应使用 Spring Data Page 格式。

内部文档