文档中心>人脸核身>API 文档>其他接口>查询账单明细(微信渠道)

查询账单明细(微信渠道)

最近更新时间:2024-03-12 01:31:29

我的收藏

1. 接口描述

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

查询微信渠道服务(微信小程序、微信原生H5、微信普通H5)的账单明细及计费状态。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetWeChatBillDetails。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,本接口不需要传递此参数。
Date Date 拉取的日期(YYYY-MM-DD)。最大可追溯到365天前。当天6点后才能拉取前一天的数据。
Cursor Integer 游标。用于分页,取第一页时传0,取后续页面时,传入本接口响应中返回的NextCursor字段的值。
示例值:1
RuleId String 需要拉取账单详情业务对应的RuleId。不传会返回所有RuleId数据。默认为空字符串。

3. 输出参数

参数名称 类型 描述
HasNextPage Boolean 是否还有下一页。该字段为true时,需要将NextCursor的值作为入参Cursor继续调用本接口。
示例值:false
NextCursor Integer 下一页的游标。用于分页。
示例值:1
WeChatBillDetails Array of WeChatBillDetail 数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取第一页数据

获取第一页数据时,Cursor值传0。当HasNextPage的值为true时,继续调用接口。

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWeChatBillDetails
<公共请求参数>

{
    "Date": "2020-09-22",
    "Cursor": 0,
    "RuleId": "2"
}

输出示例

{
    "Response": {
        "NextCursor": 1873,
        "WeChatBillDetails": [
            {
                "ChargeCount": 1,
                "ChargeDetails": [
                    {
                        "ErrorMessage": "成功",
                        "Name": "**钱",
                        "Seq": "xxxxx-xxxxx-xxxxx-xxxxx",
                        "Idcard": "4************8",
                        "ErrorCode": 0,
                        "IsNeedCharge": true,
                        "ChargeType": "核身",
                        "ReqTime": "1638781186273",
                        "Sim": "100.00"
                    }
                ],
                "BizToken": "xxxxxxxx-xxxxxx-xxxxxx",
                "RuleId": "96"
            }
        ],
        "HasNextPage": true,
        "RequestId": "xxxxxx-xxxxxx-xxxxxxx"
    }
}

示例2 获取后续页面数据

获取后续页面数据时,将上一页返回的NextCursor值作为入参传入。当HasNextPage的值为false的时候,即可停止调用接口。

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWeChatBillDetails
<公共请求参数>

{
    "Date": "2020-09-22",
    "Cursor": 1873,
    "RuleId": "2"
}

输出示例

{
    "Response": {
        "NextCursor": 28888,
        "WeChatBillDetails": [
            {
                "ChargeCount": 1,
                "ChargeDetails": [
                    {
                        "ErrorMessage": "成功",
                        "Name": "**钱",
                        "Seq": "xxxxx-xxxxx-xxxxx-xxxxx",
                        "Idcard": "4************8",
                        "ErrorCode": 0,
                        "IsNeedCharge": true,
                        "ChargeType": "核身",
                        "ReqTime": "1638781186273",
                        "Sim": "100.00"
                    }
                ],
                "BizToken": "xxxxxxxx-xxxxxx-xxxxxx",
                "RuleId": "96"
            }
        ],
        "HasNextPage": false,
        "RequestId": "xxxxxx-xxxxxx-xxxxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue.RuleIdNotExist RuleId不存在,请到人脸核身控制台申请。