API 通用说明
本文档介绍泛玩短信 API 的通用规范,适用于所有 API 接口。
API 地址
所有 API 请求均发送至以下基础地址:
text
https://api.fanwan.com/?action=sms.send&accessKeyId=YOUR_ACCESS_KEY其中 action 参数指定要调用的接口名称,accessKeyId 为您的 API 密钥。
鉴权方式
使用 AccessKey 进行身份验证。每个请求必须在查询参数中附带 accessKeyId:
- accessKeyId — 在控制台「账户设置」中生成
- 将
accessKeyId作为 URL 查询参数传递 - 请妥善保管您的 AccessKey,避免泄露
请求格式
所有 API 请求均使用 POST 方法,请求体为 JSON 格式:
- 方法:
POST - Content-Type:
application/json - 字符编码:UTF-8
响应格式
所有 API 响应均为 JSON 格式,包含以下统一字段:
| 字段 | 类型 | 说明 |
|---|---|---|
code | string | 业务状态码,0 表示成功,非零表示错误 |
message | string | 状态描述信息 |
data | object | 响应数据,成功时返回具体业务数据 |
频率限制
为防止滥用,API 接口设有频率限制:
- 默认限制:100 QPS(每秒请求数)
- 超出限制将返回
10011 RateLimitExceeded错误 - 如需提升 QPS 上限,请联系商务或提交工单申请
短信长度规则
短信内容的计费规则如下:
| 内容长度 | 计费条数 | 说明 |
|---|---|---|
| ≤ 70 个字符 | 1 条 | 单条短信 |
| > 70 个字符 | 按每 67 字符拆分为多条 | 长短信拆分计费 |
注意:字符计数采用 UTF-8 编码,中文字符算作一个字符。超过 70 个字符时,每条拆分短信最多包含 67 个字符,不足 67 字符按一条计费。
