接口文档

壹川接口文档V3

检查邮箱验证码

更新时间：2018-04-09 17:12:41 更新人员：叶洋

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

章节导航器

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

摘要
检查邮件验证码是否正确，通过验证后发放一枚信任令牌。

接口基本信息

接口名称：检查邮箱验证码
请求方法：POST
接口地址：email/captchacheck
登录验证：是

请求参数

参数名	参数	数据类型	是否必须	示例值	说明
tag	用途标识	string	是		用途标识，与发送时的自定义字符串一致
ticket_stub	邮件编号	string	是	5a4b4d9e01010000	邮件编号，验证标识
email	邮件地址	email	是
code	验证码	string	是		接收到的6位数字邮件验证码，以字符串形式传递

响应数据参数

参数名	参数	数据类型	示例值	说明
status	验证状态	int	1	验证状态，1为成功，其它为失败
msg	验证提示	string	验证码正确	验证结果提示信息
trust_token	信任令牌	string		在接下来的操作中会使用它来检测是否前期经过了验证码信任

请求示例

请求例子：

apirq('email/captcha', {
    method: 'post',
    data: {
        tag: 'vovo',
        email: 'xxx@qq.com',
        ticket_stub: '5a4c595501010000',
        code: '277694'
    }
})

返回数据结果：
# 验证成功：

{
    "code": 0,
    "msg": "ok",
    "time": "1514953382",
    "data": {
        "status": 1,
        "msg": "验证码正确",
        "trust_token": "cvle14058w2q8ero"
    }
}

# 验证失败：

// tag: vovo2 时
{
    "code": 0,
    "msg": "ok",
    "time": "1514949264",
    "data": {
        "status": -1,
        "msg": "验证条件不匹配"
    }
}
// code: 325141 时
{
    "code": 0,
    "msg": "ok",
    "time": "1514949343",
    "data": {
        "status": 0,
        "msg": "验证码错误 "
    }
}
// ticket_stub: 5a4c48e901010099
{
    "code": 0,
    "msg": "ok",
    "time": "1514949177",
    "data": {
        "status": -3,
        "msg": "未发送验证码或邮件编号错误"
    }
}

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