# 获取媒资列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：listMedia

该接口用于获取已上传到平台的媒资列表。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/sec/vod/listmedia?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：153

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "drama_id",
    "类型": "number",
    "必填": "否",
    "说明": "根据剧目id获取剧集信息"
  },
  {
    "参数名": "media_name",
    "类型": "string",
    "必填": "否",
    "说明": "媒资文件名，支持精确匹配、模糊匹配。文件太多时使用该参数进行模糊匹配可能无法得到结果，推荐使用 media_name_fuzzy 参数"
  },
  {
    "参数名": "media_name_fuzzy",
    "类型": "string",
    "必填": "否",
    "说明": "媒资文件名，模糊匹配"
  },
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "否",
    "说明": "媒资上传时间>=start_time"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "否",
    "说明": "媒资上传时间

### Res.media_info_list(Array) `Object Payload`

媒资信息列表

```json
[
  {
    "参数名": "media_id",
    "类型": "number",
    "说明": "媒资文件id"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "上传时间，时间戳"
  },
  {
    "参数名": "expire_time",
    "类型": "number",
    "说明": "过期时间，时间戳"
  },
  {
    "参数名": "drama_id",
    "类型": "number",
    "说明": "所属剧目id"
  },
  {
    "参数名": "file_size",
    "类型": "string",
    "说明": "媒资文件大小，单位：字节"
  },
  {
    "参数名": "duration",
    "类型": "number",
    "说明": "播放时长，单位：秒"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "媒资文件名"
  },
  {
    "参数名": "description",
    "类型": "string",
    "说明": "描述"
  },
  {
    "参数名": "cover_url",
    "类型": "string",
    "说明": "封面图临时链接"
  },
  {
    "参数名": "original_url",
    "类型": "string",
    "说明": "原始视频临时链接"
  },
  {
    "参数名": "mp4_url",
    "类型": "string",
    "说明": "mp4格式临时链接"
  },
  {
    "参数名": "hls_url",
    "类型": "string",
    "说明": "hls格式临时链接"
  },
  {
    "参数名": "audit_detail",
    "类型": "object",
    "说明": "审核信息"
  }
]
```

__audit_detail">

### Res.media_info_list(Array).audit_detail `Object Payload`

审核信息

```json
[
  {
    "参数名": "status",
    "类型": "number",
    "说明": "0为无效值；1为审核中；2为审核驳回；3为审核通过；4为驳回重填。需要注意可能存在单个剧集的状态为审核通过，但是剧目整体是未通过的情况，而能不能获取播放链接取决于剧目的审核状态"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "提审时间戳"
  },
  {
    "参数名": "audit_time",
    "类型": "number",
    "说明": "审核时间戳"
  },
  {
    "参数名": "reason",
    "类型": "string",
    "说明": "审核备注，该值可能为空"
  },
  {
    "参数名": "evidence_material_id_list",
    "类型": "array",
    "说明": "审核证据截图id列表，截图id可以用作[获取永久素材](/doc/service/api/material/permanent/api_getmaterial.md)接口的参数来获得截图内容"
  }
]
```

## 4. 注意事项

1. `Content-Type` 需要指定为 `application/json`。
2. 本接口返回的视频或图片链接均为临时链接，不应将其保存下来。
3. `media_name` 参数支持模糊匹配，当需要模糊匹配时可以在前面或后面加上 %，否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。文件太多时使用该参数进行模糊匹配可能无法得到结果，推荐使用 `media_name_fuzzy` 参数。
4. `media_name_fuzzy` 参数仅支持模糊匹配，不需要加 %。例如 "我的爸爸" 可以匹配到 "爸爸护我xxx", "xxxx之当个好爸爸", "xxxx首富爸爸"。

## 5. 代码示例

请求示例

```json
{
    "drama_id": 20001,
    "limit": 20
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "media_info_list": [
        {
            "media_id": 28918028,
            "create_time": 1682214878,
            "expire_time": 1689990878,
            "drama_id": 4907,
            "file_size": "9849163",
            "duration": 120,
            "name": "我的演艺 - 第1集",
            "description": "剧情非常精彩哦",
            "cover_url": "https://developers.weixin.qq.com/test.jpg",
            "original_url": "https://developers.weixin.qq.com/test.mp4",
            "mp4_url": "",
            "hls_url": "",
            "audit_detail": {
                "status": 3,
                "create_time": 1682215878,
                "audit_time": 1682235878,
                "reason": "",
                "evidence_material_id_list": [
                    "ivpvxwtX5GNzkCi6aX12f_VIFmGKiiwW5fkbISkZcamr6g_XrWqHkxB22MMAmIShb6rKOrS7"
                ]
            }
        }
    ]
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-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. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。