📡 API基础信息

接口域名

https://api.ffsms.com

协议类型

HTTP/HTTPS (推荐HTTPS)

字符编码

UTF-8

响应格式

JSON

🔑 认证方式

所有API请求需要在请求头中携带API密钥进行认证。

# 请求头示例
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

提示:API密钥可在后台管理系统中获取,请勿泄露给他人。

📤 发送短信接口

POST /api/v1/sms/send

请求参数

参数名类型必填说明
mobilestring手机号码,支持单个或多个(用逗号分隔)
contentstring短信内容,需包含签名(如【XX平台】)
signstring短信签名,如不传则使用默认签名
template_idstring模板ID,使用模板发送时必填
varsobject模板变量,JSON格式
callback_urlstring状态回调URL

请求示例

POST https://api.ffsms.com/api/v1/sms/send
# 请求体
{
  "mobile": "13800138000,13900139000",
  "content": "【FFSMS】您的验证码是123456,5分钟内有效",
  "callback_url": "https://yourdomain.com/callback"
}

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "20240101120000001",
    "count": 2,
    "fee": 0.006
  }
}

📊 查询发送状态接口

GET /api/v1/sms/status

请求参数

参数名类型必填说明
task_idstring发送任务ID
mobilestring手机号码,查询单个号码状态

请求示例

GET https://api.ffsms.com/api/v1/sms/status?task_id=20240101120000001

响应示例

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "mobile": "13800138000",
      "status": "success",
      "send_time": "2024-01-01 12:00:00",
      "report_time": "2024-01-01 12:00:03"
    }
  ]
}

💰 查询余额接口

GET /api/v1/account/balance

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "balance": 9999.99,
    "free_count": 10000
  }
}

📝 错误码说明

错误码说明解决方案
0成功请求处理成功
1001API密钥错误检查API密钥是否正确
1002余额不足请充值后再发送
1003手机号码格式错误检查手机号码格式
1004短信内容过长短信内容不能超过500字
1005签名未审核请先提交签名审核
1006频率限制发送频率超过限制,请稍后再试

💡 API使用小贴士

  • 使用HTTPS协议确保数据传输安全
  • 批量发送建议单次不超过1000条
  • 设置合理的回调URL获取发送状态
  • 验证码短信建议设置有效期
  • 营销短信需符合运营商规范
💬