素材管理

素材分组列表: /mediaGroups GET

请求参数

参数名 示列值 类型 必须 说明
page 1 number 否 当前页数
pageSize 10 number 否 每页条数
name 分组 1 string 否 分组名
sourceId 1 number 否 来源 id
sort -createdAt string 否 排序。多个排序字段用,号隔开。sort=-a,b
expand organization string 否 获取指定子资源数据 'organization'
attributes "id,name" string 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名 示列值 说明
page 1 当前页数
pageSize 10 每页条数
limit 10 同 pageSize
offset 2 起始条数
total 3231 符合条件的总数量
items [{ "id": 4, "name": "test2"] 返回数据项
参数名 示列值 类型 说明
id 1 number id
sourceId 1 number 数据来源, 机构 id, 默认 0: 速眠中心
name 分组 1 string 分组名
mediaCount 0 number 分类下素材数量
status 0 number 状态 0=禁用 1=启用
organization {"id": 1, "name": "demo" } object 来源组织信息
createdAt 1650160322 number 创建时间
updatedAt 1650160322 number 更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "name": "分组1",
        "status": 1,
        "sourceId": 1,
        "mediaCount": 1,
        "organization": { // 来源组织信息
            "name": "",
        },
        "createdAt": 1647846587,
        "updatedAt": 1647846587,
    }],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建素材分组: /mediaGroups POST

请求参数

参数名 示列值 类型 必须 说明
name 123456 string 是 名称

返回结果: 素材分组信息

编辑素材分组: /mediaGroups/:id PUT

请求参数

参数名 示列值 类型 必须 说明
name 123456 string 是 名称

返回结果: 素材分组信息

素材分组详情: /mediaGroups/:id GET

请求参数

| 参数名 | 示列值 | 类型 | 必须 | 说明 | | ---------- | -------------- | ------ | ---- | ---------------------------------------- | --- | | id | 1 | number | 是 | 组织 id | | | expand | organization | string | 否 | 获取指定子资源数据 'organization' | | attributes | ["id", "name"] | array | 否 | 本资源的字段。不定义该字段时返回所有字段 |

返回结果: 素材分组信息

删除素材分组: /mediaGroups/:id DELETE

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 资源 id

返回示列

HTTP/1.1 204 NO CONTENT

所有素材分组: /listAll/mediaGroups GET

请求参数

参数名 示列值 类型 必须 说明 默认值
name 分组 1 string 否 分组名
sourceId 1 number 否 来源 id
expand organization string 否 获取指定子资源数据 'organization'
attributes "id,name" string 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 素材分组信息

返回示列

HTTP/1.1 200 OK
[
  {}
]

素材列表: /medias GET

请求参数

参数名 示列值 类型 必须 说明
page 1 number 否 当前页数
pageSize 10 number 否 每页条数
title 素材 1 number 否 素材名
sourceId 1 number 否 来源 id
sort -createdAt number 否 排序。多个排序字段用,号隔开。sort=-a,b
expand organization string 否 获取指定子资源数据 ['organization,mediaGroup,libraryItems']
attributes "id,name" string 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名 示列值 说明
page 1 当前页数
pageSize 10 每页条数
limit 10 同 pageSize
offset 2 起始条数
total 3231 符合条件的总数量
items [{ "id": 4, "name": "test2"] 返回数据项
参数名 示列值 类型 说明
id 1 number id
sourceId 1 number 数据来源, 机构 id, 默认 0: 速眠中心
title 素材 1 string 标题
titlePinyin sucai1 string 标题拼音
type video string 类型，video：视频，audio：音频
audioType 0 number 音频类型，0：宣教，1：纯音乐
intro '' string 简介
duration 250 number 时长，单位：秒
mediaNo 11333 string 媒体编号，用于播放
isReleased 0 number 是否入库, 0: 未入库, 1: 已入库
cover httpp://xxx string 封面 url
groupId 1 number 素材分组 id
fileUrl '' string 文件 url
status 0 number 状态 0=禁用 1=启用
organization {"id": 1, "name": "demo" } object 来源组织信息
mediaGroup { "id": 1, "name": "分组 1" } object 分组信息
libraryItems [{id: 1, organization: {id:2, name: '组织名称'}}] array 入库数组
createdAt 1650160322 number 创建时间
updatedAt 1650160322 number 更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "title": "1",
        "titlePinyin": "",
        "type": "video",
        "intro": "",
        "duration": 200,
        "mediaNo": '1111',
        "isReleased": 1,
        "cover": "",
        "fileUrl": "",
        "groupId": 1,
        "mediaGroup": {
            "name": "分组1"
        },
        "status": 1,
        "sourceId": 1,
        "organization": { // 来源组织信息
            "name": "",
        },
        "createdAt": 1647846587,
        "updatedAt": 1647846587,
    }],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建素材: /medias POST

请求参数

参数名 示列值 类型 必须 说明
title 素材 1 string Y 标题
type video string Y 类型，video：视频，audio：音频
audioType 0 number N 音频类型，0：宣教，1：纯音乐
groupId 1 number Y 素材分组 id
intro '' string N 简介
duration 250 number Y 时长，单位：秒
cover httpp://xxx string 封面 url
fileUrl '' string 文件 url

返回结果: 素材信息

编辑素材: /medias/:id PUT

请求参数

参数名 示列值 类型 必须 说明
title 素材 1 string Y 标题
type video string Y 类型，video：视频，audio：音频
audioType 0 number N 音频类型，0：宣教，1：纯音乐
groupId 1 number Y 素材分组 id
intro '' string N 简介
duration 250 number Y 时长，单位：秒
cover httpp://xxx string 封面 url
fileUrl '' string 文件 url

返回结果: 素材信息

素材详情: /medias/:id GET

请求参数

| 参数名 | 示列值 | 类型 | 必须 | 说明 | | ---------- | -------------- | ------ | ---- | ------------------------------------------- | --- | | id | 1 | number | 是 | 组织 id | | | expand | organization | string | 否 | 获取指定子资源数据 'organization,mediaGrup' | | attributes | ["id", "name"] | array | 否 | 本资源的字段。不定义该字段时返回所有字段 |

返回结果: 素材信息

删除素材: /medias/:id DELETE

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 资源 id

返回示列

HTTP/1.1 204 NO CONTENT

素材入库: librarySetting/medias POST

请求参数

参数名 示列值 类型 必须 说明
ids [1] array Y 资源 id 数组
orgIds [1,2] array Y 组织 id 数组
bulk true boolean 是否是批量入库(true:是)

返回示列

HTTP/1.1 200

所有素材: /listAll/medias GET

请求参数

参数名 示列值 类型 必须 说明 默认值
title 素材 1 number 否 素材名
sourceId 1 number 否 来源 id
expand organization string 否 获取指定子资源数据 ['organization,mediaGroup']
attributes "id,name" string 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 素材信息

返回示列

HTTP/1.1 200 OK
[
  {}
]