查询推荐用户 (KEYED) - WOO X Pro

查询 login 代理子树内的 referral 用户（含 KYC 状态）。

请求URL

GET https://cloud-api.wooxpro.com/contract/affiliate/private/referralUsers

请求限制

参见速率限制详细

请求参数

请求

curl -H 'X-API-KEY:{{AccessKey}}'
'https://cloud-api.wooxpro.com/contract/affiliate/private/referralUsers?page=1&size=20'

参数	类型	是否必填	描述
page	Integer	必填	页码，需 > 0
size	Integer	必填	每页笔数，需 > 0
uid	Long	选填	下线 uid（cid）；查无报 40053，不在 login 子树报 40054
referralCode	String	选填	筛选经由该 referral code 邀请的用户。未知 code 返回空列表；owner 不在子树报 40055
startTime	Long	选填	注册时间起（Unix ms）
endTime	Long	选填	注册时间止（Unix ms）

响应详情

响应

{
  "code": 1000,
  "trace": "0cc6f4c48b8c42538e908d3195aa109c",
  "message": "Ok",
  "data": [
    {
      "uid": 123456,
      "registerTime": 1688992720000,
      "referralCode": "ABCDEF",
      "kycResult": true,
      "kycLevel": 2
    }
  ],
  "total": 1
}

字段	类型	描述
uid	Long	用户 ID（cid）
registerTime	Long	注册时间（毫秒时间戳）
referralCode	String	使用的推荐码
kycResult	Boolean	KYC 认证结果；`kycLevel > 0` 时为 `true`
kycLevel	Integer	KYC 等级：`0` 未认证，`1` 初级认证，`2` 高级认证
total	Long	总记录数

错误码

errMsg	code	http status
Invalid parameter!	40012	400
Trade cid not found	40053	400
Trade cid is not under your affiliate subtree	40054	403
Referral code is not under your affiliate subtree	40055	403