1. 描述

私查户属。用户查询自己的属性。

2. URL

GET:https://api.kernel.xdua.com/usra

3. 调用场景

任何场合,当用户需要知道自己的属性的时候,就用这个接口

4. 请求参数

参考标准查询接口请求参数

5. 返回参数

公共返回部分参考标准查询接口返回参数。具体返回的数据包含data和list两部分。这是usra接口独特的现象。data是字典格式的。list是列表格式的。

5.1. result.data部分

字段key 位置 类型 示例 说明
WXUserProfile.Privilege result string rYub4wrT 微信特权
WXUserProfile.City result string rYub4wrT 微信城市
WXUserProfile.Headimgurl result string 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132' 微信头像URL
WXUserProfile.Language result string 'zh_CN' 微信语言
WXUserProfile.Nickname result string '焦帅' 微信昵称
WXUserProfile.Unionid result string o6EyZv2HuY8STp3hLBV9TFOqs84U 微信Unionid
WXUserProfile.Country result string CN 微信国家
WXUserProfile.Sex result string '1' 微信性别
WXUserProfile.Openid result string oA9KU5q5B5163ozPzw1C_GFd7ULc 微信Openid
WXUserProfile.Province result string rYub4wrT 微信省份
XduaUserProfile.Name result string rYub4wrT 地球号用户名字
XduaUserProfile.Bday result string 19670812 地球号用户生日
XduaUserProfile.Sex result string 'u'/'m'/'f' 地球号用户性别。 m=男性,f=女性,u=未知
XduaUserProfile.Avatar result string http://*.webp 地球号用户URL
XduaUserProfile.Tel result string +86-15810419011 地球号用户电话
XduaUserProfile.Mail result string jiaoshuai@gmail.com 地球号用户邮箱

5.2. result.list部分

当我们想要用列表格式数据的时候,就需要访问list格式。

名称 位置 类型 示例 说明 id result.list[] string rYub4wrT 详情的户属ID attr result.list[] string 户属的名称 value result.list[] string 户属图标

6. 错误码

7. 示例

获取登录用户的名字和性别

let api_name  = "户属查询";
query = {
    where:{attr:"XduaUserProfile.Name,XduaUserProfile.Sex"}
}
let res = await xduaClient.qriUsra(query)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

//返回数据


{
    "status": 200,
    "apid": "B1D45C25-D39C-4118-A4AA-F271ED8AC494",
    "apis": "QriUsra",
    "error": 0,
    "result": {
        "limit": 20,
        "total": 2,
        "sort": {
            "inc": "DESC"
        },
        "count": 2,
        "page": 1,
        "pages": 1,
        "data": {
            "XduaUserProfile.Sex": "m",
            "XduaUserProfile.Name": "羊辣椒"
        },
        "list": [{
            "id": "Dt5mvrt1",
            "value": "m",
            "attr": "XduaUserProfile.Sex"
        }, {
            "id": "Dt5mvrtE",
            "value": "羊辣椒",
            "attr": "XduaUserProfile.Name"
        }],
        "format": "raw",
        "where": {
            "user_id": "Dt5mvrtE",
            "attr": ["XduaUserProfile.Name", "XduaUserProfile.Sex"]
        },
        "offset": 0
    },
    "debug": [],
    "message": "message",
    "reason": "success"
}

获取登录用户的所有属性


query = {
    where:{attr:"*"}
}

let res = await xduaClient.qriUsra(query)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
    console.log(api_name+"成功 ");
}else{
    console.log(api_name+"失败 "+res.reason);
}

//返回的数据



{
    "status": 200,
    "apid": "7AE341C7-EAC7-4428-9F34-67C0F2837383",
    "apis": "QriUsra",
    "error": 0,
    "result": {
        "limit": 20,
        "total": 4,
        "sort": {
            "inc": "DESC"
        },
        "count": 4,
        "page": 1,
        "pages": 1,
        "data": {
            "XduaUserProfile.Sex": "m",
            "XduaUserProfile.Tel": "+86-15810419011",
            "XduaUserProfile.Name": "羊辣椒",
            "XduaUserProfile.Mail": "jiaoshuaihit@163.com"
        },
        "list": [{
            "id": "Dt5mvrt3",
            "value": "jiaoshuaihit@163.com",
            "attr": "XduaUserProfile.Mail"
        }, {
            "id": "Dt5mvrt2",
            "value": "+86-15810419011",
            "attr": "XduaUserProfile.Tel"
        }, {
            "id": "Dt5mvrt1",
            "value": "m",
            "attr": "XduaUserProfile.Sex"
        }, {
            "id": "Dt5mvrtE",
            "value": "羊辣椒",
            "attr": "XduaUserProfile.Name"
        }],
        "format": "raw",
        "where": {
            "user_id": "Dt5mvrtE"
        },
        "offset": 0
    },
    "debug": [],
    "message": "message",
    "reason": "success"
}
{ status: 200,
  apid: '9EA7C102-C709-40AD-AED6-61824D6BF4DA',
  apis: 'QriUsra',
  error: 0,
  result:
   { limit: 20,
     total: 10,
     sort: { inc: 'DESC' },
     count: 10,
     page: 1,
     pages: 1,
     data:
      { 'WXUserProfile.City': '',
        'WXUserProfile.Headimgurl':
        'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132',
        'WXUserProfile.Language': 'zh_CN',
        'WXUserProfile.Nickname': '焦帅',
        'WXUserProfile.Unionid': 'o6EyZv2HuY8STp3hLBV9TFOqs84U',
        'Profile.Ukey': '辣椒帅',
        'WXUserProfile.Country': 'CN',
        'WXUserProfile.Sex': '1',
        'WXUserProfile.Openid': 'oA9KU5q5B5163ozPzw1C_GFd7ULc',
        'WXUserProfile.Province': '' },
     list:
      [ [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object] ],
     format: 'raw',
     where: { shop_id: 'XdUaXduA', user_id: 'Dt5mvrtU' },
     offset: 0 },
  debug: [],
  event:
   '{"body":"","headers":{"CaOpenId.iss":"xdua.com","CaRequestId":"9EA7C102-C709-40AD-AED6-61824D6BF4DA","CaOpenId.bug":"DE","XduaClientDev":"null","XduaApiResource":"usra","CaOpenId.iat":"1604551842","CaRequestHandleTime":"2020-11-05T04:50:42Z","CaAppId":"6151654","XduaApiRule":"QueriUsra","XduaApiAction":"QueriUsra","XduaApiValidQueryWheres":"attr,attr[~]","XduaAcceptLang":"zh","CaOpenId.typ":"U","XduaApiKparam":"state+.+expire","XduaApiColor":"X","CaProxy":"AliCloudAPIGateway","CaApiName":"QriUsra","XduaApiRoles":"*","CaOpenId.lgn":"l7gdGFhi","XduaApiValidQueryFormats":"raw","XduaApiMethod":"QRI","XduaApiValidQueryFilters":"*","CaOpenId.role":"*","XduaApiTokenType":"U","CaClientUa":"axios/0.18.1","CaOpenId.nbf":"1604551842","XduaApiAstates":"0","XduaApiShop":"*","XduaApiVersion":"1.0.0","CaOpenId.sap":"SvKerneL","CaOpenId.exp":"1604552442","Content-Type":"application/x-www-form-urlencoded; charset=UTF-8","CaOpenId.corp":"XdUaXduA","CaOpenId.rule":"*","CaClientIp":"39.97.224.240","X-Ca-Api-Gateway":"9EA7C102-C709-40AD-AED6-61824D6BF4DA","XduaApiSubject":"*","XduaApiHttpSchema":"HTTPS","XduaApiAudience":"*","CaOpenId.own":"Dt5mvrtU","CaOpenId.sub":"Dt5mvrtU","CaOpenId.tid":"Js8j9wok","CaOpenId.aud":"ConsoleX","CaOpenId.tag":"Primary","Authorization":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2MDQ1NTE4NDIsIm5iZiI6MTYwNDU1MTg0MiwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2MDQ1NTI0NDIsImF1ZCI6IkNvbnNvbGVYIiwic3ViIjoiRHQ1bXZydFUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiWCIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydFUiLCJzYXAiOiJTdktlcm5lTCIsImFwaSI6IkFkZFRvZ2lueCIsInpvbmUiOiJYZFVhWGR1QSIsImNvcnAiOiJYZFVhWGR1QSIsInNob3AiOiJYZFVhWGR1QSIsInJvbGUiOiIqIiwicnVsZSI6IioiLCJidWciOiJERSIsInRpZCI6IkpzOGo5d29rIiwibGduIjoibDdnZEdGaGkifQ.mh3HE6yTCCSJ-5e7Lhk_XnWnNd5glhTBYqrrIaArZjl4ljE71UmA4UoDyU_cLRWWdUgnNvXRvsjH2c2hofelMVHDHB0H6d9xUJ_6_4Qy8NPHlxHwA8YfDOIco92R4HVER9CXCb-Kj7YZs3GqdO5mqL3711Swx5cEBN6I68yrWKbPPq5jdj9OxMK7wbFbytRIHtDA_VYfIzu5pFF1p-KLfi0OSt6a5W5XXhZUkxAqAiKjJEGCskaaOLX0rUhbmc25tHJdZ1hqHK9FY5josyhE0o04dFcyrYz7dqk7ZuZ4TeS1IBnCqFzmLRYzpvVrdnlrb5N5GwqPmuMenv65E4WY7A","XduaApiValidQuerySchemas":"*","CaHttpSchema":"HTTP","XduaApiValidQueryFields":"@all,*","CaDomain":"api.svkernel.xdua.com","CaOpenId.clr":"X","CaOpenId.jti":"12345678","CaOpenId.dvm":"*","XduaApiEnable":"true","CaOpenId.ipm":"*","X-Forwarded-For":"39.97.224.240","CaOpenId.api":"AddToginx","CaOpenId.shop":"XdUaXduA","CaOpenId.zone":"XdUaXduA"},"httpMethod":"GET","isBase64Encoded":false,"path":"/usrai","pathParameters":{},"queryParameters":{"limit":"20","schema":"*","sort":"inc:DESC","page":"0","format":"raw","offset":"0","where":"{}","filter":"*","fields":"*"}}',
  message: '成功。',
  reason: '成功' }

results matching ""

    No results matching ""