SMSFAST

加载中…

短信API

API概览

SMSFast API 采用行业标准的 RESTful 架构设计,让开发者能够轻松集成和管理虚拟号码资源。

RESTful 设计

标准的HTTP方法(GET、POST、DELETE),统一的资源端点,直观的URL结构。

JSON 格式

所有请求和响应均使用 JSON 格式,结构清晰,易于解析和处理。

API Key 认证

通过 HTTP Header 中的 Bearer Token 进行身份验证,安全可靠。

速率限制

每个 API Key 每分钟最多 60 次请求,确保服务的公平使用和稳定性。

核心接口

以下是 SMSFast API 的主要端点,涵盖号码管理、短信接收和账户查询功能。

POST

/v1/numbers

获取虚拟号码

根据指定的国家代码和服务类型,申请一个新的虚拟号码用于接收短信。请求体中包含国家代码 (country) 和服务标识 (service)。

GET

/v1/numbers/{id}/messages

获取短信列表

查询指定号码收到的所有短信记录,包含发送者、内容、时间戳等详细信息。

DELETE

/v1/numbers/{id}

释放号码

释放不再使用的虚拟号码资源,停止计费并归还号码池。

GET

/v1/account/balance

查询余额

获取当前账户的余额信息,方便您管理和监控使用情况。

代码示例

以下是使用 cURL 调用 SMSFast API 的典型示例,帮助您快速上手集成。

获取虚拟号码

curl -X POST https://api.smsfast.com/v1/numbers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "US",
    "service": "telegram"
  }'

# 响应示例
{
  "id": "num_abc123",
  "number": "+12025551234",
  "country": "US",
  "service": "telegram",
  "created_at": "2024-01-15T08:30:00Z",
  "expires_at": "2024-01-15T08:45:00Z"
}

获取短信消息

curl -X GET https://api.smsfast.com/v1/numbers/num_abc123/messages \
  -H "Authorization: Bearer YOUR_API_KEY"

# 响应示例
{
  "messages": [
    {
      "id": "msg_xyz789",
      "sender": "Telegram",
      "content": "您的验证码是 583921",
      "received_at": "2024-01-15T08:31:05Z"
    }
  ]
}

SDK 支持

SMSFast 提供多种主流编程语言的 SDK,降低集成门槛,加速您的开发流程。

Python

pip install smsfast

Node.js

npm install smsfast

PHP

composer require smsfast

Java

Maven / Gradle

Go

go get smsfast

常见问题

关于短信API的常见疑问,请查看以下解答,或查阅完整文档获取更多信息。

SMSFast API 采用 Bearer Token 认证方式。你需要在控制面板中生成 API Key,然后在每次请求的 HTTP Header 中携带 Authorization: Bearer YOUR_API_KEY 即可完成认证。API Key 具有账户级别的权限,请妥善保管,不要在客户端代码中暴露。如怀疑 Key 泄露,你可以在控制面板中随时重新生成。

有。每个 API Key 每分钟最多可发起 60次请求,这是为了确保服务的公平使用和整体稳定性。超过频率限制时,API 会返回 429 Too Many Requests 状态码。如果你有更高的请求频率需求,可以在请求中使用合理的时间间隔控制,或者升级到企业版套餐获得更高的速率限制。详情可查阅价格方案或联系客服。

SMSFast 目前提供 Python、Node.js、PHP、Java 和 Go 五种主流编程语言的官方 SDK。每种 SDK 封装了完整的 API 调用逻辑,包含请求签名、错误处理和响应解析。如果你使用的语言不在官方支持范围内,可以直接调用 RESTful API,我们提供详细的 cURL 和 HTTP 请求示例帮助你快速开始。完整文档请查看API文档

API 错误信息通过 HTTP 状态码和 JSON 响应体两部分返回。常见状态码包括:400(请求参数错误)、401(认证失败)、404(资源不存在)、429(请求频率超限)和 500(服务器内部错误)。每个错误响应都包含 error 字段描述具体错误原因,以及 code 字段提供可程序化处理的状态码。建议在代码中对这些错误进行分类处理,并实现合理的重试逻辑。

Webhook 推送的优点是实时性强,新短信到达后系统立即向你的服务器推送,无需频繁查询;缺点是需要你有一个可公开访问的服务器来接收回调。轮询方式的优点是不依赖公网服务器,实现简单,适合本地开发和测试;缺点是存在延迟,且频繁调用会消耗API请求配额。建议在生产环境中使用 Webhook,在开发调试阶段使用轮询,两者可根据实际场景灵活组合。

了解更多

结合以下资源,快速完成 SMSFast API 的集成和部署。

查看完整接口文档

查阅所有API端点的详细说明,包括请求参数、响应格式和错误码对照表。

了解号码获取流程

学习如何通过控制面板或API获取来自180+国家和地区的虚拟号码。

更多使用教程

浏览帮助中心的详细教程和常见使用场景的操作指南。

开始使用 SMSFast API

查阅完整的 API 文档,了解所有端点、参数和错误码的详细说明。