Query Channel Types
POST
/web/v1/notification-channel-types/queryWEBQueries notification channel types with optional filters. Returns a paginated result.
Authentication
Requires a valid JWT token and Turnstile verification. Gateway validation: enableJwtToken=true, enableTurnstile=true.
Request Parameters
Request Body
NotificationChannelTypeQueryRequest:
| Name | Type | Required | In | Description |
|---|---|---|---|---|
bizId | string | No | body | Filter by type business ID (max 64 characters) |
typeCode | string | No | body | Filter by type code (max 32 characters, e.g., EMAIL) |
typeStatus | string | No | body | Filter by status: ENABLED, DISABLED |
enabledOnly | boolean | No | body | If true, return only enabled types |
Query Parameters (Pagination)
| Name | Type | Required | In | Description |
|---|---|---|---|---|
page | integer | No | query | Page number (0-based) |
size | integer | No | query | Page size |
sort | string | No | query | Sort field and direction (e.g., displayOrder,asc) |
Success Response
Success200
{
"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
Pageformat.