# 获取媒资播放链接

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

接口英文名：getMediaLink

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

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/sec/vod/getmedialink?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
[
  {
    "参数名": "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）"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "media_info",
    "类型": "object",
    "说明": "媒体播放信息"
  }
]
```

### Res.media_info `Object Payload`

媒体播放信息

```json
[
  {
    "参数名": "media_id",
    "类型": "number",
    "说明": "媒资文件id"
  },
  {
    "参数名": "duration",
    "类型": "number",
    "说明": "播放时长，单位：秒"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "媒资文件名"
  },
  {
    "参数名": "description",
    "类型": "string",
    "说明": "描述"
  },
  {
    "参数名": "cover_url",
    "类型": "string",
    "说明": "封面图临时链接"
  },
  {
    "参数名": "mp4_url",
    "类型": "string",
    "说明": "mp4格式临时链接"
  },
  {
    "参数名": "hls_url",
    "类型": "string",
    "说明": "hls格式临时链接"
  }
]
```

## 4. 注意事项

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

## 5. 代码示例

请求示例

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

返回示例

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

## 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. 适用范围

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