Logo Site EngageLab Mark Colored Transparent文档
搜索

结果校验 API

接口说明

APP 服务端调用此接口,将 Engagelab SDK 返回的加密数据(payload)发送给 Engagelab 服务器进行手机号一致性校验。

接口信息

项目 说明
请求路径 POST /v1/verify
请求协议 HTTPS
认证方式 HTTP Basic Auth
Content-Type application/json

最新域名:authapi.engagelab.com

请求示例

curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \ -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \ -H 'Content-Type: application/json' \ -d '{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }'
              
              curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
  -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
  }'

            
此代码块在浮窗中显示

认证方式

使用 HTTP Basic Auth 进行身份认证:

Authorization: Basic base64(appKey:appSecret)
              
              Authorization: Basic base64(appKey:appSecret)

            
此代码块在浮窗中显示

示例:

  • appKey: tn4nm0qx032yx6f17q2tsa8f
  • appSecret: your_app_secret_here
  • base64编码: dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl
Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl
              
              Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

            
此代码块在浮窗中显示

请求参数

参数名 类型 必填 说明
payload string Engagelab SDK 返回的加密数据,由 APP 透传

请求体示例:

{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }
              
              {
  "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}

            
此代码块在浮窗中显示

响应参数

成功响应 (HTTP 200)

参数名 类型 说明
code int 状态码,0 表示成功
msg string 状态描述
data object 响应数据
data.message_id string 消息唯一标识,可用于问题排查
data.verified boolean 手机号验证结果,true 表示一致,false 表示不一致

成功示例(验证通过):

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": true } }
              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": true
  }
}

            
此代码块在浮窗中显示

成功示例(验证不通过):

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": false } }
              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": false
  }
}

            
此代码块在浮窗中显示

错误响应 (HTTP 4xx/5xx)

参数名 类型 说明
code int 错误码
msg string 错误描述

错误示例:

{ "code": 2001, "msg": "auth failed" }
              
              {
  "code": 2001,
  "msg": "auth failed"
}

            
此代码块在浮窗中显示

错误码说明

错误码 HTTP 状态码 说明 处理建议
1000 500 服务器内部错误 请稍后重试,若持续出现请联系技术支持
2001 401 认证失败 检查 appKey 和 appSecret 是否正确,Authorization 格式是否符合规范
2004 401 appKey 无效 检查 appKey 是否正确,或联系技术支持确认服务是否已开通
3001 400 参数格式错误 检查请求体是否为合法的 JSON 格式
3002 400 参数校验失败 检查 payload 参数是否存在且格式正确
3003 400 appKey 不匹配 payload 中的 appKey 与认证头中的 appKey 不一致,请确保使用正确的密钥对
3004 400 配置未启用 服务配置尚未启用,请联系技术支持开通
3005 400 余额不足 账户余额不足,请充值后重试
4001 400 配置不存在 未找到对应的服务配置,请联系技术支持
5001 400 验证失败 运营商认证过程出现异常,可根据 msg 中的具体信息排查或联系技术支持

注意事项

  1. payload 透传:APP 收到 Engagelab SDK 返回的 payload 后,需原样提交给 APP 服务端,再由 APP 服务端调用本接口,不要对 payload 进行任何修改
  2. 安全建议:appSecret 请妥善保管,仅在服务端使用,不要在 APP 中暴露
  3. 验证结果verifiedfalse 表示用户输入的手机号与 SIM 卡手机号不一致,应拒绝用户登录
Icon Solid Transparent White Qiyu
联系销售