CashGit OTP API 对接指南
域名: https://sms.cashgit.com/api
鉴权: 请求头 X-API-Key: <你的API密钥>(必须携带)
手机号规范: 支持 +91xxxxxxxxxx / 91xxxxxxxxxx / 10位本地号,后端会统一标
准化为 +91…
接口一览(共 3 个)
– 发送 OTP:创建并下发验证码
– 验证 OTP:校验收到的验证码
– 重发 OTP:在上一条过期或冷却后再次发送
———
1) 发送 OTP
请求:POST /otp/send
参数:
– mobile(必填):含国家码手机号
– app_id(必填):后台创建的 OTP 应用 ID
示例:
{
“mobile”: “+918699583803”,
“app_id”: “your-otp-app-id”
}
响应示例:
{
“success”: true,
“data”: {
“otp_id”: “xxx”,
“mobile”: “+9186xxxx”,
“expires_at”: “2025-11-27T13:10:00.000Z”,
“validity_seconds”: 300,
“session_id”: “2factor-session-id-if-any”
},
“message”: “OTP发送成功”
}
———
2) 验证 OTP
请求:POST /otp/verify
参数:
– mobile(必填)
– otp(必填)
– app_id(必填)
示例:
{
“mobile”: “+918699583803”,
“otp”: “123456”,
“app_id”: “your-otp-app-id”
}
响应示例:
{
“success”: true,
“data”: {
“otp_id”: “xxx”,
“mobile”: “+9186xxxx”,
“verified_at”: “2025-11-27T13:06:12.000Z”
},
“message”: “OTP验证成功”
}
———
3) 重发 OTP
请求:POST /otp/resend
参数:
– mobile(必填)
– app_id(必填)
示例:
{
“mobile”: “+918699583803”,
“app_id”: “your-otp-app-id”
}
响应示例:
{
“success”: true,
“data”: {
“otp_id”: “xxx”,
“mobile”: “+9186xxxx”,
“expires_at”: “2025-11-27T13:15:00.000Z”,
“validity_seconds”: 300,
“session_id”: “new-session-id-if-2factor”,
“invalidated_otp_id”: “old-otp-id”
},
“message”: “旧OTP已失效,已发送新OTP”
}
———
通用错误
– 400:参数缺失/手机号格式错误/验证码错误
– 401:X-API-Key 错误
– 402:余额不足
– 429:频率限制
– 500:服务器错误