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

POST /communication/sms

向指定手机号码发送短信。支持模板发送(需预定义模板)或直接发送内容,自动记录到发送日志。参考:ePrivacy Directive 2002/58/EC、CAN-SPAM Act。

通信服务 `bearerAuth` application/json

Request Body

Schema: dto.SMSRequest

FieldTypeRequiredExampleConstraintsDescription
phone string Yes 13800138000 手机号
cancel_key string No order-123
content string No 您的验证码是123456 内容
send_at string No 2026-06-07T10:00:00Z
template string No verify_code 模板
user_id string No usr_abc123 用户ID
variables object No extra keys: `string` 变量

Responses

StatusDescriptionSchema
200发送成功,返回发送日志详情dto.CommunicationLogDetailResponse
400请求参数错误dto.SimpleResponse
401未认证或令牌无效dto.SimpleResponse
403无权访问该资源dto.SimpleResponse
404资源不存在dto.SimpleResponse
500服务内部错误dto.SimpleResponse

Referenced Schemas

dto.CommunicationLogDetailResponse

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

dto.CommunicationLogResponse

消息发送日志记录

FieldTypeRequiredExampleConstraintsDescription
channel string No sms
content string No 您的验证码是123456
created_at string No 2026-04-15T10:00:00Z
error string No 发送超时
id string No log_abc123
provider string No aliyun
recipient string No 138****8000
response string No
sent_at string No 2026-04-15T10:01:00Z
status string No delivered
template_id string No tpl_abc123
tenant_id string No tnt_xyz789
updated_at string No 2026-04-15T10:00:00Z
user_id string No usr_abc123

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No