Skip to content

Query Channel Types

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

Queries 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:

NameTypeRequiredInDescription
bizIdstringNobodyFilter by type business ID (max 64 characters)
typeCodestringNobodyFilter by type code (max 32 characters, e.g., EMAIL)
typeStatusstringNobodyFilter by status: ENABLED, DISABLED
enabledOnlybooleanNobodyIf true, return only enabled types

Query Parameters (Pagination)

NameTypeRequiredInDescription
pageintegerNoqueryPage number (0-based)
sizeintegerNoqueryPage size
sortstringNoquerySort 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

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

Notes

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

Internal Documentation