POST /communication/sms
向指定手机号码发送短信。支持模板发送(需预定义模板)或直接发送内容,自动记录到发送日志。参考:ePrivacy Directive 2002/58/EC、CAN-SPAM Act。
通信服务 `bearerAuth` application/json
Request Body
Schema: dto.SMSRequest
| Field | Type | Required | Example | Constraints | Description |
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` |
变量 |
Referenced Schemas
dto.CommunicationLogDetailResponse
dto.CommunicationLogResponse
消息发送日志记录
| Field | Type | Required | Example | Constraints | Description |
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
| Field | Type | Required | Example | Constraints | Description |
code |
integer |
No |
|
|
|
message |
string |
No |
|
|
|
timestamp |
string |
No |
|
|
|