调用该接口查询当前登录用户名下的虚拟用户列表。

路径 /uc/virtual/user/list
版本号 1.0.6
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权 是
超时时间 15000

请求参数

名称 类型 是否必选 示例值 描述
pageNo Int 是 当前页号，从1开始的页序号。
pageSize Int 是 页大小，单页的item数量上限。
userId String 否 淘宝账号ID信息。
userType String 否 账号类型，淘宝：TAOBAO。
origin String 否 标示来源，目前必须填写：TmallGenie。
sceneId String 否 使用场景的ID。

返回数据

名称 类型 示例值 描述
total Long

虚拟用户的总数。
pageNo Int

当前的页号。
pageSize Int

分页的大小。
data JSON

虚拟用户列表。
userId String

虚拟用户的ID。
attrList JSON

用户的属性及属性值。属性Key必须是在规定的系统属性中选择。
attrKey String

用户的属性Key。
attrValue String

用户的属性值。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.6",
		"iotToken": "token"
	},
	"params":{
		"pageNo": "value0",
		"pageSize": "value1",
		"userId": "value2",
		"userType": "value3",
		"origin": "value4",
		"sceneId": "value5"
	}
}

正常返回示例

JSON 格式 

{
    "code": 200,
    "message": "success",
    "data": {
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "userId":"10B633xxxxxxxxBDD428F58AA5A18",
                "attrList":[
                   {
                       "attrKey":"name",
                       "attrValue":"小明"
                   }
                ]
            }
        ]
    }
}

异常返回示例

JSON 格式 

{
 "code":503,
 "id":"4fa207ca-fffd-xxxx-xxxx-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}