Skip to content

POST Query Channels endpoint.

Endpoint

POST/web/v1/system/notifications/channels/query WEB

Authentication

  • Chain: WEB
  • JWT Token: true
  • API Key: false
  • Permissions: ["platform:notification:read"]

Rate Limit

Standard rate limit applies.

Headers

Frontend Headers

HeaderRequiredDescription
X-LOCALEYes用户的 locale
Accept-LanguageNo语言偏好

Cloudflare Headers

HeaderRequiredDescription
CF-Connecting-IPYesClient IP from Cloudflare
CF-IPCountryYesClient country code
CF-RayYesCloudflare Ray ID
CF-VisitorYesVisitor scheme
CF-WorkerNoCloudflare Worker indicator
CF-TCP-PortNoClient TCP port
CF-Edge-Keep-AliveNoEdge keep-alive status
CF-Cache-StatusNoCache status
CDN-LoopNoCDN loop detection
X-Real-IPYesReal client IP

Nginx Headers

HeaderRequiredDescription
X-PORTAL-ACCESS-CODEYesPortal access code
X-Real-IPYes客户端真实 IP
X-Forwarded-ForYes代理链
X-Forwarded-ProtoYes协议

Request Parameters

Body (JSON)

FieldTypeRequiredDescription
bizIdStringNo渠道业务ID (可选)
institutionBizIdStringNo门户业务ID (可选)
channelNameStringNo渠道名称 (可选)
channelCategoryNotificationChannelTypeNo渠道类别 (可选)
channelStatusNotificationChannelStatusNo渠道状态 (可选)
activeOnlyBooleanNo是否仅返回活跃渠道 (可选)

Response

200 OK

FieldTypeDescription
dataMapResponse data (structure varies)

Phase 3 Simulation

SlaunchX Internal Documentation