# 查询流量包详情
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。
接口英文名：listPackages
该接口用于查询流量包的使用详情
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/sec/vod/listpackages?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：153
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| status | number | 是 | 按流量包状态过滤，取值有：0-不过滤，1-有效的，2-无效的，3-过期的 |
| offset | number | 是 | 偏移值，分页请求用 |
| limit | number | 是 | 分页大小，最大值为100 |
| query_type | number | 否 | 查询类型，0：通用流量；1：定向流量。默认值为0 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | - | 错误码 |
| errmsg | string | ok | 错误信息 |
| total_count | number | - | 当前查询条件下的流量包总数 |
| package_list | objarray | - | 流量包详情列表 |
# Res.package_list(Array) Object Payload
流量包详情列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| start_time | number | 有效期起始时间 |
| end_time | number | 有效期截止时间 |
| used | number | 流量包已消耗流量的数值（MB） |
| all | number | 流量包总额（MB），剩余流量=流量包总额-已消耗流量 |
| order_id | string | 订单号 |
| status | number | 流量包状态，参考请求参数status中的说明 |
| is_deleted | number | 是否已删除（失效），例如已退款 |
| package_id | string | 流量包编号 |
# 4. 注意事项
- 流量包单位为MB，流量进制换算规则：1GB=1000MB
- 剩余可用流量为有效的(status=1)流量包的余额之和。
- 流量包是存在有效期限制的，需要注意流量包是否即将过期
# 5. 代码示例
请求示例
{
"status": 1,
"limit": 100
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"package_list": [{
"all": 100000,
"end_time": 1715234665,
"is_deleted": 0,
"order_id": 2921020570379436032,
"package_id": "ZY2921020620526534656",
"start_time": 1683698665,
"status": 1,
"used": 188
},
{
"all": 10000,
"end_time": 1715151889,
"is_deleted": 0,
"order_id": 2919631279891890176,
"package_id": "ZY2919631860383563776",
"start_time": 1683615889,
"status": 1,
"used": 10000
}
],
"total_count": 2
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -2 | 初始化未完成，请稍后再试 |
| -1 | 系统错误 |
| 43002 | HTTP请求必须使用POST方法 |
| 44002 | POST内容为空 |
| 47001 | 输入格式错误 |
| 47003 | 参数不符合要求 |
| 10090001 | 视频类型不支持 |
| 10090002 | 图片类型不支持 |
| 10090003 | 图片URL无效 |
| 10090005 | resource_type无效 |
| 10090038 | 被授权账号没有【文娱-微短剧】类目 |
| 10090039 | 已经被解除授权 |
| 10090040 | 剧集已经被占用 |
| 10090041 | 剧目名称不符合规范 |
| 10090042 | 剧集名称不符合规范 |
| 10090043 | 不存在授权关系 |
| 10093011 | 操作失败 |
| 10093014 | 参数错误（包括参数格式、类型等错误） |
| 10093023 | 操作过于频繁 |
| 10093030 | 资源不存在 |
# 7. 适用范围
本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请已实际调用情况为准。