发送短信 API
调用本接口发送短信,支持单发和群发,以及模板短信和自定义内容短信。
接口地址
text
POST https://api.fanwan.com/?action=sms.send&accessKeyId=YOUR_ACCESS_KEY请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
to | string | string[] | 是 | 接收手机号。单发传字符串,群发传字符串数组,需包含国家码(如 +86) |
signature | string | 是 | 短信签名,2-16 个字符,需在控制台审核通过 |
content | string | 否 | 自定义短信内容。与 templateId 二选一,优先级高于模板 |
templateId | string | 否 | 短信模板 ID。使用模板发送时必填 |
templateData | JSON | 否 | 模板变量数据,键值对格式,替换模板中的占位符 |
注意:
content 和 templateId 至少需要提供一个。同时提供时 content 优先,即使用自定义内容发送,忽略 templateId。响应参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | string | 业务状态码,0 表示成功 |
message | string | 状态描述信息 |
data.recipients | int | 收信人数 |
data.messageCount | int | 发送总条数(计费条数) |
data.messages | array | 发送详情列表 |
data.messages[].id | string | 消息唯一 ID |
data.messages[].to | string | 目标手机号 |
data.messages[].status | string | 发送状态(sent:已提交 / failed:失败) |
data.messages[].price | decimal | 本条短信费用 |
成功响应示例
json
{
"code": "0",
"message": "Success",
"data": {
"recipients": 2,
"messageCount": 2,
"messages": [
{
"id": "msg_abc123",
"to": "+8613800138000",
"status": "sent",
"price": 0.045
},
{
"id": "msg_abc124",
"to": "+8613900139000",
"status": "sent",
"price": 0.045
}
]
}
}错误响应示例
json
{
"code": "10001",
"message": "InvalidAccessKeyId",
"data": null
}cURL 示例
使用模板发送:
bash
curl -X POST 'https://api.fanwan.com/?action=sms.send&accessKeyId=YOUR_ACCESS_KEY' \
-H 'Content-Type: application/json' \
-d '{
"to": "+8613800138000",
"signature": "泛玩短信",
"templateId": "verify_code",
"templateData": {
"code": "123456",
"minute": "5"
}
}'使用自定义内容发送(content 优先级高于 templateId):
bash
curl -X POST 'https://api.fanwan.com/?action=sms.send&accessKeyId=YOUR_ACCESS_KEY' \
-H 'Content-Type: application/json' \
-d '{
"to": "+8613800138000",
"signature": "泛玩短信",
"content": "您的验证码是 123456,5 分钟内有效。"
}'