A AuthMS API Wiki API Reference iam.tianv.com →

GET /communication/health/{channel}

检查指定通信渠道(sms/email/push)的服务商配置和连通性状态。用于运维监控,验证服务商API端点是否可达、配置是否有效。公开端点,无需认证。参考:ePrivacy Directive 2002/58/EC、CAN-SPAM Act。

通信服务 None application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
channel path string Yes 通信渠道:sms/email/push

Responses

StatusDescriptionSchema
200检查成功,返回渠道健康状态(healthy/unhealthy/not_configured)dto.ChannelHealthDataResponse
400渠道参数无效dto.SimpleResponse
500健康检查内部错误dto.SimpleResponse

Referenced Schemas

dto.ChannelHealthDataResponse

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

dto.ChannelHealthResponse

渠道连通性检查结果

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