Docs › API Reference › Communication Service › POST /communication/sms
POST /communication/sms
Send an SMS to a specified phone number. Supports template sending (predefined template) or direct content sending, automatically records in send logs. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.
Communication Service `bearerAuth` application/json
Request Body
Schema: dto.SMSRequest
Field Type Required Example Constraints Description
phone
string
Yes
13800138000
Phone number
cancel_key
string
No
order-123
content
string
No
Your verification code is 123456.
Content
send_at
string
No
2026-06-07T10:00:00Z
template
string
No
verify_code
Template
user_id
string
No
usr_abc123
User ID
variables
object
No
extra keys: `string`
Variables
Referenced Schemas
dto.CommunicationLogDetailResponse
dto.CommunicationLogResponse
Message send log record
Field Type Required Example Constraints Description
channel
string
No
sms
content
string
No
Your verification code is 123456
created_at
string
No
2026-04-15T10:00:00Z
error
string
No
Send timeout
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