有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: partners.tencentcloudapi.com 。

代理商可查询自己名下待审核客户列表

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAgentClients。
Version String 公共参数,本接口取值:2018-03-21。
Region String 公共参数,此参数为可选参数。
ClientUin String 客户账号ID
ClientName String 客户名称。由于涉及隐私,名称打码显示,故名称仅支持打码后的模糊搜索
ClientFlag String 客户类型,a/b,类型定义参考代理商相关政策文档
OrderDirection String ASC/DESC, 不区分大小写,按申请时间排序
Offset Integer 偏移量
示例值:0
Limit Integer 限制数目
示例值:1
SalesUin String 业务员ID
SalesName String 业务员姓名(模糊查询)

3. 输出参数

参数名称 类型 描述
AgentClientSet Array of AgentClientElem 待审核代客列表
TotalCount Integer 符合条件的代客总数
示例值:20
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

请求一个代理商名下代客,只取1个(Limit参数)

输入示例

https://partners.tencentcloudapi.com/?Action=DescribeAgentClients
&Offset=0
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "AgentClientSet": [
            {
                "Status": 1,
                "SalesName": "xx",
                "ClientUin": "xx",
                "ClientFlag": "xx",
                "SalesUin": "xx",
                "Phone": "xx",
                "ApplyTime": 1,
                "Uin": "xx",
                "HasOverdueBill": 1,
                "Mail": "xx",
                "ClientName": "xx"
            }
        ],
        "TotalCount": 1,
        "RequestId": "xx"
    }
}

示例2 失败示例

请求参数不正确导致返回错误

输入示例

https://partners.tencentcloudapi.com/?Action=DescribeAgentClients
&Offset=0
&Limit=0
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "Error": {
            "Code": "InvalidParameter",
            "Message": "Limit:0 is not int!"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。