接口描述
接口名称:
/Material/ListMedia
。接口功能:获取媒体列表,返回符合条件的媒体记录的基础信息和分类信息。
调用方式
输入参数
字段 | 类型 | 必填 | 描述 |
Platform | String | 是 | 平台。 |
ClassId | Integer | 是 | 分类 ID。 |
Owner | 是 | 分类归属。 | |
Offset | Integer | 否 | 拉取偏移量,默认为 0。 |
Limit | Integer | 否 | 一页拉取的数量,默认为 20 个,最大为 30 个。 |
输出参数
字段 | 类型 | 描述 |
MaterialTotalCount | Integer | 符合条件的媒体总数。 |
MaterialInfoSet | Array of MaterialInfo | 媒体列表。 |
ClassInfoSet | Array of ClassInfo | 分类列表。 |
示例
示例1:获取媒体列表成功
获取分类 ID 为
1430
下的媒体列表, 成功返回媒体基础信息。输入示例
{"Platform": "my_platform","ClassId": 1430,"Owner": {"Type": "PERSON","Id": "ce4cdaf6-6039-486b-8f09-a5df23xxxxxx"},"Limit": 20,"Offset": 0}
输出示例
{"Code": "Success","Message": "成功","EnglishMessage": "success","Data": {"ClassInfoSet": [],"MaterialTotalCount": 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
下的媒体列表, 返回失败,权限不足 。输入示例
{"Platform": "my_platform","ClassId": 1431,"Owner": {"Type": "PERSON","Id": "ce4cdaf6-6039-486b-8f09-a5df23xxxxxx"},"Limit": 20,"Offset": 0}
输出示例
{"Code": "OperationDenied.PermissionDeny","Message": "权限不足","EnglishMessage": "permission denied"}