Autional Autional
API Reference GitHub autional.com →

GET /communication/health/{channel}

Check the provider configuration and connectivity status of a specified communication channel (sms/email/push). Used for operational monitoring to verify if the provider API endpoint is reachable and configuration is valid. Public endpoint, no authentication required. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service None application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
channel path string Yes Communication channel: sms/email/push

Responses

StatusDescriptionSchema
200Check successful, returns channel health status (healthy/unhealthy/not_configured)dto.ChannelHealthDataResponse
400Invalid channel parameterdto.SimpleResponse
500Health check internal errordto.SimpleResponse

Referenced Schemas

dto.ChannelHealthDataResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.ChannelHealthResponse No
message string No
timestamp string No

dto.ChannelHealthResponse

Channel connectivity check result

FieldTypeRequiredExampleConstraintsDescription
channel string No sms
message string No SMS provider is reachable
provider string No aliyun
status string No healthy

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No