1. 接口描述
接口请求域名： cme.tencentcloudapi.com 。
将云点播媒资文件导入到多媒体创作引擎媒体资源库。支持导入媒体归属团队或者个人。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ImportMaterial。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-29。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Platform | 是 | String | 平台 Id，指定访问的平台。关于平台概念，请参见文档 平台。 示例值：test |
| Owner | 是 | Entity | 媒体归属者，可支持归属团队或个人。 |
| Name | 是 | String | 媒体名称，不能超过30个字符。 示例值：material_name |
| SourceType | 否 | String | 导入媒资类型，取值： 注意：如果不填默认为云点播文件，如果媒体存储在非腾讯云点播中，都需要使用媒资绑定。另外，导入云点播的文件，使用云点播的子应用 Id 必须与创建多媒体创作引擎平台时使用的云点播子应用一致。 示例值：VOD |
| VodFileId | 否 | String | 云点播媒资 FileId，仅当 SourceType 为 VOD 时有效。 示例值：5285890796182734267 |
| ExternalMediaInfo | 否 | ExternalMediaInfo | 原始媒资文件信息，当 SourceType 取值 EXTERNAL 的时候必填。 |
| ClassPath | 否 | String | 媒体分类路径，形如："/a/b"，层级数不能超过10，每个层级长度不能超过15字符。若不填则默认为根路径。 示例值：/test |
| PreProcessDefinition | 否 | Integer | 媒体预处理任务参数 ID。可取值有： 示例值：10 |
| Operator | 否 | String | 操作者。如不填，默认为 cmeid_system，表示平台管理员操作，可以向任意团队或者个人导入媒体。如果指定操作者，如果媒体归属为个人，则操作者必须与归属者一致；如果媒体归属为团队，则必须为团队可导入媒体的团队成员(如果没有特殊设置，所有团队成员可导入媒体)。示例值：60097a8a8ea83d00017b484b |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MaterialId | String | 媒体 Id。 示例值：materialId |
| PreProcessTaskId | String | 媒体文件预处理任务 ID，如果未指定发起预处理任务则为空。 示例值：taskId |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入云点播媒体到团队
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=VOD
&VodFileId=5285890796182734267
&Owner.Id=cmetid_37b1bb3bf8fb2eb3ba00e41dcca0ce
&Owner.Type=TEAM
&Name=媒体名称
&ClassPath=/媒体
&Operator=user_id_0a54392053f84053942f930
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09dd6",
"PreProcessTaskId": "",
"RequestId": "0a543920-53f8-4053-942f-9308c49404d30"
}
}示例2 导入云点播文件到个人
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=VOD
&VodFileId=528589079618273426711
&Owner.Id=user_id_0a54392053f84053942f930
&Owner.Type=PERSON
&Name=媒体名称
&ClassPath=/媒体
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09dd5",
"PreProcessTaskId": "",
"RequestId": "0a543920-53f8-4053-942f-9308c49404d7"
}
}示例3 导入外部媒体到个人并发起预处理
导入一个 COS 桶中媒体到个人，且发起预处理。
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=EXTERNAL
&Owner.Id=user_id_0a54392053f84053942f930
&Owner.Type=PERSON
&Name=媒体名称
&ClassPath=/媒体
&ExternalMediaInfo.MediaKey=example-folder/example-object.mp4
&PreProcessDefinition=10
&Operator=user_id_0a54392053f84053942f930
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09dd9",
"PreProcessTaskId": "125xxxxxxx9-tfusion-0a54392053f84053942f93089kji3d3",
"RequestId": "0a543920-53f8-4053-942f-9308c49408kd8"
}
}示例4 导入外部媒体到团队并发起预处理
导入一个 COS 桶中媒体到团队，且发起预处理。
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=EXTERNAL
&Owner.Id=cmetid_37b1bb3bf8fb2eb3ba00e41dcca0ce
&Owner.Type=TEAM
&Name=媒体名称
&ClassPath=/媒体
&ExternalMediaInfo.MediaKey=example-folder/example-object.mp4
&PreProcessDefinition=10
&Operator=user_id_0a54392053f84053942f930
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09da0",
"PreProcessTaskId": "125xxxxxxx9-tfusion-0a54392053f84053942f93089kji3d4",
"RequestId": "0a543920-53f8-4053-942f-9308c49409634"
}
}示例5 导入云点播媒体到团队并发起预处理
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=VOD
&VodFileId=5285890796182734267
&Owner.Id=cmetid_37b1bb3bf8fb2eb3ba00e41dcca0ce
&Owner.Type=TEAM
&Name=媒体名称
&ClassPath=/媒体
&PreProcessDefinition=10
&Operator=user_id_0a54392053f84053942f930
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09dd6",
"PreProcessTaskId": "125xxxxxxx9-tfusion-0a54392053f84053942f9308978d3",
"RequestId": "0a543920-53f8-4053-942f-9308c49404d30"
}
}示例6 导入云点播文件到个人并发起预处理
输入示例
https://cme.tencentcloudapi.com/?Action=ImportMaterial
&Platform=test
&SourceType=VOD
&VodFileId=528589079618273426711
&Owner.Id=user_id_0a54392053f84053942f930
&Owner.Type=PERSON
&Name=媒体名称
&ClassPath=/媒体
&PreProcessDefinition=10
&Operator=user_id_0a54392053f84053942f930
&<公共请求参数>输出示例
{
"Response": {
"MaterialId": "3dfd8ad3d628dc30001bd09dd6",
"PreProcessTaskId": "125xxxxxxx9-tfusion-0a54392053f84053942f9308c49404d8",
"RequestId": "0a738920-53f8-4053-942f-9308c494099dld"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidVodUser | 云点播用户无效。 |
| InternalError | 内部错误。 |
| InternalError.CreateTask | 发起预处理任务失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.ClassPath | 分类路径不合法。 |
| InvalidParameterValue.ExternalMediaInfoNotExist | 原始媒资信息不存在。 |
| InvalidParameterValue.Name | 名称字段编辑错误，需使用 UTF8 编码。 |
| InvalidParameterValue.NameLenLimt | 名称字段长度超长，限制 30 个中文字符。 |
| InvalidParameterValue.OwnerId | 归属者 ID 不合法。 |
| InvalidParameterValue.OwnerType | 归属者类型不合法。 |
| InvalidParameterValue.Platform | 平台参数取值错误。 |
| InvalidParameterValue.PreProcessDefinition | 预处理模板 ID 无效。 |
| InvalidParameterValue.VodFileId | 参数缺少 VodFile。 |
| InvalidParameterValue.VodFileNotExist | 点播文件不存在。 |
| InvalidParameterValue.VodSubAppid | 绑定的点播子应用无效。 |
| OperationDenied.PermissionDeny | 权限不足，请检查对应操作者的权限。 |
| ResourceNotFound.Platform | 平台不存在。 |
| UnauthorizedOperation | 未授权操作。 |
