检索共享媒体

最近更新时间:2022-03-23 17:12:19

我的收藏

接口描述

接口名称:/Material/SearchSharedMaterial
接口功能:检索共享媒体,返回授权者给被授权者访问权限的媒体资源。

调用方式

具体调用方式参见 客户端 API 调用方式综述,您也可以使用 CME 客户端 API 调试工具 快速进行调试。

输入参数

字段
类型
必填
描述
Authorizer
授权者。
Authorizee
被授权者。
MaterialTypes
Array of String
媒体类型,取值:
AUDIO:音频。
VIDEO:视频 。
IMAGE:图片。
Text
String
搜索文本,模糊匹配媒体名称或描述信息<长度限制:15个字符。
Resolutions
Array of String
按画质检索,取值为:LD/SD/HD/FHD/2K/4K。
DurationRange
按媒体时长检索,单位:秒。
CreateTimeRange
按照媒体创建时间检索。
PresetTagIds
Array of String
按预置标签检索,填预置标签 ID。
Sort
排序方式。Sort.Field 可选值:CreateTime。指定 Text 搜索时,将根据匹配度排序,该字段无效。
Offset
Integer
偏移量。默认值:0。
Limit
Integer
返回记录条数,默认值:50。

输出参数

接口输出参数由 公共返回参数 和接口自身返回参数两部分组成。接口自身返回参数详情如下。
字段
类型
描述
TotalCount
Integer
符合条件的媒体总数。
MaterialInfoSet
Array of MaterialInfo
符合条件的媒体集合。

示例

示例1:检索共享媒体成功

被授权者以团队的身份检索个人授权者授予的访问的媒体资源,成功返回媒体基础信息。

输入示例

{
"Authorizer": {
"Id": "ce4cdaf6-6039-486b-8f09-a5df23xxxxxx",
"Type": "PERSON"
},
"Authorizee": {
"Id": "tid_daf6-6039-486b-8f09-a5df23xxxxxx",
"Type": "TEAM"
},
"Text": "脱口秀"
}

输出示例

{
"Code": "Success",
"Message": "成功",
"EnglishMessage": "success",
"Data": {
"TotalCount": 1,
"MaterialInfoSet": [
{
"BasicInfo": {
"MaterialId": "38192156030633420589",
"MaterialType": "VIDEO",
"Name": "脱口秀",
"CreateTime": "2020-12-14T09:05:08Z",
"UpdateTime": "2020-12-14T09:05:08Z",
"ClassPath": "/个人/视频",
"TagSet": [
"综艺",
"脱口秀"
],
"PreviewUrl": "https://cme.vod2.myqcloud.com/181000xxxx/8d388657vodtranscq181000xxxx/9be0dda85285890811308550195/coverBySnapshot/coverBySnapshot_10_0.jpg",
"MediaUrl": "https://cme.vod2.myqcloud.com/181000xxxx/b64e98afvodcq181000xxxx/9be0dda85285890811308550195/ixbEocVHT1oA.mp4?t=5fdf14b4&whref=yunjian.qq.com&sign=ce15ca0558bebe775974e2821728xxxx",
"Owner": {
"Id": "ce4cdaf6-6039-486b-8f09-a5df23dxxxxxx",
"Type": "PERSON"
}
},
"MaterialStatus": {
"TranscodeStatus": "NORMAL"
}
}
]
}
}

示例2:检索共享媒体失败

被授权者访问未被授权的媒体资源,返回权限不足。

输入示例

{
"Authorizer": {
"Id": "ce4cdaf6-6039-486b-8f09-a5df23dxxxxxx",
"Type": "PERSON"
},
"Authorizee": {
"Id": "tid_f6-6039-486b-8f09-a5df23dxxxxxx",
"Type": "TEAM"
},
"Text": "脱口秀"
}

输出示例

{
"Code": "OperationDenied.PermissionDeny",
"Message": "权限不足",
"EnglishMessage": "permission denied"
}