接口文档

发送验证码接口

用来发送短信。需要提供用户的api_key，接收短信的号码以及短信内容。请求之后会得到此次发送的一个ID，根据此ID可以用来查询短信发送的状态。

接口地址：http://www.haosms.net/client/extra_api/otp_msg

请求方式：POST/GET

参数说明：

参数名	类型	必填	说明
`api_key`	String	是	用户的唯一标识符
`phone`	String	是	接受验证码的手机号码，号码格式：1324638088。不用加0086，不接受+86格式
`content`	String	是	验证码。验证码只能是数字加英文字母，且长度不能超过6位
`platform`	String	是	用于发送验证码的通道。比如中国OTP通道2，中国OTP通道1
`tmp_id`	String	否	用于指定验证码信息模板（不传使用系统默认OTP模板）

模板说明（tmp_id）：

默认（不需要传值）：验证码：XXXX，请输入并验证！请勿向任何人透漏索取验证码。请注意:验证码有效时间为1小时，过期失效将无法顺利验证！
1：验证码：XXXX，您正在修改个人资料，需要进行校验！请勿向任何人透露索取验证码。
2：验证码：XXXX，请输入并校验！请勿向任何人透露索取验证码。
3：验证码：XXXX，您正在更改问题和答案，需要进行校验！请勿向任何人透露索取验证码。
4：验证码：XXXX，您正在更新密码，需要进行校验！请勿向任何人透露索取验证码。

返回结果：

样例：

{
    "msg": "a42739630dbe4daa8d4f5f6a530a35bc",
    "result": "成功",
    "code": "",
    "data": null,
    "datas": [],
    "name": "extra_api.otp_msg",
    "request_id": ""
}

msg：
- 成功时：返回具体的任务ID（字符串格式）
- 失败时：返回错误信息
result：
- 成功时：返回"成功"字符
- 失败时：返回"失败"字符
code：返回代码，通常为空字符串
data：返回数据，通常为null
datas：数据数组，通常为空数组
name：接口名称，固定为"extra_api.otp_msg"
request_id：请求ID，通常为空字符串

请求范例：

http://haosms.net/client/extra_api/otp_msg/?api_key=kknft3xxxx&content=123212&phone=155xxxx827&platform=%E9%AA%8C%E8%AF%81%E7%A0%81%E9%80%9A%E9%81%931

查询余额接口

用于查询账户余额。需要提供用户的api_key，请求后会返回当前账户的余额信息。

接口地址：https://haosms.net/client/user/s_balance

请求方式：GET/POST

参数说明：

参数名	类型	必填	说明
`api_key`	String	是	用户的唯一标识符

返回结果：

样例：

{
    "msg": "",
    "result": "True",
    "code": "",
    "data": {
        "balance": 0
    },
    "datas": [],
    "name": "",
    "request_id": ""
}

msg：返回消息，成功时为空字符串
result：
- 成功时：返回"True"
- 失败时：返回"False"
code：返回代码，成功时为空字符串
data：返回数据对象
- balance：账户余额（数字类型）
datas：数据数组，通常为空数组
name：接口名称，通常为空字符串
request_id：请求ID，通常为空字符串

请求范例：

https://haosms.net/client/user/s_balance?api_key=yourApiKey