# 获取剧目信息

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

接口英文名：getDrama

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

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/sec/vod/getdrama?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"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "drama_info",
    "类型": "object",
    "说明": "剧目信息"
  }
]
```

### Res.drama_info `Object Payload`

剧目信息

```json
[
  {
    "参数名": "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",
    "类型": "object",
    "说明": "审核状态。"
  },
  {
    "参数名": "media_list",
    "类型": "objarray",
    "说明": "剧集信息列表。"
  },
  {
    "参数名": "expedited",
    "类型": "number",
    "说明": "1表示审核加急，0或空为非加急审核"
  },
  {
    "参数名": "recommendations",
    "类型": "string",
    "说明": "剧目推荐语。"
  },
  {
    "参数名": "promotion_poster",
    "类型": "string",
    "说明": "推广海报。"
  },
  {
    "参数名": "actor_list",
    "类型": "object",
    "说明": "演员信息。"
  },
  {
    "参数名": "status",
    "类型": "number",
    "说明": "剧目状态。0为正常可播；1为审核中；2为审核失败；3为平台下架"
  }
]
```

### Res.drama_info.audit_detail `Object Payload`

审核状态。

```json
[
  {
    "参数名": "status",
    "类型": "number",
    "说明": "0为无效值；1为审核中；2为最终失败；3为审核通过；4为驳回重填"
  },
  {
    "参数名": "audit_type",
    "类型": "number",
    "说明": "事件通知接口才返回：0为首次提审；1为再次提审；2为替换剧集提审；3为修改剧目基本信息审核。"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "提审时间戳。"
  },
  {
    "参数名": "audit_time",
    "类型": "number",
    "说明": "审核时间戳。"
  }
]
```

">

### Res.drama_info.media_list(Array) `Object Payload`

剧集信息列表。

```json
[
  {
    "参数名": "media_id",
    "类型": "number",
    "说明": "媒资文件id。"
  }
]
```

### Res.drama_info.actor_list `Object Payload`

演员信息。

```json
[
  {
    "参数名": "actor",
    "类型": "objarray",
    "说明": "演员列表"
  }
]
```

">

### Res.drama_info.actor_list.actor(Array) `Object Payload`

演员列表

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

## 4. 注意事项

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

## 5. 代码示例

请求示例

```json
{
    "drama_id": 10001
}
```

返回示例

```json
{
    "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",
        "other_material":"xxxxxxxxx",
        "status": 0,
        "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": "简介"
            }]
        }
    }
}
```

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

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