营销风控API文档

最近更新时间:2019-08-06 14:56:08

接口描述

协议:HTTPS POST
域名:csec.api.qcloud.com
接口名:IntelligentQRCode

输入参数

注意:

以下所有参数在入参时,请正确传参,不能传入空值。

参数名称 是否必须 类型 描述
accountType 必须 Uint 用户账号类型(QQ 开放帐号、微信开放账号需要 提交工单 由腾讯云进行资格审核):
  • 1:QQ 开放帐号。
  • 2:微信开放账号。
  • 4:手机号。
  • 0:其他。
  • 10004:手机号 MD5。
  • uid 必须 String 用户 ID 值,如微信或QQ openid,或手机号等(如15912345687)。
    userIp 必须 String 用户领取奖励时的真实外网 IP。
    postTime 必须 Uint 用户操作时间戳,单位秒(格林威治时间精确到秒,如1501590972)。
    appId 可选 String accountType 是 QQ 或微信开放账号时,该参数必填,表示 QQ 或微信分配给网站或应用的 appId,用来唯一标识网站或应用。
    goodInfo 必须 String 所买物品信息。
    encryptedCode 可选(建议填写) String 领奖码的唯一加密码(请注意信息安全,使用加密码,确保唯一 ID 即可)。
    cookie 可选 string 用户 HTTP 请求中的 cookie 进行2次 hash 的值,只要保证相同 cookie 的 hash 值一致即可。
    share 可选(建议填写) Uint 单个红包允许领取的用户数量(分享红包)。
    例如:
  • 1:单个红包仅支持1个用户领取(非分享红包)。
  • 2:单个红包可允许2个用户领取。
  • dayTimes 可选(建议填写) Uint 单日内,单个账号每日领取奖励的最大次数。
    totaltimes 可选(建议填写) Uint 整个活动周期内,单个账号能领取奖励的最大次数。
    phoneNumber 可选(建议填写) String 若 accountType 非手机号码, 且能获取到手机号,则填入对应的手机号(如:15912345687)。
    address 可选(建议填写) String 用户参加活动的地址位置信息,如可填入用经纬度信息转化为的具体地址信息。
    latitude 可选(建议填写) Float 维度。浮点数,范围为-90 - 90。
    longitude 可选(建议填写) Float 经度。浮点数,范围为-180 - 180。
    imei 可选 String 手机设备号。
    referer 可选 String 用户 HTTP 请求的 referer 值。
    loginType 可选 UInt 登录方式:
  • 0:其他。
  • 1:手动帐号密码输入。
  • 2:动态短信密码登录。
  • 3:二维码扫描登录。
  • loginSource 可选 UInt 登录来源:
  • 0:其他 。
  • 1:PC网页。
  • 2:移动页面。
  • 3:APP。
  • 4:微信公众号。
  • wxSubType 可选 int
  • 1:微信公众号。
  • 2:微信小程序。
  • randNum 可选 String Token 签名随机数,微信小程序必填,建议16个字符。
    wxToken 可选 String
  • 如果是微信小程序,该字段为以 ssesion_key 为 key 去签名随机数 radnNum 得到的值(hmac_sha256签名算法)。
  • 如果是微信公众号或第三方登录,则为授权的 access_token(注意:不是普通 access_token,详细请参阅官方 说明文档
  • 输出参数

    参数名称 类型 描述
    code Int 返回码。
    codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
    message String UTF-8 编码,出错消息。
    Nonce UInt 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击(公共参数)。
    postTime String 操作时间戳,单位秒(对应输入参数)。
    uid String 用户 ID,accountType 不同对应不同的用户 ID。如果是 QQ 或微信用户则填入对应的 openId(对应输入参数)。
    userIp String 操作来源的外网 IP(对应输入参数)。
    level Int 风险值:
  • 0:表示无恶意。
  • 1 - 4:恶意等级由低到高。
  • riskType Array 风险类型,详情请参见下文 riskType 详细说明。
    associateAccount String accountType 是 QQ 或微信开放账号时,用于标识 QQ 或微信用户登录后关联业务自身的账号 ID。

    risktype 详细说明

    风险类型 风险详情 风险码 描述
    账号风险 账号信用低 1 账号近期存在因恶意被处罚历史、低活跃、被举报等因素。
    垃圾账号 2 疑似批量注册小号、近期存在严重违规或大量举报。
    无效账号 3 送检账号参数无法成功解析,若为微信或 QQ openid,请检查是否送检数据错误。
    黑名单 4 业务自行加黑的记录。
    白名单 5 业务自行加白的记录。
    行为风险 批量操作 101 存在 IP、设备、环境等因素的聚集性异常。
    自动机 102 疑似自动机批量请求。
    异常扫码 103 频繁扫码、大量扫废码等异常扫码行为。
    登录态无效 104 检查 wxtoken 参数,是否已经失效。
    环境风险 环境异常 201 操作 IP、设备、环境存在异常。如当前 IP 为非常用 IP 或恶意 IP 段。
    JS 上报异常 202 需用户在前端部署 JS 方有效。
    撞库 203 有过撞库记录。
    非公网有效 IP 205 传进来的 IP 地址为内网 IP 地址,或者为 IP 保留地址。

    示例代码

    代码示例下载: Python示例Java示例
    一个完整的请求需要两类请求参数:公共请求参数和接口请求参数。本文列出了接口请求参数,未列出公共请求参数,有关公共请求参数的更多说明,请参阅 公共请求参数 文档。

    请求示例

    https://csec.api.qcloud.com/v2/index.php?
    Action=IntelligentQRCode
    &<公共请求参数>
    &secretId=AKIDmQtAxYTAB2iBS8s2DCzazCD2g7OUq4Zw
    &accountType=1
    &cookie = "asdasldkjaslkjdsfjlsad" //用户 HTTP 请求中的 cookie 进行2次 hash 的值
    &goodInfo="good"  //业务侧自定义内容
    &uid=D692D87319F2098C3877C3904B304706
    &userIP=127.0.0.1 //调用时必须是外网有效 IP 地址
    &postTime=11254 //uinx 时间戳,仅需要精确到秒
    &associateAccount="SpFsjpyvaJ27329"

    响应示例

    {
        "code": 0,
        "message": "No Error",
        "level": 0,
        "userIP": "127.0.0.1",
        "postTime": 1436673889,
        "uid": "00000000000000000000000033121475",
        "associateAccount": "SpFsjpyvaJ27329"
    }