/data/send_sms
1.接口描述
该API的功能是发送行业短信。
请求方式：
POST
请求URL：
https://cloudapi.deepfinch.com/data/send_sms
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息，详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息，详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| phone_number | string | 是 | 要发送的手机号码 |
| template_id | string | 是 | 模版ID（联系管理人员申请添加） |
| content | string | 是 | 模板中变量名与参数值，多项值以","分隔。例如: code:1234,expire_at:5 |
- 测试模版ID: TPL_0000, 测试content: code:1234
【Deepfinch】您的验证码是：#code#，有效期5分钟。- 短信字数不能超过70字符，标点、数字、英文字母都算一个字符。
- 使用前需要先联系客服创建模版，获取模版ID，发送短信
- 短信内容不能包含特殊字符及违反法律要求的内容
3.返回参数
正常响应 （200）
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 本次请求的 id |
| status | string | 状态。正常为 OK ，其他值表示失败。详见错误码 |
输出示例：
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK"
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
512 |
SOURCE_SERVICE_UNAVALIABLE | 短信通道暂不可用 |
输出示例：
{
"status": "INVALID_ARGUMENT",
"reason": "content mismatch",
"request_id": "TID2b540d5a7f1f44dca8b504a449b3061f"
}