有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

查询码包列表

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCodePacks。
Version String 公共参数,本接口取值:2021-05-15。
Region String 公共参数,本接口不需要传递此参数。
PageSize Integer 每页数量
示例值:7999
PageNumber Integer 页数
示例值:7999
Keyword String 查询关键字
示例值:安心
CorpId Integer 企业ID
示例值:10000
SerialType Integer 是否有流水码 0:无 1:有
示例值:number
ResType String 资源类型 batch:批次, order_in 入库, order_out: 出入
ResId String 资源ID ResType是 batch 时对应是批次ID, 是 order_in, order_out时,则是订单ID

3. 输出参数

参数名称 类型 描述
CodePacks Array of CodePack 码列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:131
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询码包列表

输入示例

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

{
    "Keyword": "",
    "PageSize": 10,
    "PageNumber": 1
}

输出示例

{
    "Response": {
        "CodePacks": [
            {
                "PackId": "abc",
                "CorpId": 0,
                "MerchantId": "abc",
                "CreateTime": "abc",
                "UpdateTime": "abc",
                "Status": "abc",
                "Log": "abc",
                "CreateUser": "abc",
                "Amount": 0,
                "CodeLength": 0,
                "CodeType": "abc",
                "Cipher": 0,
                "TextUrl": "abc",
                "PackUrl": "abc",
                "MerchantName": "abc",
                "RuleType": 0,
                "CustomId": "abc",
                "PackType": 0,
                "PackLevel": 1,
                "PackSpec": [
                    {
                        "Level": 1,
                        "Rate": 1,
                        "Amount": 1,
                        "CustomId": "abc",
                        "CodeParts": [
                            {
                                "Name": "abc",
                                "Type": "abc",
                                "Value": "abc",
                                "Length": 1,
                                "Ext": "abc"
                            }
                        ]
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InvalidParameter 参数错误。