API概览

更新时间:
复制为 MD 格式

本产品(ICE/2020-11-09)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

媒体上传

API

标题

API概述

CreateUploadMedia 获取媒资上传地址和凭证 本接口支持获取音视频、图片和辅助媒资的上传地址和凭证。并创建媒资信息。
CreateUploadStream 获取媒体流上传地址和凭证 获取媒体流上传地址和凭证,并将上传完成的媒体流挂载到指定的MediaId下。
RefreshUploadMedia 刷新媒资上传凭证 本接口用于媒资文件上传超时后重新获取媒资上传凭证,也可用于媒资文件的覆盖上传(即获取到源文件上传地址后重新上传且音/视频ID保持不变)。
RegisterMediaStream 注册媒体流 该接口用于将OSS上媒体流文件注册到媒体服务,并将该媒体流挂在到指定的MediaId下。
GetUrlUploadInfos 获取URL上传信息 调用GetURLUploadInfos获取URL上传信息,适用于通过URL上传文件的场景,用于查询上传任务的详细信息。
UploadMediaByURL URL拉取上传 调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。本接口主要适用于文件没有存储在本地服务器或终端,需要通过公网访问的URL地址上传的场景。
UploadStreamByURL 媒体流URL拉取上传 调用UploadStreamByURL基于源文件URL,拉取媒体流文件并上传至VOD点播存储中。上传完成后,该媒体流将自动挂载到指定的MediaId下。

媒资管理

API

标题

API概述

媒资搜索 媒资搜索
流媒资操作 流媒资操作
CloseStreamToSearchLib 关闭流媒资 关闭流媒资,关闭后停止打标和分析。
GetStreamTagList 获取流媒资打标 查询流媒资打标信息。
CreateStreamToSearchLib 创建流媒资 创建流媒资,把直播流注册为媒资。
AddStreamTagToSearchLib 添加流媒资标签 针对流媒资进行打标。
搜索库管理 搜索库管理
CreateSearchLib 创建搜索库 用户新建搜索媒资库。可以用来保存媒资。
QuerySearchLib 查询搜索库 查询搜索媒资库信息。
ListSearchLib 获取搜索库列表 获取搜索库列表信息。
AlterSearchLib 修改搜索库 修改搜索库。
DropSearchLib 删除搜索库 删除搜索媒资库。删除库下所有媒资。
搜索索引配置管理 搜索索引配置管理
CreateSearchIndex 创建搜索索引 可以在搜索库下新增搜索索引。一个搜索库下可以有多个不同类型搜索索引。
AlterSearchIndex 修改搜索索引 修改搜索索引信息(索引状态或索引配置)。
QuerySearchIndex 查询搜索索引 查询搜索索引详细信息。
DropSearchIndex 删除搜索索引 删除索引,删除后对应索引存量数据会被删除,新增媒资也不再支持对应索引分析、存储、搜索。
搜索索引任务管理 搜索索引任务管理
QueryMediaIndexJob 查询媒资索引任务 查询媒资对应开启的索引任务。
SearchIndexJobRerun 搜索索引任务重跑 批量重新分析指定媒资的搜索索引任务。每次请求最多可以重跑20个媒资的索引任务。
媒资操作 媒资操作
InsertMediaToSearchLib 插入媒资到搜索库 插入媒资到搜索库。
UpdateMediaToSearchLib 更新媒资到搜索库 在搜索库中更新媒资信息。
DeleteMediaFromSearchLib 删除媒资从搜索库 在搜索库中删除指定媒资。
搜索功能 搜索功能
基础搜索 基础搜索
SearchMedia 搜索媒体信息 根据用户所提供参数,返回符合条件的媒资信息。
GetVideoList 获取媒资信息列表 获取视频信息列表。
人脸搜索 人脸搜索
SearchMediaByFace 人脸图片搜媒资 人脸图片搜媒资接口(粗搜),输入一张人脸图片,搜索该人物所在媒资的相关信息。
SearchMediaClipByFace 人脸图片搜媒资片段 人脸图片搜媒资片段接口(精搜),基于粗搜结果返回该人脸所在媒资的相关人物片段信息。
智能标签搜索 智能标签搜索
SearchMediaByAILabel 智能标签文本搜索 可以根据人名、字幕、AI分类进行多模搜索。
大模型搜索 大模型搜索
SearchMediaByMultimodal 大模型搜索 大模型搜索。用户可以使用自然语言描述进行搜索。
SearchMediaByHybrid 混合搜索 媒资混合搜索。智能标签文本搜索和大模型搜索能力合并进行多路召回,用户可以使用自然语言描述进行搜索。
媒资库 媒资库
RegisterMediaInfo 注册内容库资源 发起一个注册媒资的任务,赋予新媒资一个IMSmediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口,获取具体的媒资信息。当前仅支持InputURLOSS文件或VOD媒资。
GetMediaInfo 获取媒资内容信息 根据IMS mediaId或媒资InputURL,获取并返回媒资信息。
UpdateMediaInfo 更新媒体信息 根据IMS mediaId或媒资InputURL,更新一个媒资的媒资信息。
DeleteMediaInfos 删除媒资内容 批量删除媒资信息,最多一次删20个。MediaIds不为空时,优先使用MediaIds。如果MediaIds为空,则InputURLs必须非空。
BatchGetMediaInfos 批量获取媒体信息 批量获取媒资信息,支持传入多个mediaId。
ListMediaBasicInfos 列出媒资基础信息 根据用户所给参数,返回所有符合条件的媒资的基础信息。
ListPublicMediaBasicInfos 列出公共素材库媒资基础信息 列出符合条件的公共素材库媒资基础信息,最多筛选出100条。
ListAllPublicMediaTags 列出公共素材库所有标签 列出公共素材库媒资的所有标签。
SubmitMediaAiAnalysisJob 提交媒资智能结构化分析任务 对媒资进行结构化分析,可以对视频进行发言人分析、视频翻译、段落概要等分析。
分类管理 分类管理
AddCategory 创建分类 调用AddCategory创建媒资分类。
GetCategories 获取分类及子分类 调用GetCategories获取指定的分类信息,及其子分类(即下一级分类)的列表。
UpdateCategory 更新分类 调用UpdateCategory更新媒资分类。
DeleteCategory 删除分类 调用DeleteCategory删除媒资分类。
标记管理 标记管理
AddMediaMarks 为媒资增加标记信息 本接口用于为媒体资源(如视频、音频文件)添加标记信息,便于后续的检索、分析及管理。
GetMediaMarks 按照点位ID获取媒资标记信息 该接口允许用户根据指定的点位ID来查询和获取相应的媒体资源标记信息。
UpdateMediaMarks 修改媒资标记信息 修改媒资标记信息。
DeleteMediaMarks 删除媒资的标记信息 删除媒资的标记信息。
ListMediaMarks 列出媒资的全部标记信息 列出媒资的全部标记信息。
IPC管理 IPC管理
CreateIpcOrder 创建IPC订单 创建IPC订单,账号粒度共享容量。
GetIpcDeviceInfo 获取IPC设备信息 获取IPC设备信息。
QueryIpcQuota 查询IPC用量 查询IPC用量。
GetPlayInfo 获取音视频播放地址 本接口通过音视频ID直接获取媒体文件(支持视频和音频)的播放地址。集成阿里云播放器SDK(适用于URL播放方式)或第三方播放器后,可使用该地址进行音视频播放。
DeletePlayInfo 删除媒体流 调用本接口删除媒体流(视频流,音频流)信息。支持批量删除媒体流信息。

媒资审核

API

标题

API概述

CreateAudit 人工审核 调用CreateAudit针对媒资提交人工审核。
SubmitMediaCensorJob 提交媒体审核作业 允许用户想智能媒体服务提交一个媒体文件的审核任务,该接口支持对视频、音频或图像内容进行自动化的审核,以检测其中可能包含的违规、敏感或不适宜的内容。
QueryMediaCensorJobDetail 查询媒体审核作业详情 调用QueryMediaCensorJobDetail查询媒体审核作业的详细信息。
QueryMediaCensorJobList 查询媒体审核作业列表 调用QueryMediaCensorJobList查询媒体审核作业列表。

配置管理

API

标题

API概述

模板管理 模板管理
CreateCustomTemplate 创建用户自定义模板 本接口允许用户创建自定义的媒体处理模板。
GetSystemTemplate 获取系统模板信息 获取单个系统预置模板信息。
GetCustomTemplate 获取自定义模板信息 获取媒体处理用户自定义模板信息。
SetDefaultCustomTemplate 设置默认自定义模板 本接口用于设置用户自定义的点播媒体处理默认模板。
UpdateCustomTemplate 修改用户自定义模板信息 修改媒体处理用户自定义模板信息。
DeleteCustomTemplate 删除自定义模板 删除用户自定义模板。
ListSystemTemplates 获取系统模板列表 获取媒体处理系统预置模板列表。
ListCustomTemplates 获取自定义模板列表 获取用户自定义点播媒体处理模板列表。
管道管理 管道管理
CreatePipeline 创建管道 本接口用于创建媒体处理管道,实现媒体文件的自动化和批量处理。
GetPipeline 获取管道详细信息 获取用户管道详细信息。
UpdatePipeline 更新管道信息 更新用户管道信息。
DeletePipeline 删除用户管道 删除用户管道信息。
ListPipelines 获取管道列表 获取用户管道列表。

媒体处理

API

标题

API概述

转码接口 转码接口
SubmitTranscodeJob 提交转码任务 用户可以调用SubmitTranscodeJob接口,指定需要转码的源文件、输出格式以及相关参数,并提交视频或音频文件的转码任务到智能媒体服务。
GetTranscodeJob 查询转码任务 查询单个转码任务详情。
ListTranscodeJobs 查询转码任务列表 查询媒体文件的转码任务列表。
GenerateKMSDataKey 创建KMS数据密钥 生成一个随机的KMS数据密钥,用于对视频进行标准加密转码。
DecryptKMSDataKey 解密KMS数据密钥密文 解密KMS数据密钥中的CiphertextBlob密文。
截图接口 截图接口
SubmitSnapshotJob 提交截图任务 本接口用于提交截图任务。通过该接口,用户可以指定媒体文件的IDURL,以及截图的时间点和格式,系统将根据这些参数生成截图并保存到指定的位置。
SubmitDynamicImageJob 提交动图任务 本接口用于提交生成动态图像的任务。
GetSnapshotUrls 获取截图任务输出URL 获取截图任务输出图片的可访问URL。
GetSnapshotJob 查询截图任务详细信息 查询截图任务详细信息。
GetDynamicImageJob 查询动图任务详细信息 查询动图任务详细信息。
ListSnapshotJobs 获取截图任务列表 获取截图任务列表。
ListDynamicImageJobs 获取动图任务列表 获取动图任务列表。
媒体信息接口 媒体信息接口
SubmitSyncMediaInfoJob 提交同步媒体信息任务 调用SubmitSyncMediaInfoJob以同步模式提交媒体文件进行媒体信息分析。
SubmitMediaInfoJob 提交媒体信息异步任务 提交媒体信息异步任务。
GetMediaInfoJob 媒体信息任务查询 查询媒体信息。
ListMediaInfoJobs 查询媒体信息任务列表 查询媒体信息任务列表。

实时处理

API

标题

API概述

实时媒体转码 实时媒体转码
CreateLiveTranscodeTemplate 创建实时媒体转码模版 调用本接口创建实时转码模板,便于提交实时转码任务。
GetLiveTranscodeTemplate 获取单个实时媒体转码模版 调用GetLiveTranscodeTemplate获取单个实时转码模板。
UpdateLiveTranscodeTemplate 更新实时媒体转码模版 更新实时转码模板。
DeleteLiveTranscodeTemplate 删除实时媒体转码模版 删除实时转码模板。
ListLiveTranscodeTemplates 获取实时媒体转码模版列表 调用ListLiveTranscodeTemplates获取实时媒体转码模版列表。
SubmitLiveTranscodeJob 提交实时媒体转码任务 调用本接口提交实时转码任务。
SendLiveTranscodeJobCommand 发送实时转码任务指令 发送实时转码任务指令。
GetLiveTranscodeJob 获取单个实施媒体转码任务 调用GetLiveTranscodeJob获取单个实时转码任务。
UpdateLiveTranscodeJob 更新实时媒体转码任务 调用UpdateLiveTranscodeJob更新实时转码任务信息。
DeleteLiveTranscodeJob 删除实时媒体转码任务 删除指定实时转码任务。
ListLiveTranscodeJobs 获取实时媒体转码任务列表 调用ListLiveTranscodeJobs获取实时媒体转码任务列表。
实时媒体录制 实时媒体录制
CreateLiveRecordTemplate 创建实时录制模板 调用CreateLiveRecordTemplate创建实时录制模板,便于提交实时录制任务。
GetLiveRecordTemplate 获取实时录制模板明细 调用GetLiveRecordTemplate获取实时录制模板明细或任务模板快照。
UpdateLiveRecordTemplate 更新实时录制模板 调用UpdateLiveRecordTemplate更新实时录制模板。
DeleteLiveRecordTemplate 删除实时录制模板 调用DeleteLiveRecordTemplate删除实时录制模板,不影响现有任务。
ListLiveRecordTemplates 获取实时录制模板列表 调用ListLiveRecordTemplates获取实时录制模板列表。
SubmitLiveRecordJob 提交实时录制任务 调用SubmitLiveRecordJob提交实时录制任务,对直播流进行录制。
GetLiveRecordJob 获取实时录制任务明细 调用GetLiveRecordJob获取单个实时录制任务明细。
DeleteLiveRecordFiles 删除实时录制文件 调用DeleteLiveRecordFiles删除实时录制文件,可选择只删除记录或同时删除原始OSS文件。
ListLiveRecordJobs 获取实时录制任务列表 调用ListLiveRecordJobs获取实时录制任务列表,可分页获取。
ListLiveRecordFiles 查询所有录制索引文件 调用ListLiveRecordFiles查询某个时间段内的所有录制索引文件。
实时媒体截图 实时媒体截图
CreateLiveSnapshotTemplate 创建实时截图模板 调用CreateLiveSnapshotTemplate创建实时截图模板,模板便于创建截图任务。
GetLiveSnapshotTemplate 获取实时截图模板 调用GetLiveSnapshotTemplate获取单个实时截图模板。
UpdateLiveSnapshotTemplate 更新实时截图模板 更新实时截图模板。
DeleteLiveSnapshotTemplate 删除实时截图模板 删除实时截图模板。
ListLiveSnapshotTemplates 获取实时截图模板列表 调用ListLiveSnapshotTemplates获取实时截图模板列表,可分页获取。
SubmitLiveSnapshotJob 提交实时截图任务 调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交,则会自动异步启动任务,否则为未启动状态。
SendLiveSnapshotJobCommand 发送实时截图任务指令 发送实时截图任务指令。
GetLiveSnapshotJob 获取实时截图任务 调用GetLiveSnapshotJob获取单个实时截图任务。
DeleteLiveSnapshotFiles 删除实时截图文件 调用DeleteLiveSnapshotFiles删除实时截图文件,可选择只删除记录或同时删除原始OSS文件。
ListLiveSnapshotJobs 获取实时截图任务列表 调用ListLiveSnapshotJobs获取实时截图任务列表,可分页获取。
ListLiveSnapshotFiles 获取实时截图文件列表 调用ListLiveSnapshotFiles获取实时截图文件列表,可分页获取。

生产制作

API

标题

API概述

云剪辑工程管理 云剪辑工程管理
CreateEditingProject 创建云剪辑工程 创建云剪辑工程,支持设置标题、描述、时间线和工程封面等。
GetEditingProject 获取单个云剪辑工程 查询单个云剪辑工程的信息。
UpdateEditingProject 修改云剪辑工程 修改云剪辑工程,支持修改标题、时间线和封面等。
DeleteEditingProjects 删除云剪辑工程 删除云剪辑工程,支持批量删除。
ListEditingProjects 列出符合条件的剪辑工程 列出符合条件的剪辑工程,支持根据工程创建时间筛选。
AddEditingProjectMaterials 增加剪辑工程关联素材 将一个或多个素材添加到剪辑工程中。
GetEditingProjectMaterials 获取剪辑工程关联素材 获取当前工程绑定的所有素材。
DeleteEditingProjectMaterials 删除剪辑工程关联素材 将一个或多个素材从剪辑工程中删除。
GetLiveEditingIndexFile 获取直播剪辑索引文件 获取直播流的索引文件,用于控制台剪辑预览。
SubmitProjectExportJob 提交工程导出任务 提交工程导出任务。
GetProjectExportJob 查询工程导出任务 查询工程导出任务信息。
剪辑制作 剪辑制作
SubmitMediaProducingJob 提交剪辑合成作业 SubmitMediaProducingJob接口主要用于提交一个媒体剪辑合成任务。当用户需要对视频或音频素材进行剪辑、合成或其他形式的后期制作时,可以通过调用此API接口来实现自动化处理。
GetMediaProducingJob 查询剪辑合成作业 获取剪辑合成作业的详细信息,包括剪辑合成任务的任务状态、时间线、模板及数据等。
SubmitLiveEditingJob 提交直播剪辑任务 直播剪辑指将一个或多个直播流区间合成为成品。提交直播剪辑任务后,任务将进入后台排队,异步执行。提交后可以调用查询直播剪辑作业(GeLiveEditingJob )接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。
GetLiveEditingJob 查询直播剪辑作业 获取剪辑合成作业的详细信息,具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。 本接口仅支持查询近一年的直播剪辑任务数据。
SubmitBatchMediaProducingJob 批量智能一键成片 将多个视频、音频、图片素材进行智能混剪,一键批量合成视频。
GetBatchMediaProducingJob 获取批量智能一键成片任务信息 获取批量智能一键成片作业的详细信息,包括作业的输入参数、任务状态、合成的媒资IDURL。本接口仅支持查询近一年的任务数据。
SubmitSportsHighlightsJob 提交体育集锦任务 输入包含解说的体育赛事素材,自动生成体育赛事集锦视频。
SubmitScreenMediaHighlightsJob 提交高燃混剪任务 输入短剧等影视素材,自动识别高光片段,合成高燃成片。
ListMediaProducingJobs 列出符合条件的剪辑合成任务 列出符合条件的合成任务,可根据任务状态、类型查询。
ListBatchMediaProducingJobs 列出符合条件的一键成片任务 列出符合条件的一键成片任务,可以根据任务类型、状态等条件查询。
模板工厂 模板工厂
AddTemplate 创建模板 智能生产制作支持基于普通模板和高级模板的视频剪辑功能,用户可调用AddTemplate创建模板。
GetTemplate 获取模板信息 根据模板ID获取模板信息。高级模板有解析过长,当类型为高级模板时,StatusAvailable时即可使用。
UpdateTemplate 修改模板 调用UpdateTemplate接口修改云剪辑模板,支持修改模板标题、模板配置等信息。
DeleteTemplate 删除模板 删除模板。
ListTemplates 列出符合条件的模板 列出符合条件的模板,支持根据模板状态、创建来源等信息查询。
GetTemplateMaterials 获取模板素材地址 返回高级模板包中的素材地址,供高级模板编辑器使用,素材链接30分钟过期。FileList为所需素材数组,不填则默认返回全部素材地址,最多返回400个。
GetTemplateParams 获取模板参数信息 获取模板可替换素材参数信息,包括参数名称、素材默认值、素材封面。当前仅支持高级模板。
智能任务 智能任务
热词管理 热词管理
DeleteHotwordLibrary 删除热词库 根据提供的热词库ID删除指定的热词库。
GetHotwordLibrary 查询热词词库 查询热词词库。
ListHotwordLibraries 查询所有热词库列表 获取指定条件下的所有热词库信息。
UpdateHotwordLibrary 修改热词库 用于更新指定热词库的信息,包括名称、描述和热词列表。
CreateHotwordLibrary 创建热词库 创建热词库。
数字人训练 数字人训练
CreateAvatarTrainingJob 创建和初始化数字人训练任务 本接口用于创建数字人训练任务,配置数字人基础信息与训练所需要的素材信息等。
UpdateAvatarTrainingJob 更新数字人训练任务信息 调用此接口能够修改数字人训练任务的信息,包括: 1. 修改基本信息; 2. 在训练失败后,更新 Video、Transparent 等信息后重新进行训练。
SubmitAvatarTrainingJob 提交数字人训练任务 调用此接口来正式提交数字人训练任务: 1. 首次提交训练; 2. 在训练失败后重新提交训练。
GetAvatarTrainingJob 查询数字人训练任务的详细信息 本接口用于查询单个数字人任务的详细信息。
DeleteAvatarTrainingJob 删除数字人训练任务 调用本接口可以删除处于「初始化(草稿)」、「训练失败」状态下的任务。
ListAvatarTrainingJobs 查询数字人训练任务列表 调用本接口可以查询您名下的数字人训练任务信息列表。
GetAvatar 查询数字人 调用本接口,可以查询某个已经训练成功的数字人的详细信息。
ListAvatars 查询数字人列表 调用本接口,可以查询到您名下所有已经训练成功的数字人信息。
人声克隆 人声克隆
CreateCustomizedVoiceJob 创建人声克隆任务(基础版) 创建人声克隆任务,用于初始化配置人声克隆任务的基础信息。
GetDemonstrationForCustomizedVoiceJob 获取需要朗读的示范文本及音频(基础版) 通过本接口来获取训练个性化人声所需要朗读的文本及示例音频。
DetectAudioForCustomizedVoiceJob 提交音频检测(基础版) 本接口用来检测用户的朗读是否有明显的发音错误、嘈杂的环境等。 云端在进行完音频检测后,对于检测合格的音频会暂存在云端,供后续训练声音时使用,请勿省略该步骤。
SubmitCustomizedVoiceJob 提交人声克隆任务(基础版) 提交基础版本人声克隆任务。
SubmitStandardCustomizedVoiceJob 提交人声克隆任务(大众版) 提交大众版本的人声克隆任务。调用此接口后,会同步返回 JobId,训练过程为异步过程。在训练期间,您可以通过调用 GetCustomizedVoiceJob - 查询人声克隆训练任务接口来获取当前任务是否完成或训练状态等信息。
GetCustomizedVoiceJob 查询人声克隆任务 查询单个人声克隆任务。
DeleteCustomizedVoiceJob 删除人声克隆任务 调用此接口可以删除处于非“训练中”与“训练成功”的人声克隆任务。
ListCustomizedVoiceJobs 查询人声克隆任务列表 列出当前用户的所有人声克隆训练任务。
GetCustomizedVoice 查询个性化人声 调用本接口可以查询特定的个性化人声信息。
UpdateCustomizedVoice 更新个性化人声信息 调用此接口可以修改个性化人声的信息,目前仅支持修改示例音频媒资ID,以支持自行维护示例音频。
ListCustomizedVoices 查询个性化人声列表 列出当前用户的所有的个性化人声。
SubmitASRJob 提交ASR智能字幕任务 根据视频语音提取时间起止点及对应文字信息。
SubmitAvatarVideoJob 提交数字人渲染任务 以人声音频或文本作为输入,渲染虚拟人视频。
SubmitAudioProduceJob 提交智能语音任务 本接口用于将提供的文本内容转换成高质量的语音音频文件。
SubmitTextGenerateJob 提交关键词扩写任务 根据提交的关键词、字数、文案数,扩写出营销文案。由于中文的特殊性,输出文案字数可能跟需求字数有出入。提交任务成功后,根据JobId调用GetSmartHandleJob接口获取任务状态和结果。
SubmitVideoTranslationJob 提交视频翻译任务 通过本接口,您可以提交视频翻译任务。当前已支持字幕级翻译(将视频中出现的字幕翻译为指定语言)、声音(口播)级翻译(将音频中的口播内容翻译为指定语言)与面容级翻译(口型适配)。
SubmitHighlightExtractionJob 提交高光提取任务 提交高光提取任务。
SubmitSegmentationJob 提交拆条任务 将一个长视频拆分成多个视频片段,输出多个视频文件或输出为媒资。
GetSmartHandleJob 获取智能任务结果 获取智能任务结果,可以根据任务ID,获取智能任务信息及执行结果。 本接口仅支持查询近一年的剪辑任务数据。
DeleteSmartJob 删除智能任务 用户可以根据任务ID删除智能任务。
ListSmartJobs 获取任务列表 根据用户所给参数,返回所有符合条件的任务列表。
ListSmartSysAvatarModels 获取系统数字人列表 获取系统数字人列表,支持分页查询。
ListSmartVoiceGroups 列出智能语音发音人信息 列出智能语音发音人信息,包括发音人名称、性别、示例音频,列表按照场景进行分组。

AI实时互动

API

标题

API概述

智能体管理 智能体管理
StartAIAgentInstance 启动智能体实例 启动一个IMS配置的AI智能体实例。
StopAIAgentInstance 停止智能体实例 停止一个智能体实例。
UpdateAIAgentInstance 更新AI智能体实例配置 修改指定AI智能体实例的配置信息。
DescribeAIAgentInstance 查询智能体实例详情 查询实例。
ListAIAgentInstance 查询AI智能体实例列表 查询AI智能体实例列表,可以获取所有或指定条件下的智能体实例列表。
SendAIAgentSpeech 发送AI智能体语音 让指定智能体实例立即播报文本消息,支持打断设置。
TakeoverAIAgentCall 开启真人接管模式 切换真人客服接管模式。
SendAIAgentDataChannelMessage 向智能体通话发送DataChannel消息 向智能体通话发送DataChannel消息。
SendAIAgentText 传入消息作为LLM输入 传入消息作为LLM输入。
AICallKit集成接口 AICallKit集成接口
GenerateMessageChatToken 生成直播互动消息所需的token 生成直播互动消息所需的token。
GenerateAIAgentCall 生成AI智能体通话实例 创建一个智能体实例,返回智能体所在的频道、频道内名称以及进入频道所需的token。
ListAIAgentDialogues 查询对话记录 列出会话的历史记录。
DeleteAIAgentDialogue 删除智能体的对话历史记录 删除智能体的对话历史记录。
SendMessageChatText IM客户端发送消息 IM客户端发送消息。
运营商线路接口 运营商线路接口
StartAIAgentOutboundCall 启动智能体外呼电话 开启一个智能体外呼通话,使用主叫电话呼叫被叫电话,返回通话的InstanceId。
ListAIAgentPhoneNumber 罗列用户电话资源 罗列用户电话资源接口。
ForwardAIAgentCall 通话转呼接口 转呼通话到目标电话。
声纹管理 声纹管理
SetAIAgentVoiceprint 注册人声声纹 设置声纹
ClearAIAgentVoiceprint 清除声纹 清除声纹ID对应的声纹
ListAIAgentVoiceprints 列出人声声纹 更新回调配置
离线任务 离线任务
SubmitAIAgentVideoAuditTask 提交视频送审任务 该接口是一个视频送审服务,通过AI智能体对视频内容进行审核,支持OSS输入,允许用户自定义视频截帧策略和审核规则,并通过异步回调的方式返回审核结果。
RTOS License RTOS License
GetAiRtcLicenseInfoList 获取AI实时互动授权批次信息 查询指定条件下的AI实时互动授权批次详情。
GetAiRtcAuthCodeList 获取AI实时互动授权码信息 查询指定批次下的AI实时互动授权码列表及状态。
ActiveAiRtcLicense 激活AI实时互动License 根据批次ID、授权码和设备SN信息激活指定的License。

媒体AI

API

标题

API概述

智能内容理解 智能内容理解
任务接口 任务接口
SubmitVideoCognitionJob 提交视频智能内容理解任务 提交视频理解任务
QueryVideoCognitionJob 查询智能内容理解任务 查询视频理解任务结果
自定义识别实体接口 自定义识别实体接口
CreateRecognitionEntity 创建自定义识别库中的待识别实体 在指定的自定义识别库中创建一个新的待识别实体。通过该接口可以添加自定义地标、物体、台标、人物等识别实体。
CreateRecognitionLib 创建自定义识别库 创建一个新的自定义识别库,用于存储待识别的实体信息。
CreateRecognitionSample 注册自定义实体的识别样本 为指定的自定义实体添加识别样本图片或者文本标签,用于后续的识别匹配。
ListRecognitionSamples 获取自定义实体的识别样本列表 分页查询指定实体下的所有识别样本信息。
DeleteRecognitionSample 删除自定义实体的识别样本 从指定的自定义实体中删除一个识别样本。
ListRecognitionEntities 获取自定义识别库中的实体列表 分页查询指定识别库中的所有实体信息。
ListRecognitionLibs 获取自定义识别库列表 分页查询当前用户下的所有自定义识别库信息。
DeleteRecognitionLib 删除自定义识别库 删除指定的自定义识别库,包括库中的所有实体和样本数据。
DeleteRecognitionEntity 删除自定义识别库中的实体 从指定的自定义识别库中删除一个已存在的识别实体。
智能生产 智能生产
SubmitIProductionJob 提交智能生产任务 调用SubmitIProductionJob提交智能生产任务。
QueryIProductionJob 查询智能生产任务 调用QueryIProductionJob查询智能生产任务状态与结果。
媒体DNA 媒体DNA
CreateDNADB 创建DNA 调用CreateDNADB创建DNA库。
DeleteDNADB 删除DNA 调用DeleteDNADB删除DNA库。
ListDNADB 查询DNA 调用ListDNADB查询DNA库。
SubmitDNAJob 提交DNA作业 调用SubmitDNAJob提交DNA作业。
CancelDNAJob 取消DNA作业 调用CancelDNAJob取消DNA作业。
DeleteDNAFiles 删除DNA文件 调用DeleteDNAFiles删除DNA文件。
ListDNAFiles 查询DNA文件 调用ListDNAFiles查询DNA文件。
QueryDNAJobList 查询DNA作业列表 调用QueryDNAJobList查询DNA作业。
数字水印 数字水印
SubmitCopyrightJob 提交视频版权水印作业 调用SubmitCopyrightJob提交视频版权水印任务。
QueryCopyrightJobList 查询视频版权水印作业列表 查询视频版权水印任务列表。
SubmitCopyrightExtractJob 提交版权水印提取作业 提交版权水印提取作业。
QueryCopyrightExtractJob 查询版权水印提取作业 查询版权水印提取任务。
SubmitTraceAbJob 提交视频溯源水印ab流作业 提交视频溯源水印ab流任务。
QueryTraceAbJobList 查询视频溯源水印ab流作业列表 查询视频溯源水印ab流任务列表。
SubmitTraceM3u8Job 提交视频溯源水印m3u8作业 提交视频溯源水印m3u8文件任务。
QueryTraceM3u8JobList 查询视频溯源水印m3u8作业列表 查询视频溯源水印m3u8任务。
SubmitTraceExtractJob 提交溯源水印提取作业 提交溯源水印提取任务。
QueryTraceExtractJob 查询溯源水印提取作业 查询溯源水印提取任务。

用量统计

API

标题

API概述

DescribeMeterImsMediaConvertUHDUsage IMSMPS转码UHD计量查询 IMSMPS转码UHD计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMediaConvertUsage IMS的点播转码计量查询 IMS的点播转码计量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsEditUsage IMS点播视频剪辑用量查询 IMS点播视频剪辑用量查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsSummary IMS点播用量统计查询 IMS点播用量统计查询,最大查询范围31天,最远可查90天内的数据。
DescribeMeterImsMpsAiUsage IMSMPS-AI计量查询 IMSMPS-AI用量查询,最大查询范围31天,最远可查90天内的数据。

全局配置

API

标题

API概述

SetEventCallback 设置事件回调 设置特定事件的通知机制。
GetEventCallback 获取事件回调 调用GetEventCallback获取事件回调配置。

工作流

API

标题

API概述

StartWorkflow 提交工作流任务 通过调用StartWorkflow接口,您可以提交工作流模板任务,从而实现基于工作流模板的自动化媒体处理流程。
GetWorkflowTask 查询工作流任务 根据任务ID查询工作流任务,包括工作流Id、工作流任务状态、工作流任务结果。 本接口仅支持查询近一年的工作流任务数据。
ListWorkflowTasks 遍历工作流任务实例 遍历工作流任务实例。
StartAIWorkflow 提交智能工作流任务 通过调用StartAIWorkflow接口,您可以提交智能工作流任务,从而实现基于智能工作流模板的自动化智能媒体服务流程。
StopAIWorkflowTask 停止智能工作流任务 通过调用该接口,您可以主动停止智能工作流任务。
GetAIWorkflowTask 查询智能工作流任务详情 通过调用该接口,您可以查询智能工作流任务的详细信息。

媒体服务

API

标题

API概述

媒体转码 媒体转码
SubmitMediaConvertJob 提交媒体转码任务 提交媒体处理任务。
GetMediaConvertJob 查询媒体转码任务 获取 MediaConvert 任务详情。
ListMediaConvertJobs 查询媒体转码任务列表 查询 MediaConvertJob 列表