# 获取媒资列表

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:listMedia

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

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

  • 该接口所属的权限集 id 为:153

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
drama_id number根据剧目id获取剧集信息
media_namestring媒资文件名,支持精确匹配、模糊匹配。文件太多时使用该参数进行模糊匹配可能无法得到结果,推荐使用 media_name_fuzzy 参数
media_name_fuzzystring媒资文件名,模糊匹配
start_timenumber媒资上传时间>=start_time
end_timenumber媒资上传时间
limitnumber分页拉取的最大返回结果数。最大值:100
offsetnumber分页拉取的起始偏移量

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
media_info_listobjarray媒资信息列表

# Res.media_info_list(Array) Object Payload

媒资信息列表

参数名类型说明
media_idnumber媒资文件id
create_timenumber上传时间,时间戳
expire_timenumber过期时间,时间戳
drama_idnumber所属剧目id
file_sizestring媒资文件大小,单位:字节
durationnumber播放时长,单位:秒
namestring媒资文件名
descriptionstring描述
cover_urlstring封面图临时链接
original_urlstring原始视频临时链接
mp4_urlstringmp4格式临时链接
hls_urlstringhls格式临时链接
audit_detailobject审核信息

# Res.media_info_list(Array).audit_detail Object Payload

审核信息

参数名类型说明
statusnumber0为无效值;1为审核中;2为审核驳回;3为审核通过;4为驳回重填。需要注意可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,而能不能获取播放链接取决于剧目的审核状态
create_timenumber提审时间戳
audit_timenumber审核时间戳
reasonstring审核备注,该值可能为空
evidence_material_id_listarray审核证据截图id列表,截图id可以用作获取永久素材接口的参数来获得截图内容

# 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. 代码示例

请求示例

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

返回示例

{
    "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. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
-2初始化未完成,请稍后再试
-1系统错误
43002HTTP请求必须使用POST方法
44002POST内容为空
47001输入格式错误
47003参数不符合要求
10090001视频类型不支持
10090002图片类型不支持
10090003图片URL无效
10090005resource_type无效
10090038被授权账号没有【文娱-微短剧】类目
10090039已经被解除授权
10090040剧集已经被占用
10090041剧目名称不符合规范
10090042剧集名称不符合规范
10090043不存在授权关系
10093011操作失败
10093014参数错误(包括参数格式、类型等错误)
10093023操作过于频繁
10093030资源不存在

# 7. 适用范围

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