Query Channel Types

POST/web/v1/notification-channel-types/query WEB

Queries notification channel types with optional filters. Returns a paginated result.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token

Request Parameters

Request Body

NotificationChannelTypeQueryRequest:

Name	Type	Required	In	Description
bizId	string	Optional	body	Filter by type business ID (max 64 characters)
typeCode	string	Optional	body	Filter by type code (max 32 characters, e.g., EMAIL)
typeStatus	string	Optional	body	Filter by status: ENABLED, DISABLED
enabledOnly	boolean	Optional	body	If true, return only enabled types

Query Parameters (Pagination)

Name	Type	Required	In	Description
page	integer	Optional	query	Page number (0-based)
size	integer	Optional	query	Page size
sort	string	Optional	query	Sort field and direction (e.g., displayOrder,asc)

Success Response

Success 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
  }
}

Error Responses

Code	Description
4010	Unauthorized (invalid or missing JWT token)
4030	Turnstile verification failed

Notes

• All filter fields are optional; omit them to retrieve all channel types.
• The response uses Spring Data Page format.