检索媒体信息

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

我的收藏

本页目录：

接口描述
接口名称：/Material/SearchMaterial。
接口功能：检索媒体信息，支持根据媒体类型、文本和标签等进行搜索，返回符合条件的媒体记录的基础信息。
调用方式
具体调用方式参见 客户端 API 调用方式综述，您也可以使用 CME 客户端 API 调试工具 快速进行调试。
输入参数
字段
类型
必填
描述
SearchScopes
Array of SearchScope
是
指定搜索空间，数组长度不得超过5。
MaterialTypes
Array of String
否
媒体类型，取值：
AUDIO：音频。
VIDEO：视频 。
IMAGE：图片。
Text
String
否
搜索文本，模糊匹配，媒体名称或描述信息，长度限制：15个字符。
Resolutions
Array of String
否
按画质检索，取值为：LD/SD/HD/FHD/2K/4K。
DurationRange
IntegerRange
否
按媒体时长检索，单位：秒。
CreateTimeRange
TimeRange
否
按照媒体创建时间检索。
PresetTagIds
Array of String
否
按预置标签检索，填预置标签 ID。
Tags
Array of String
否
按自定义标签搜索。
Sort
Sort
否
排序方式。Sort.Field 可选值：CreateTime。指定 Text 搜索时，将根据匹配度排序，该字段无效。
Offset
Integer
否
偏移量。默认值：0。
Limit
Integer
否
返回记录条数，默认值：50。
输出参数
接口输出参数由 公共返回参数 和接口自身返回参数两部分组成。接口自身返回参数详情如下。
字段
类型
描述
TotalCount
Integer
符合条件的媒体总数。
MaterialInfoSet
Array of MaterialInfo
符合条件的媒体集合。
示例
示例1：检索媒体信息成功
检索个人分类 ID 为1430下，名称包含“脱口秀”关键字和有“综艺”标签的媒体，成功返回媒体基础信息。
输入示例
{
    "SearchScopes": [
        {
            "Platform": "my_platform",
            "Owner": {
                "Id": "ce4cdaf6-6039-486b-8f09-a5df23dxxxxxx",
                "Type": "PERSON"
            },
            "ClassId": 1430,
            "SearchOneDepth": true
        }
    ],
    "Text": "脱口秀",
    "Tags": [
        "综艺"
    ]
}
输出示例
{
    "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-a5df23xxxxxx",
                        "Type": "PERSON"
                    }
                },
                "MaterialStatus": {
                    "TranscodeStatus": "NORMAL"
                }
            }
        ]
    }
}
示例2：检索媒体信息失败
检索访问权限不足分类 ID 为1431下，名称包含“脱口秀”关键字和有“综艺”标签的媒体，返回权限不足。
输入示例
{
    "SearchScopes": [
        {
            "Platform": "my_platform",
            "Owner": {
                "Id": "ce4cdaf6-6039-486b-8f09-a5df23dxxxxxx",
                "Type": "PERSON"
            },
            "ClassId": 1431,
            "SearchOneDepth": true
        }
    ],
    "Text": "脱口秀",
    "Tags": [
        "综艺"
    ]
}
输出示例
{
    "Code": "OperationDenied.PermissionDeny",
    "Message": "权限不足",
    "EnglishMessage": "permission denied"
}
?

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