guke
a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
27 lines
797 B
Markdown
27 lines
797 B
Markdown
# POST /api/v1/auth/sms/send — 发送短信验证码
|
||
|
||
> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](../README.md)
|
||
>
|
||
> 集成实现:见 [integrations/sms](../integrations/sms.md)（mock 模式、频控、接真供应商 TODO）。
|
||
|
||
## 入参
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
|---|---|---|---|
|
||
| `phone` | string | ✅ | 手机号,正则 `^1\d{10}$` |
|
||
|
||
## 出参
|
||
响应 `200`:
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|---|---|---|
|
||
| `sent` | bool | 是否已发送 |
|
||
| `mock` | bool | 是否 mock 模式（true 时不真发,任意 6 位通过） |
|
||
| `cooldown_sec` | int | 多少秒后才能再次发送 |
|
||
|
||
## 错误码
|
||
- `429` 发送过频（默认 60s 冷却内重复发）
|
||
|
||
## 说明
|
||
mock 模式（`SMS_MOCK=true`）下不真发短信,仅记录冷却时间。
|