# 接入说明

小程序需申请【文娱-微短剧】类目，审核通过后会自动开通以下 API 调用权限。

# 1.媒资上传

上传时需要注意以下事项：

首次上传要初始化资源，需要一定时间，在初始化期间上传都会返回失败（错误码为 -2），等待一段时间（一般为几分钟）后重试即可。
需按照“剧目名 - 对应剧集数”格式命名文件（如：“我的演艺 - 第1集”）。
视频格式支持：MP4，TS，MOV，MXF，MPG，FLV，WMV，AVI，M4V，F4V，MPEG，3GP，ASF，MKV。如需上传 m3u8 视频，请使用"拉取上传"接口。
图片格式支持：JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF。
如果接口返回 HTTP 状态码 502，请检查上传的文件是否超过了特定接口所限制的大小。

# 1.1.单个文件上传

上传媒体（和封面）文件，上传小文件（小于10MB）时使用。上传大文件请使用分片上传接口。

# 注意事项

不填写 cover_type，cover_data 字段时默认截取视频首帧作为封面图。
Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>
<箭头括号> 表示必须替换为有效值的变量。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_name	string	是	文件名，需按照“剧目名 - 对应剧集数”格式命名文件，示例值：`"我的演艺 - 第1集"`。
media_type	string	是	视频格式，支持：MP4，TS，MOV，MXF，MPG，FLV，WMV，AVI，M4V，F4V，MPEG，3GP，ASF，MKV，示例值：`"MP4"`。
media_data	binary	是	视频文件内容，二进制。
cover_type	string	否	视频封面图格式，支持：JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF，示例值：`"JPG"`。
cover_data	binary	否	视频封面图文件内容，二进制。
source_context	string	否	来源上下文，会在上传完成事件中透传给开发者。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
media_id	number	媒体文件id。

# 调用示例

# 请求数据示例

POST /wxa/sec/vod/singlefileupload?access_token=ACCESS_TOKEN HTTP/1.1
Host: api.weixin.qq.com
Content-Type: multipart/form-data; boundary=--------------------------334603653359572775563544
Content-Length: 1675021

----------------------------334603653359572775563544
Content-Disposition: form-data; name="media_name"

我的演艺 - 第1集
----------------------------334603653359572775563544
Content-Disposition: form-data; name="media_type"

MP4
----------------------------334603653359572775563544
Content-Disposition: form-data; name="cover_type"

JPEG
----------------------------334603653359572775563544
Content-Disposition: form-data; name="media_data"; filename="test.mp4"

<test.mp4>
----------------------------334603653359572775563544
Content-Disposition: form-data; name="cover_data"; filename="wechat.jpeg"

<wechat.jpeg>
----------------------------334603653359572775563544--

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "media_id": 123456
}

# 1.2.拉取上传

该接口用于将一个网络上的视频拉取上传到平台。

# 注意事项

不填写 cover_url 字段时默认截取视频首帧作为封面图。
Content-Type 需要指定为 application/json
该接口为异步接口，上传完成会推送上传完成事件到开发者服务器，开发者也可以调用"查询任务"接口来轮询上传结果。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_name	string	是	文件名，需按照“剧目名 - 对应剧集数”格式命名文件，示例值：`"我的演艺 - 第1集"`。
media_url	string	是	视频 URL，示例值：`"https://developers.weixin.qq.com/test.mp4"`。
cover_url	string	否	封面图URL，示例值：`"https://developers.weixin.qq.com/test.jpg"`
source_context	string	否	来源上下文，会在上传完成事件中透传给开发者。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
task_id	number	拉取上传任务id。

# 调用示例

# 请求数据示例

{
    "media_url": "https://developers.weixin.qq.com/test.mp4",
    "cover_url": "https://developers.weixin.qq.com/test.jpg",
    "media_name": "我的演艺 - 第1集"
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "task_id": 123456
}

# 1.3.查询任务

该接口用于查询拉取上传的任务状态。

# 注意事项

Content-Type 需要指定为 application/json。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
task_id	number	是	任务id。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
task_info	TaskInfo	任务信息。

TaskInfo

属性	类型	说明
id	number	任务id。
task_type	number	任务类型枚举值：1. 拉取上传任务。
status	number	任务状态枚举值：1. 等待中；2. 正在处理；3. 已完成；4. 失败。
errcode	number	任务错误码，0表示成功，其它表示失败。
errmsg	string	任务错误原因。
create_time	number	创建时间，时间戳。
finish_time	number	完成时间，时间戳。
media_id	number	媒体文件id。

# 调用示例

# 请求数据示例

{
    "task_id": 8412368
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "task_info": {
        "id": 8412368,
        "task_type": 1,
        "status": 3,
        "errcode": 0,
        "errmsg": "",
        "create_time": 1682214878,
        "finish_time": 1682214907,
        "media_id": 28918028
    }
}

# 1.4.申请分片上传

上传大文件时需使用分片上传方式，分为 3 个步骤：

申请分片上传，确定文件名、格式类型，返回 upload_id，唯一标识本次分片上传。
上传分片，多次调用上传文件分片，需要携带 part_number 和 upload_id，其中 part_number 为分片的编号，支持乱序上传。当传入 part_number 和 upload_id 都相同的时候，后发起上传请求的分片将覆盖之前的分片。
确认分片上传，当上传完所有分片后，需要完成整个文件的合并。请求体中需要给出每一个分片的 part_number 和 etag，用来校验分片的准确性，最后返回文件的 media_id。

# 注意事项

如果填写了 cover_type，表明本次分片上传除上传媒体文件外还需要上传封面图片，不填写 cover_type 则默认截取视频首帧作为封面图片。
Content-Type 需要指定为 application/json

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_name	string	是	文件名，需按照“剧目名 - 对应剧集数”格式命名文件，示例值：`"我的演艺 - 第1集"`。
media_type	string	是	视频格式，支持：MP4，TS，MOV，MXF，MPG，FLV，WMV，AVI，M4V，F4V，MPEG，3GP，ASF，MKV，示例值：`"MP4"`。
cover_type	string	否	封面图图片格式，支持：JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF，示例值：`"JPG"`。
source_context	string	否	来源上下文，会在上传完成事件中透传给开发者。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
upload_id	string	本次分片上传的唯一标识。

# 调用示例

# 请求数据示例

{
    "media_type": "MP4",
    "cover_type": "JPG",
    "media_name": "我的演艺 - 第1集"
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "upload_id": "123456"
}

# 1.5.上传分片

将文件的其中一个分片上传到平台，最多支持100个分片，每个分片大小为5MB，最后一个分片可以小于5MB。该接口适用于视频和封面图片。视频最大支持500MB，封面图片最大支持10MB。

# 注意事项

调用该接口之前必须先调用申请分片上传接口。
在申请分片上传时，如果不填写 cover_type，则默认截取视频首帧作为封面图。
Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>，<箭头括号>表示必须替换为有效值的变量。
part_number 从 1 开始。如除了上传视频外还需要上传封面图，则封面图的 part_number 需重新从 1 开始编号。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
upload_id	string	是	一次分片上传的唯一标识，由申请分片上传接口返回。
part_number	number	是	本次上传的分片的编号，范围在 1 - 100。
resource_type	number	是	指定该分片属于视频还是图片的枚举值：1. 视频，2. 图片。
data	binary	是	文件内容分片，二进制。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
etag	string	根据分片内容生成的标识。

# 调用示例

# 请求数据示例

POST /wxa/sec/vod/uploadpart?access_token=ACCESS_TOKEN HTTP/1.1
Host: api.weixin.qq.com
Content-Type: multipart/form-data; boundary=--------------------------334603653359572775563544
Content-Length: 5347737

----------------------------334603653359572775563544
Content-Disposition: form-data; name="upload_id"

9457878
----------------------------334603653359572775563544
Content-Disposition: form-data; name="part_number"

1
----------------------------334603653359572775563544
Content-Disposition: form-data; name="resource_type"

1
----------------------------334603653359572775563544
Content-Disposition: form-data; name="data"; filename="test.mp4"

<test.mp4>
----------------------------334603653359572775563544--

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "etag": "\"d899fbd1e06109ea2e4550f5751c88d6\""
}

# 1.6.确认上传

该接口用于完成整个分片上传流程，合并所有文件分片，确认媒体文件（和封面图片文件）上传到平台的结果，返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag，用来校验分片的准确性。

# 注意事项

Content-Type 需要指定为 application/json。
调用该接口之前必须先调用申请分片上传接口以及上传分片接口。
如本次分片上传除上传媒体文件外还需要上传封面图片，则请求中还需提供 cover_part_infos 字段以用于合并封面图片文件分片。
请求中 media_part_infos 和 cover_part_infos 字段必须按 part_number 从小到大排序，part_number 必须从 1 开始，连续且不重复。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
upload_id	string	是	一次分片上传的唯一标识，由申请分片上传接口返回。
media_part_infos	array<PartInfo>	是	本次分片上传中媒体文件每个分片的信息。
cover_part_infos	array<PartInfo>	否	本次分片上传中封面图片文件每个分片的信息。

PartInfo

属性	类型	必填	说明
part_number	number	是	分片编号。
etag	string	是	使用上传分片接口上传成功后返回的 `etag` 的值

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
media_id	number	媒体文件id。

# 调用示例

# 请求数据示例

{
    "upload_id": "abcdefg12345",
    "media_part_infos": [
        {
            "part_number": 1,
            "etag": "\"d899fbd1e06109ea2e4550f5751c88d6\""
        },
        {
            "part_number": 2,
            "etag": "\"jfb9892jfnhda2e4550f5bvhju9392af\""
        },
        {
            "part_number": 3,
            "etag": "\"bifh9u92wjefvjhytvn9u2898ef9uhea\""
        }
    ]
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "media_id": 123456
}

# 2.媒资管理

# 2.1.获取媒资列表

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

# 注意事项

Content-Type 需要指定为 application/json。
本接口返回的视频或图片链接均为临时链接，不应将其保存下来。
media_name 参数支持模糊匹配，当需要模糊匹配时可以在前面或后面加上 %，否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	否	根据剧目id获取剧集信息。
media_name	string	否	媒资文件名，模糊匹配。
start_time	number	否	媒资上传时间>=start_time。
end_time	number	否	媒资上传时间<end_time。
limit	number	否	分页拉取的最大返回结果数。默认值：100；最大值：100。
offset	number	否	分页拉取的起始偏移量。默认值：0。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
media_info_list	array<MediaInfo>	媒资信息列表。

MediaInfo

属性	类型	说明
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	MediaAuditDetail	审核信息。

MediaAuditDetail

属性	类型	说明
status	number	0为无效值；1为审核中；2为审核驳回；3为审核通过；4为驳回重填。需要注意可能存在单个剧集的状态为审核通过，但是剧目整体是未通过的情况，而能不能获取播放链接取决于剧目的审核状态。
create_time	number	提审时间戳。
audit_time	number	审核时间戳。
reason	string	审核备注。该值可能为空。
evidence_material_id_list	array<string>	审核证据截图id列表，截图id可以用作get_material接口的参数来获得截图内容。

# 调用示例

# 请求数据示例

{
    "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"
                ]
            }
        }
    ]
}

# 2.2.获取媒资详细信息

该接口用于获取已上传到平台的指定媒资信息，用于开发者后台管理使用。用于给用户客户端播放的链接应该使用getmedialink接口获取。

# 注意事项

Content-Type 需要指定为 application/json。
本接口返回的视频或图片链接均为临时链接，不应将其保存下来。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_id	number	是	媒资文件id。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
media_info	MediaInfo	媒体文件id。

MediaInfo

定义和 2.1 获取媒资列表接口中的 MediaInfo 相同。

# 调用示例

# 请求数据示例

{
    "media_id": 28918028
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "media_info": {
        "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"
            ]
        }
    }
}

# 2.3.获取媒资播放链接

该接口用于获取视频临时播放链接，用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。

# 注意事项

Content-Type 需要指定为 application/json。
本接口返回的视频或图片链接均为临时链接，不应将其保存下来。
能不能获取播放链接取决于剧目审核状态，可能存在单个剧集的状态为审核通过，但是剧目整体是未通过的情况，这种情况也没法获取播放链接。
开发者如需区分不同渠道的播放流量或次数，可以在us参数中传入渠道标识，这样得到的播放链接中us参数的前半部分就包含有渠道标识。开发者把这个带有渠道标识的链接分发给对应的渠道播放，就能统计到不同渠道播放情况。统计的数据来源为CDN日志（从getcdnlogs接口得到），CDN日志中“文件路径”列中的参数也带有该标识，再结合日志中“字节数”列的流量数值，估算每个渠道所消耗的流量。另需注意日志统计的流量和扣费流量的差异，详情参考getcdnlogs接口中的注意事项。
平台可能使用多个域名分发，不要假定播放链接的域名是固定的。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_id	number	是	媒资文件id。
t	number	是	播放地址的过期时间戳。有效的时间最长不能超过2小时后。
us	string	否	链接标识。平台默认会生成一个仅包含小写字母和数字的字符串用于增强链接的唯一性(如us=647488c4792c15185b8fd2a6)。如开发者需要增加自己的标识，比如区分播放的渠道，可使用该参数，该参数最终的值是"开发者标识-平台标识"（如开发者传入abcd，则最终的临时链接中us=abcd-647488c4792c15185b8fd2a6）
exper	number	否	试看时长，单位：秒，最大值不能超过视频长度
rlimit	number	否	最多允许多少个不同 IP 的终端播放，以十进制表示，最大值为9，不填表示不做限制。当限制 URL 只能被1个人播放时，建议 rlimit 不要严格限制成1（例如可设置为3），因为移动端断网后重连 IP 可能改变。
whref	string	否	允许访问的域名列表，支持1条 - 10条，用半角逗号分隔。域名前不要带协议名（http://和https://），域名为前缀匹配（如填写 abc.com，则 abc.com/123 和 abc.com.cn也会匹配），且支持通配符（如 *.abc.com）。
bkref	string	否	禁止访问的域名列表，支持1条 - 10条，用半角逗号分隔。域名前不要带协议名（http://和https://），域名为前缀匹配（如填写 abc.com，则 abc.com/123 和 abc.com.cn也会匹配），且支持通配符（如 *.abc.com）。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
media_info	MediaPlaybackInfo	媒体播放信息。

MediaPlaybackInfo

属性	类型	说明
media_id	number	媒资文件id。
duration	number	播放时长，单位：秒。
name	string	媒资文件名。
description	string	描述。
cover_url	string	封面图临时链接。
mp4_url	string	mp4格式临时链接。
hls_url	string	hls格式临时链接。

# 调用示例

# 请求数据示例

{
    "media_id": 28918028,
    "t": 1689990878
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "media_info": {
        "media_id": 28918028,
        "duration": 120,
        "name": "我的演艺 - 第1集",
        "description": "剧情非常精彩哦",
        "cover_url": "https://developers.weixin.qq.com/test.jpg",
        "mp4_url": "https://developers.weixin.qq.com/test-encode.mp4?t=64bb36de&us=647488c4792c15185b8fd2a6&sign=631355adf06a6cf7e45e29be17c66820",
        "hls_url": "https://developers.weixin.qq.com/test-encode.m3u8?t=64bb36de&us=647488c4792c15185b8fd2a6&sign=631355adf06a6cf7e45e29be17c66820"
    }
}

# 2.4.删除媒资

该接口用于删除指定媒资。

# 注意事项

Content-Type 需要指定为 application/json。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
media_id	number	是	媒资文件id。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "media_id": 28918028
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 3.剧目管理

# 3.1.剧目提审

剧目提交审核

# 注意事项

Content-Type 需要指定为 application/json。
剧目信息与审核材料在首次提审时为必填，重新提审时根据是否需要修改选填，
本接口中使用的临时图片material_id可通过新增临时素材接口上传得到，对应临时素材接口中的media_id，本文档中为避免与剧集的media_id混淆，称其为material_id。
新增临时素材接口可以被小程序调用，调用的小程序账号和剧目提审的小程序账号必须是同一个，否则提交审核时会无法识别素材id。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数auditdrama

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id，首次提审不需要填该参数，重新提审时必填
name	string	是	剧名，首次提审时必填，重新提审时根据是否需要修改选填。
media_count	number	是	剧集数目。首次提审时必填，重新提审时可不填，如要填写也要和第一次提审时一样。
media_id_list	array<number>	是	剧集媒资media_id列表。首次提审时必填，而且元素个数必须与media_count一致。重新提审时为可选，如果剧集有内容有变化，可以通过新的列表替换未通过的剧集（推荐使用replace_media_list进行替换，避免顺序和原列表不一致）。
producer	string	是	制作方。首次提审时必填，重新提审时根据是否需要修改选填。
cover_material_id	string	是	剧目海报临时media_id。首次提审时必填，重新提审时根据是否需要修改选填。
authorized_material_id	string	是	权利声明/播放授权材料material_id。需上传《权利声明及不侵权承诺函》注：⑴剧目制作方/版权方与账号主体一致时，请上传附件1（需签章）； ⑵剧目制作方/版权方与账号主体不一致时，请上传附件2或完整的播放授权材料（需签章）。
registration_number	string	否	剧目备案号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
publish_license	string	否	网络剧片发行许可证编号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
publish_license_material_id	string	否	网络剧片发行许可证图片，首次提审时如果网络剧片发行许可证编号非空，则该改字段也非空。重新提审时根据是否变化选填
expedited	number	否	填1表示审核加急，0或不填为不加急。每天有5次加急机会。该字段在首次提审时才有效，重新提审时会沿用首次提审时的属性，重新提审不会扣次数。最终是否为加急单，可以根据DramaInfo.expedited属性判断
replace_media_list	array<ReplaceInfo>	否	用于重新提审时替换审核不通过的剧集。
recommendations	string	否	剧目推荐语，可填写30个字符。
description	string	是	剧目简介，可填写200个字符。
promotion_poster_material_id	string	否	推广海报临时media_id。
actor_list	ActorInfoList	是	演员信息，需填写2-5位演员。

ReplaceInfo

属性	类型	说明
old	number	旧的剧集media_id
new	number	新的剧集media_id

ActorInfoList

属性	类型	说明
actor	array<ActorInfo>	演员列表

ActorInfo

属性	类型	说明
name	string	演员姓名，格式要求：可填写30个字符，支持输入中文、英文和·
photo_material_id	string	演员照片临时media_id
role	string	饰演角色，格式要求：可填写30个字符，支持输入中文、英文及，。；”“？、—《》！（）-·
profile	string	演员简介，填写内容可参考：生日、星座、籍贯、身高、毕业院校、历史/代表作品、获奖信息、成就等(以上要素需至少满足3项或涵盖任一要素且不少于20字）。格式要求：可填写100个字符，支持输入中文、英文、阿拉伯数字及，。：；“”？、—《》！（）-·

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
drama_id	number	剧目id。

# 调用示例

# 首次提审请求数据示例

{
    "name": "这是剧名",
    "media_count": 2,
    "media_id_list": [20001, 20002],
    "producer": "制作方名",
    "description": "很有意思的一部剧",
    "cover_material_id": "xxxxxxxxxx",
    "registration_number": "012345678901234",
    "authorized_material_id": "122344",
    "recommendations": "这是这部剧的推荐语。",
    "actor_list": {
        "actor": [{
            "name": "演员1",
            "photo_material_id": "xxxxxxxx",
            "role": "角色1",
            "profile": "简介"
        }, {
            "name": "演员2",
            "photo_material_id": "xxxxxxxx",
            "role": "角色2",
            "profile": "简介"
        }]
    }
}

# 重新提审请求数据示例

{
    "drama_id": 10001,
    "replace_media_list": [
        {
            "old": 20001,
            "new": 20021
        },
        {
            "old": 20002,
            "new": 20022
        }
    ]
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "drama_id": 10001
}

# 3.2.获取剧目列表

该接口用于获取已提交的剧目列表。

# 注意事项

Content-Type 需要指定为 application/json。
本接口返回的图片链接均为临时链接，不应将其保存下来。
如果剧目审核结果为失败或驳回，则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
limit	number	否	分页拉取的最大返回结果数。默认值：100；最大值：100。
offset	number	否	分页拉取的起始偏移量。默认值：0。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
drama_info_list	array<DramaInfo>	媒体文件id。

DramaInfo

属性	类型	说明
drama_id	number	剧目id。
create_time	number	创建时间，时间戳。
name	string	剧名。
cover_url	string	剧目海报链接，根据提审时提交的cover_material_id转存得到。
media_count	number	剧集数目。
producer	string	制作方。
playwright	string	编剧。
description	string	剧目简介。
production_license	string	广播电视节目制作经营许可证。
audit_detail	DramaAuditDetail	审核状态。
media_list	array<DramaMediaInfo>	剧集信息列表。
expedited	number	1表示审核加急，0或空为非加急审核
recommendations	string	剧目推荐语。
promotion_poster	string	推广海报。
actor_list	ActorInfoList	演员信息。

DramaMediaInfo

属性	类型	说明
media_id	number	媒资文件id。

DramaAuditDetail

属性	类型	说明
status	number	0为无效值；1为审核中；2为最终失败；3为审核通过；4为驳回重填
audit_type	number	事件通知接口才返回：0为首次提审；1为再次提审；2为替换剧集提审
create_time	number	提审时间戳。
audit_time	number	审核时间戳。

# 调用示例

# 请求数据示例

{
    "offset": 0,
    "limit": 10
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "drama_info_list": [
        {
            "drama_id": 28918028,
            "create_time": 1682214878,
            "name": "我的演艺",
            "playwright": "编剧名",
            "producer": "制作方名",
            "production_license": "abd123",
            "cover_url": "https://developers.weixin.qq.com/test.jpg",
            "media_count": 2,
            "media_list":[
                {"media_id": 10001},
                {"media_id": 10002}
            ],
            "audit_detail": {
                "status": 3,
                "create_time": 1682215878,
                "audit_time": 1682235878
            }
        }
    ]
}

# 3.3.获取剧目信息

该接口用于查询已提交的剧目。

# 注意事项

Content-Type 需要指定为 application/json。
本接口返回的图片链接均为临时链接，不应将其保存下来。
如果剧目审核结果为失败或驳回，则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
drama_info	DramaInfo	剧目信息。

DramaInfo

定义和 3.2 获取剧目列表接口中的 DramaInfo 相同。

# 调用示例

# 请求数据示例

{
    "drama_id": 10001
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "drama_info": {
        "drama_id": 28918028,
        "create_time": 1682214878,
        "name": "我的演艺",
        "playwright": "编剧名",
        "producer": "制作方名",
        "production_license": "abd123",
        "cover_url": "https://developers.weixin.qq.com/test.jpg",
        "media_count": 2,
        "recommendations": "这是这部剧的推荐语。",
        "description": "剧目的简介。",
        "promotion_poster": "xxxxxxxxx",
        "media_list":[
            {"media_id": 10001},
            {"media_id": 10002}
        ],
        "audit_detail": {
            "status": 3,
            "create_time": 1682215878,
            "audit_time": 1682235878
        },
        "actor_list": {
            "actor": [{
                "name": "演员1",
                "photo_material_id": "xxxxxxxx",
                "role": "角色1",
                "profile": "简介"
            }, {
                "name": "演员2",
                "photo_material_id": "xxxxxxxx",
                "role": "角色2",
                "profile": "简介"
            }]
        }
    }
}

# 3.4.提交替换剧集审核

该接口用于提交剧目替换剧集审核。待审核通过后7天内可使用替换审核通过的剧集接口（replacedramamedia）正式替换剧目中的相应的剧集，之后可以使用新的media_id播放。如7天内没有使用replacedramamedia进行剧集替换，则之后无法再发起替换。

# 注意事项

Content-Type 需要指定为 application/json。
剧目必须审核通过后才允许提交替换剧集审核。
审核完成后会发送事件通知

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id
replace_media_list	array	是	替换的剧集信息。[ReplaceInfo]

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "drama_id": 10001,
    "replace_media_list": [
        {
            "old": 20001,
            "new": 20021
        },
        {
            "old": 20002,
            "new": 20022
        }
    ]
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 3.5.替换审核通过的剧集

该接口用于替换剧目审核通过的剧集。替换后可使用新的media_id获取播放链接，替换后旧media_id的播放链接不会马上失效，并且在7天内依然可以获取播放链接。为避免影响业务，调用该接口成功后，请及时替换获取播放链接时使用的media_id。

# 注意事项

Content-Type 需要指定为 application/json。
剧目必须审核通过，而且新剧集必须审核通过后才允许替换。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id
old_media_id	number	是	旧剧集meida_id
new_media_id	number	是	新剧集meida_id

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "drama_id": 10001,
    "old_media_id": 20001,
    "new_media_id": 20021
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 3.6.修改剧目基本信息

该接口用于修改剧目基本信息。请求成功后，需要经过审核，审核通过后，最终才会修改基本信息。审核完成后，会下发通知。

# 注意事项

剧目必须已经审核通过。
审核完成后会发送[事件通知]

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id
description	string	否	剧目简介，支持填写200个字符。
cover_material_id	string	否	剧目海报临时media_id。
recommendations	string	否	剧目推荐语。
promotion_poster_material_id	string	否	推广海报临时media_id。
alternate_name	string	否	备用剧名。
actor_list	ActorInfoList	否	演员信息。如果需要修改，请填写所有的演员信息。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "drama_id": 10001,
    "description": "新剧目简介",
    "cover_material_id": "新剧目海报临时media_id",
    "recommendations": "新剧目推荐语",
    "promotion_poster_material_id": "新推广海报临时media_id",
    "alternate_name": "备用剧名",
    "actor_list": {
        "actor": [{
            "name": "演员1",
            "photo_material_id": "xxxxxxxx",
            "role": "角色1",
            "profile": "简介"
        }, {
            "name": "演员2",
            "photo_material_id": "xxxxxxxx",
            "role": "角色2",
            "profile": "简介"
        }]
    }
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 3.7.查询剧目审核信息

该接口用于查询剧目最后一条审核信息。

# 调用方式

# HTTPS 调用

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

# 第三方调用

调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同

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

服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用 getAccessToken 或者 authorizer_access_token
drama_id	number	是	剧目id
audit_type	number	是	审核类型。0为首次提审；1为再次提审；2为替换剧集提审；3为修改剧目基本信息审核。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
audit_detail	DramaAuditDetail	审核信息，区别于getdrama接口的audit_detail，getdrama接口的audit_type仅表示audit_type=0或1的审核信息。

# 调用示例

# 请求数据示例

{
    "drama_id": 10001,
    "audit_type": 0
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "audit_detail": {
        "status": 3,
        "create_time": 1682215878,
        "audit_time": 1682235878
    }
}

# 4.数据统计

# 4.1.查询CDN用量数据

该接口用于查询点播 CDN 的流量数据。

# 注意事项

可以查询最近365天内的 CDN 用量数据。
查询时间跨度不超过90天。
可以指定用量数据的时间粒度，支持5分钟、1小时、1天的时间粒度。
流量为查询时间粒度内的总流量。
流量进制换算规则：1GB=1000MB、1MB=1000KB。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
start_time	number	是	起始时间戳。
end_time	number	是	截止时间戳。
data_interval	number	是	用量数据的时间粒度，单位：分钟，取值有：5：5 分钟粒度，返回指定查询时间内5分钟粒度的明细数据。60：小时粒度，返回指定查询时间内1小时粒度的数据。1440：天粒度，返回指定查询时间内1天粒度的数据。默认值为1440，返回天粒度的数据。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
data_interval	number	时间粒度，单位：分钟。
item_list	array<DataItem>	CDN 统计数据。

DataItem

属性	类型	说明
time	number	数据所在时间区间的开始时间戳。
value	number	数据大小，单位：字节。

# 调用示例

# 请求数据示例

{
    "start_time": 1682870400,
    "end_time": 1682956800,
    "data_interval": 5
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "data_interval": 5,
    "item_list": [
        {
            "time": 1682870400,
            "value": 123
        },
        ...
    ]
}

# 4.2.查询CDN日志下载链接列表

查询域名的 CDN 访问日志的下载链接。

# 注意事项

可以查询最近30天内的 CDN 日志下载链接，单次查询的时间跨度不超过48小时。
日志文件以小时为单位产生，但一个小时内可能会产生多个文件，每个文件对应一个域名，平台有可能使用多个域名分发。若某一个小时没有CDN访问，不会生成日志文件。
CDN 日志下载链接的有效期为24小时。
日志字段依次为：请求时间、客户端 IP、访问域名、文件路径、字节数、省级编码、运营商编码、 HTTP 状态码、referer、Request-Time、 UA、range、HTTP Method、协议标识、缓存 HIT / MISS，日志数据打包存在延迟，正常情况下3小时后数据包趋于完整日志中的字节数为应用层数据大小，未考虑网络协议包头、加速重传等开销，因此与计费数据存在一定差异。
CDN日志中记录的下行字节数统计而来的流量数据，是应用层数据。在实际网络传输中，产生的网络流量要比纯应用层流量多5%-15%，比如TCP/IP协议的包头消耗、网络丢包重传等，这些无法被应用层统计到。在业内标准中，计费用流量一般在应用层流量的基础上加上上述开销，媒资管理服务中计费的加速流量约为日志计算加速流量的110%。

省份映射

22：北京；86：内蒙古；146：山西；1069：河北；1177：天津；119：宁夏；152：陕西；1208：甘肃；1467：青海；1468：新疆；145：黑龙江；1445：吉林；1464：辽宁；2：福建；120：江苏；121：安徽；122：山东；1050：上海；1442：浙江；182：河南；1135：湖北；1465：江西；1466：湖南；118：贵州；153：云南；1051：重庆；1068：四川；1155：西藏；4：广东；173：广西；1441：海南；0：其他；1：港澳台；-1：海外。

运营商映射

2：中国电信；26：中国联通；38：教育网；43：长城宽带；1046：中国移动；3947：中国铁通；-1：海外运营商；0：其他运营商。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
start_time	number	是	起始时间戳。
end_time	number	是	结束时间戳，必须大于起始时间，起始到结束时间的跨度不要超过48小时（end_time-start_time<=48h）
~~limit~~	number	否	2024年3月39日起废弃。~~分页拉取的最大返回结果数。默认值：100；最大值：1000。~~
~~offset~~	number	否	2024年3月39日起废弃。~~分页拉取的起始偏移量。默认值：0。~~

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
total_count	number	日志下载链接总数量。
domestic_cdn_logs	array<CdnLogInfo>	国内CDN节点的日志下载列表。

CdnLogInfo

属性	类型	说明
date	number	日志所属日期。
name	number	日志名称。
url	number	日志下载链接，24小时内下载有效。
start_time	number	日志起始时间。
end_time	number	日志结束时间。

# 调用示例

# 请求数据示例

{
    "start_time": 1711589350,
    "end_time": 1711632520,
}

# 返回数据示例

{
    "domestic_cdn_logs": [
        {
            "date": "2024-03-28",
            "end_time": 1711627199,
            "name": "2024032819-1500020822.vod2.myqcloud.com-mainland",
            "start_time": 1711623600,
            "url": "https://log-download.cdn.qcloud.com/20240328/19/2024032819-1500020822.vod2.myqcloud.com.gz?st=WdyksvfNz23NWKgEvcLQ&e=1711715411"
        },
        {
            "date": "2024-03-28",
            "end_time": 1711623599,
            "name": "2024032818-1500020822.vod2.myqcloud.com-mainland",
            "start_time": 1711620000,
            "url": "https://log-download.cdn.qcloud.com/20240328/18/2024032818-1500020822.vod2.myqcloud.com.gz?st=QmphynCTcO1G23-Ol-SlAg&e=1711715411"
        }
    ],
    "errcode": 0,
    "errmsg": "ok",
    "total_count": 2
}

# 4.3.查询流量包详情

该接口用于查询流量包的使用详情。

# 注意事项

流量包单位为MB，流量进制换算规则：1GB=1000MB
剩余可用流量为有效的(status=1)流量包的余额之和。
流量包是存在有效期限制的，需要注意流量包是否即将过期。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
status	number	是	按流量包状态过滤，取值有：0-不过滤，1-有效的，2-无效的，3-过期的
offset	number	是	偏移值，分页请求用
limit	number	是	分页大小，最大值为100

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误原因
total_count	number	当前查询条件下的流量包总数
package_list	array<PakageDetail>	流量包详情列表

PakageDetail

属性	类型	说明
start_time	number	有效期起始时间
end_time	number	有效期截止时间
used	number	流量包已消耗流量的数值（MB）
all	number	流量包总额（MB），剩余流量=流量包总额-已消耗流量
order_id	string	订单号
status	number	流量包状态，参考请求参数status中的说明
is_deleted	number	是否已删除（失效），例如已退款
package_id	string	流量包编号

# 调用示例

# 请求数据示例

{
    "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
}

# 5.剧目授权

# 5.1.增加剧目授权

该接口用于授权方给被授权方授权一些剧目的播放权限。

# 注意事项

授权方与被授权方都需申请【文娱-微短剧】类目;
被授权的剧目必须已经审核通过;
如果指定授权到期时间，授权时长不能小于7天（从当前时间算起）。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
drama_id	array<number>	是	授权的剧目ID
authorized_appid	string	是	被授权方小程序id。
authz_expire_time	number	否	不传或者传0，表示永久有效；否则表示授权到期的时间戳。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
result	array<AuthorizeDramaResult>	剧目的授权结果。

AuthorizeDramaResult

属性	类型	说明
drama_id	number	剧目ID。
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "authorized_appid": "wx*************",
    "drama_id": [100200, 100205],
    "authz_expire_time": 0
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "result": [
        {
            "drama_id": 100200,
            "errcode": 0
        },
        {
            "drama_id": 100205,
            "errcode": 1,
            "errmsg": "获取剧目100205失败！"
        }
    ]
}

# 5.2.解除剧目授权

该接口用于授权方解除被授权方一些剧目的播放授权。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
drama_id	array<number>	是	解除授权剧目ID。
authorized_appid	string	是	被授权方小程序id。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。
result	array<AuthorizeDramaResult>	剧目的解除授权结果。

# 调用示例

# 请求数据示例

{
    "authorized_appid": "wx*************",
    "drama_id": [100200, 100205]
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "result": [
        {
            "drama_id": 100200,
            "errcode": 0
        },
        {
            "drama_id": 100205,
            "errcode": 1,
            "errmsg": "获取剧目100205的授权信息失败!"
        }
    ]
}

# 5.3.查询授权信息

该接口用于授权方查询剧目授权信息。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
drama_id	number	否	查询的剧目ID。不填表示查询所有剧目。
authorized_appid	string	否	查询的被授权方小程序id。不填表示查询所有被授权方。
offset	number	否	偏移值，分页请求用。默认0。
limit	number	否	分页大小，默认100，最大值为1000。

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误原因
total_count	number	当前查询条件下的记录总数
objects	array<AuthorizeObject>	授权信息

AuthorizeObject

属性	类型	说明
drama_id	number	授权的剧目ID
authorized_appid	string	被授权方小程序id
authorized_time	number	授权时间戳
authz_expire_time	number	授权到期时间戳。0表示长期有效。

# 调用示例

# 请求数据示例

{
    "drama_id": 100206,
    "limit": 100
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "objects": [
        {
            "drama_id": 100206,
            "authorized_appid": "wx**********",
            "authorized_time": 1702020510,
            "authz_expire_time": 0
        },
        {
            "drama_id": 100206,
            "authorized_appid": "wx**********",
            "authorized_time": 1702020549,
            "authz_expire_time": 1703120549
        }
    ],
    "total_count": 2
}

# 5.4.查询被授权信息

该接口用于被授权方查询自己被授权的剧目授权信息。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
authorizer_appid	string	否	授权方小程序id。不填表示查询所有授权方。
offset	number	否	偏移值，分页请求用。默认0。
limit	number	否	分页大小，默认100，最大值为1000。

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误原因
total_count	number	当前查询条件下的记录总数
objects	array<AuthorizedObject>	被授权信息

AuthorizedObject

属性	类型	说明
drama_id	number	授权的剧目ID
authorizer_appid	string	授权方小程序id
authorized_time	number	授权时间戳
authz_expire_time	number	授权到期时间戳。0表示长期有效。

# 调用示例

# 请求数据示例

{
    "authorizer_appid": "wx*********",
    "limit": 100
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "objects": [
        {
            "drama_id": 100206,
            "authorizer_appid": "wx**********",
            "authorized_time": 1702020510,
            "authz_expire_time": 0
        }
    ],
    "total_count": 1
}

# 6.账号授权

# 6.1.增加账号授权

该接口用于授权方给被授权方授权所有剧目的播放权限。

# 注意事项

授权方与被授权方都需申请【文娱-微短剧】类目;
如果指定授权到期时间，授权时长不能小于7天（从当前时间算起）。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
authorized_appid	string	是	被授权方小程序id。
authz_expire_time	number	否	不传或者传0，表示永久有效；否则表示授权到期的时间戳。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "authorized_appid": "wx*************",
    "authz_expire_time": 0
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 6.2.解除账号授权

该接口用于授权方解除被授权方的播放授权。

# 调用方式

# HTTPS 调用

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

# 请求参数

属性	类型	必填	说明
authorized_appid	string	是	被授权方小程序id。

# 返回参数

属性	类型	说明
errcode	number	错误码。
errmsg	string	错误原因。

# 调用示例

# 请求数据示例

{
    "authorized_appid": "wx*************"
}

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 6.3.查询账号授权信息

该接口用于授权方查询账号授权信息。

# 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxa/sec/vod/getauthorizeapps?access_token=ACCESS_TOKEN

# 请求参数

无

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误原因
objects	array<AuthorizeObject>	授权信息

AuthorizeObject

属性	类型	说明
authorized_appid	string	被授权方小程序id
authorized_time	number	授权时间戳
authz_expire_time	number	授权到期时间戳。0表示长期有效。

# 调用示例

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "objects": [
        {
            "authorized_appid": "wx**********",
            "authorized_time": 1702020510,
            "authz_expire_time": 0
        },
        {
            "authorized_appid": "wx**********",
            "authorized_time": 1702020549,
            "authz_expire_time": 1703120549
        }
    ]
}

# 6.4.查询被账号授权信息

该接口用于被授权方查询自己被账号授权的信息。

# 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxa/sec/vod/getauthorizedapps?access_token=ACCESS_TOKEN

# 请求参数

无

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误原因
objects	array<AuthorizedObject>	被授权信息

AuthorizedObject

属性	类型	说明
authorizer_appid	string	授权方小程序id
authorized_time	number	授权时间戳
authz_expire_time	number	授权到期时间戳。0表示长期有效。

# 调用示例

# 返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "objects": [
        {
            "authorizer_appid": "wx**********",
            "authorized_time": 1702020510,
            "authz_expire_time": 0
        }
    ]
}

# 7.事件通知

如果需要监听媒资上传完成和审核结果的事件，可以监听本章节中的事件。具体接入方式可以参考公众平台的消息推送:

如果开发者是小程序商家，请移步：消息推送

如果开发者是服务商第三方平台，请移步：消息与事件接收配置

# 7.1.媒资上传完成事件

# 请求参数

属性	类型	必填	说明
media_id	number	是	媒资id。
source_context	string	否	透传上传接口中开发者设置的值。
errcode	number	是	错误码，上传失败时该值非0。
errmsg	string	否	错误提示。

<xml>
    <ToUserName>gh_abcdefg</ToUserName>
    <FromUserName>oABCD</FromUserName>
    <CreateTime>12344555555</CreateTime>
    <MsgType>event</MsgType>
    <Event>secvod_upload_event</Event>
    <upload_event>
        <media_id>20001</media_id>
        <source_context>abc12232</source_context>
        <errcode>0</errcode>
        <errmsg>OK</errmsg>
    </upload_event>
</xml>

# 7.2.审核状态事件

# 请求参数

属性	类型	必填	说明
drama_id	number	是	剧目id。
audit_detail	DramaAuditDetail	是	剧目审核结果，单独每一集的审核结果可以根据drama_id查询剧集详情得到。

<xml>
    <ToUserName>gh_abcdefg</ToUserName>
    <FromUserName>oABCD</FromUserName>
    <CreateTime>12344555555</CreateTime>
    <MsgType>event</MsgType>
    <Event>secvod_audit_event</Event>
    <audit_event>
        <drama_id>20001</drama_id>
        <audit_detail>
            <status>3</status>
            <audit_type>0</audit_type>
            <create_time>168625255</create_time>
            <audit_time>168626255</audit_time>
        </audit_detail>
    </audit_event>
</xml>

# 8.常见错误码

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