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

1. 接口描述

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

为合作伙伴提供查询客户余额能力。调用者必须是合作伙伴,只能查询自己名下客户余额

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClientBalanceNew。
Version String 公共参数,本接口取值:2018-03-21。
Region String 公共参数,此参数为可选参数。
ClientUin String 客户(代客)账号ID
示例值:125****938

3. 输出参数

参数名称 类型 描述
Balance Integer 账户可用余额,单位分 (可用余额 = 现金余额 + 赠送金余额 - 欠费金额 - 冻结金额)
示例值:40
Cash Integer 账户现金余额,单位分
示例值:40
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询客户余额

输入示例

https://partners.tencentcloudapi.com/?Action=DescribeClientBalanceNew
&ClientUin=125****938
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "eeedc7d9-2310-4b77-bd3e-23f077e44b7d",
        "Balance": 40,
        "Cash": 40
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。