接口文档

壹川接口文档V3

发送验证码到手机

更新时间：2018-04-09 17:11:50 更新人员：叶洋

文档状态：完成 #3 测试接口

章节导航器

接口基本信息
请求参数
响应数据参数
请求示例

摘要
需要使用手机号作为验证码接收端的应用场景接口

接口基本信息

接口名称：发送验证码到手机
请求方法：POST
接口地址：sms/captcha
登录验证：否

请求参数

参数名	参数	数据类型	是否必须	示例值	说明
mobile	手机号码	string	是
tag	短信用途标识	string	是		短信用途标识，自定义字符串

响应数据参数

参数名	参数	数据类型	示例值	说明
status	发送状态	int	1	接口调用成功为1
msg	结果说明	string	调用成功	短信发送结果描述
ticket_stub	标记编码	string	5a4b4d9e01010000	标记编码用于验证时对比识别
data[]	云片网返回数据	arrayo
├ code	├ 状态码	int	0	短信发送成功为0
├ msg	├ 描述	string	发送成功
├ count	├ 短信数量	int	1
├ fee	├ 收取费用	float		云片网收取费用金额
├ unit	├ 费用单位	string	RMB	RMB为人民币
├ mobile	├ 发送手机	string
└ sid	└ 短信发送id	int	20787778348	在云片网内的短信id

请求示例

请求例子：

apirq('sms/captcha', {
    method: 'post',
    data: {
        mobile: '182XXXXXXXX',
        tag: 'resetpwd'
    }
})

返回数据结果：

{
    "code": 0,
    "msg": "ok",
    "time": "1514884508",
    "data": {
        "status": 1,
        "msg": "调用成功",
        "data": {
            "code": 0,
            "msg": "发送成功",
            "count": 1,
            "fee": 0.05,
            "unit": "RMB",
            "mobile": "182XXXXXXXX",
            "sid": 20787778348
        },
        "ticket_stub": "5a4b4d9e01010000"
    }
}

关于返回结果中的 ticket_stub 字段说明：
由于使用api接口的方式来请求和传递数据，导致Session不稳定或难以应用，所以在校验验证码正确与否时采用“ticket_stub”标识编码来做验证码的增补校验。

本书创建于 2018-03-30 12:03:13 ？如有疑问，请联系技术人员