1. 接口描述
本接口(QueryClientInfos)用于查询指定代理商名下所有客户的信息,包括客户账号 ID、备注、认证类型、客户类型、名称、是否欠费、关联时间等信息。
接口请求域名:partners.api.qcloud.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 QueryClientInfos。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
clientUins | 否 | array | 客户 uin 列表 |
hasOverdueBill | 否 | int | 是否欠费。0:不欠费;1:欠费 |
flag | 否 | string | 客户类型:a,b,c |
clientRemark | 否 | string | 客户备注 |
order | 否 | Int | 按关联时间排序,排序方向,0:降序;1:升序 |
page | 否 | Int | 分页号,从 1 开始 |
rows | 否 | Int | 页码大小,最大值为 1000 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
codeDesc | String | 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。 |
message | String | 模块错误信息描述,与接口相关。 |
data | Array | 输出结果,包含查询到的所有定时任务列表信息。 |
其中,data 参数的构成如下:
参数名称 | 类型 | 描述 |
---|---|---|
totalCount | Int | 查询到的客户总数量 |
agentClients | Array | 指定分页的客户集合 |
其中,每个客户的基本信息如下:
客户账号 ID、备注、认证类型、客户类型、名称、是否欠费、关联时间
参数名称 | 类型 | 描述 |
---|---|---|
clientUin | String | 客户账号 ID |
clientRemark | String | 备注 |
authType | Int | 认证类型,0:个人,1:企业;其他:未认证 |
flag | String | 客户类型,a,b,c |
userName | String | 名称 |
hasOverdueBill | Int | 是否欠费,0:不欠费;1:欠费 |
agentTime | String | 关联时间,时间戳 |
appid | String | 客户 appid |
clientType | String | 客户类型(new:新拓;old:存量;assign:指派) |
projectType | String | 项目类型(self:自拓;repeat:直销;platform:官网合作) |
4. 示例
https://partners.api.qcloud.com/v2/index.php?
&<公共请求参数>
&page=0&rows=1
返回示例如下:
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"agentClients": [
{
"clientUin": "1874*****1",
"clientRemark": "",
"authType": "-1",
"flag": "c",
"userName": "",
"agentTime": "4294967295",
"appid": "0",
"lastMonthAmt": 0,
"thisMonthAmt": 0,
"hasOverdueBill": 0,
"clientType": "assign",
"projectType": ""
}
],
"totalCount": "23"
}
}