1.应用范围

• 常见问题请移步至「对接问题」

2.接口概要

3.安全方式

4.手机号解密算法

5.置换手机号接口—Android、iOS、HarmonyOS端

5.1接口地址和说明

名称	说明
说明	本接口对接SDK一键登录功能，接收Android、iOS、HarmonyOS端SDK一键登录返回的token，将其置换为真实手机号码。
协议	HTTPS
请求方式	POST
编码格式	UTF8
请求内容类型	application/x-www-form-urlencoded
响应内容类型	application/json
请求地址	https://wsflash.253.com/open/flashsdk/mobile-query

5.2接口请求参数

参数名	类型	参数描述	是否必填	说明
appId	String	应用的APPID	是	由控制台创建应用时生成。
token	String	运营商token	是	SDK返回的token，一次有效，不可压测
clientIp	String	客户端IP	否	由客户服务端获取的前端APP的IP，如需要使用反欺诈核验功能则传入，否则可以不传。
encryptType	String	手机号加密方式	否	返回的手机号码加密方式，值包含：0（AES加密）、1（RSA加密）缺省为0，如使用RSA方式则在创建应用时必须填写RSA公钥。
outId	String	客户方流水号	否	客户方流水号, 可以为空。
sign	String	签名	是	签名算法： hmacSHA256(所有传入参数按字段名正序排序后拼接的字符串，应用appKey) 算法示例： 1、只传入必填参数示例： hmacSHA256("appIdxxxxxxtokenxxxxxxxxxxxxxxx","xxxxxxx") 2、传入了所有参数示例： hmacSHA256("appIdxxxxxxclientIp1.1.1.1encryptType0outId11111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 实际值示例： 9A92CD5A319D254B3DC6BEB7EAD4C2B4F4962B2F

5.3接口响应内容

字段名	类型	参数描述	说明
code	String	响应代码	200000表示成功，其他代码都为失败，详情参考附录。
message	String	响应描述	响应代码描述
chargeStatus	Int	计费标识	是否收费，枚举值：1:收费/0:不收费
data	Object	数据内容
data >mobileName	String	手机号密文	手机号密文 ，根据传入的encryptType值选择对应算法解密手机号。
data >tradeNo	String	交易流水号	闪验的交易流水号

5.4接口返回示例

复制成功
{
"code": "200000",
"chargeStatus": 1,
"message": "成功",
"data": {
    "tradeNo": "18112115031414011",
    "mobileName": "1F881288CC68352FC410E8D4A36FC6E0",
    "fanqizha":1,
    "tag":""
  }
}

6.置换手机号接口—Web端

6.1接口地址和说明

名称	说明
说明	本接口对接SDK一键登录功能，接收Web端SDK一键登录返回的token将其置换为真实手机号码。
协议	HTTPS
请求方式	POST
编码格式	UTF8
请求内容类型	application/x-www-form-urlencoded
响应内容类型	application/json
请求地址	https://api.253.com/open/web/mobile-query

6.2接口请求参数

参数名	类型	参数描述	是否必填	说明
appId	String	应用的APPID	是	由控制台创建应用时生成。
token	String	运营商token	是	SDK返回的token，一次有效，不可压测
clientIp	String	客户端IP	否	由客户服务端获取的前端APP的IP，如需要使用反欺诈核验功能则传入，否则可以不传。
encryptType	String	手机号加密方式	否	返回的手机号码加密方式，值包含：0（AES加密）、1（RSA加密）缺省为0，如使用RSA方式则在创建应用时必须填写RSA公钥。
outId	String	客户方流水号	否	客户方流水号, 可以为空。
sign	String	签名	是	签名算法： hmacSHA256(所有传入参数按字段名正序排序后拼接的字符串，应用appKey) 算法示例： 1、只传入必填参数示例： hmacSHA256("appIdxxxxxxtokenxxxxxxxxxxxxxxx","xxxxxxx") 2、传入了所有参数示例： hmacSHA256("appIdxxxxxxclientIp1.1.1.1encryptType0outId11111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 实际值示例： 9A92CD5A319D254B3DC6BEB7EAD4C2B4F4962B2F

6.3接口响应内容

字段名	类型	参数描述	说明
code	String	响应代码	200000表示成功，其他代码都为失败，详情参考附录。
message	String	响应描述	响应代码描述
chargeStatus	Int	计费标识	是否收费，枚举值：1:收费/0:不收费
data	Object	数据内容
data >mobile	String	手机号密文	手机号密文 ，根据传入的encryptType值选择对应算法解密手机号。
data >tradeNo	String	交易流水号	闪验的交易流水号

6.4接口返回示例

复制成功
{
    "code": "200000",
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "tradeNo": "18112115031414011",
        "mobile": "1F881288CC68352FC410E8D4A36FC6E0"
    }
}

7.本机号码校验接口

7.1接口地址和协议说明

名称	说明
说明	本接口对接SDK本机认证功能，接收Android、iOS端SDK返回的token和传入的手机号码，校验当前流量卡的手机号与传入的手机号码是否一致并返回校验结果。
协议	HTTPS
请求方式	POST
编码格式	UTF8
请求内容类型	application/x-www-form-urlencoded
响应内容类型	application/json
请求地址	https://wsflash.253.com/open/flashsdk/mobile-validate

7.2接口请求参数

参数名	类型	参数描述	是否必填	说明
appId	String	应用的APPID	是	由控制台创建应用时生成。
token	String	运营商token	是	SDK返回的token，一次有效，不可压测
mobile	String	手机号	是	待校验的手机号码
outId	String	客户方流水号	否	客户方流水号, 可以为空。
sign	String	签名	是	签名算法： hmacSHA256(所有传入参数按字段名正序排序后拼接的字符串，应用appKey) 算法示例： 1、只传入必填参数示例： hmacSHA256("appIdxxxxxxmobile11111111111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 2、传入了所有参数示例： hmacSHA256("appIdxxxxxxmobile11111111111outId11111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 实际值示例： 9A92CD5A319D254B3DC6BEB7EAD4C2B4F4962B2F

7.3接口响应内容

字段名	类型	参数描述	说明
code	String	响应代码	200000表示成功，其他代码都为失败，详情参考附录。
message	String	响应描述	响应代码描述
chargeStatus	Int	计费标识	是否收费，枚举值：1:收费/0:不收费
data	Object	数据内容
data >isVerify	String	校验结果	值：1 是本机号码 0 非本机号码
data >tradeNo	String	交易流水号	闪验的交易流水号

7.4接口返回示例

复制成功
{
"code": "200000",
"chargeStatus": 1,
"message": "成功",
"data": {
    "tradeNo": "18112115031414011",
    "isVerify":"1"
}
}

8.本机校验接口—Web端

8.1接口地址和说明

名称	说明
说明	本接口对接SDK本机校验功能，接收Web端SDK本机校验返回的token和传入的手机号码，校验当前流量卡的手机号与传入的手机号码是否一致并返回校验结果。
协议	HTTPS
请求方式	POST
编码格式	UTF8
请求内容类型	application/x-www-form-urlencoded
响应内容类型	application/json
请求地址	https://api.253.com/open/flashsdk/web-mobile-validate

8.2接口请求参数

参数名	类型	参数描述	是否必填	说明
appId	String	应用的APPID	是	由控制台创建应用时生成。
token	String	运营商token	是	SDK返回的token，一次有效，不可压测
mobile	String	手机号	是	待校验的手机号码。
outId	String	客户方流水号	否	客户方流水号, 可以为空。。
sign	String	签名	是	签名算法： hmacSHA256(所有传入参数按字段名正序排序后拼接的字符串，应用appKey) 算法示例： 1、只传入必填参数示例： hmacSHA256("appIdxxxxxxmobile11111111111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 2、传入了所有参数示例： hmacSHA256("appIdxxxxxxmobile11111111111outId11111tokenxxxxxxxxxxxxxxxxx","xxxxxxx") 实际值示例： 9A92CD5A319D254B3DC6BEB7EAD4C2B4F4962B2F

8.3接口响应内容

字段名	类型	参数描述	说明
code	String	响应代码	200000表示成功，其他代码都为失败，详情参考附录。
message	String	响应描述	响应代码描述
chargeStatus	Int	计费标识	是否收费，枚举值：1:收费/0:不收费
data	Object	数据内容
data >isVerify	String	校验结果	值：1 是本机号码 0 非本机号码。
data >tradeNo	String	交易流水号	闪验的交易流水号

8.4接口返回示例

复制成功
{
    "code": "200000",
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "tradeNo": "18112115031414011",
        "isVerify": "1"
    }
}

9.附录

响应code码

状态码	描述
200000	请求成功
200400	取号失败，号码补填不正确
400001	参数校验异常
403000	用户校验失败（一般为签名问题，参考：对接问题>服务端问题）
415000	请求数据转换异常
500000	系统异常
500002	数据处理异常
500003	业务操作失败
500004	远程调用失败
500005	账户余额异常
500006	请求外部系统失败
504000	系统超时
400101	在下游系统中的商户信息不存在
403101	账户被下游系统禁用
403102	账户在下游系统中没有被激活
510101	在下游系统中的用户产品可用数量不足
400102	商户IP地址在下游系统中不合法
400200	黑名单列表
400201	手机号码不能为空
400901	账户信息不存在
400902	应用类型信息不存在
500901	邮箱未设置
500902	账户信息已存在
500903	账户相关能力已激活