多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
# 素材库接口文档 ##### 作者:黄文榕 ##### 时间:2020 - 3 - 31 ##### 版本:V4.0.0 ##### 修改: |更新时间|更新人|作用| |--|--|--| 2020-04-27 | 李小琳 | 根据V4.1.1需要,增加是否同步过个人素材库接口(/wechat_api/materiallibrary/isSynced)和同步个人素材库接口(/wechat_api/materiallibrary/syncMyselfData) 2020-04-29 | 黄文榕 | V4.2.0升级接口 /getList增加分页 2020-05-19 | 黄文榕 | V4.3.0升级接口 更新/updateFolderOrFileTitle 2020-06-05 | 黄文榕 | V4.4.0升级接口 /saveMaterialLibrary ### 获取素材列表 - url: /wechat_api/materiallibrary/getList - 调用方式: get ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- type | Integer | Y | 素材类型 1-图文链接,2-视频,3-小程序,4-图片,5-文件 isPublic | Integer | Y | 是否是公共的 0-是私人 1-是公共 2-部门 departId | Integer | N | 部门id ==当isPublic=2时必传== pageNo| Integer | Y | 页码 limit| Integer | Y | 数量 title| String| N |名称 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- id | Long | 素材库Id adminUserId | Long | 用户Id xml | String | 发送给腾讯中使用,xml格式 url | String | 素材的地址 imageUrl | String | 封面图的地址 title | String | 素材的标题 synopsis | String | 素材的摘要 source | String | 来源 type | Integer | 素材类型 1-图文链接,2-视频,3-小程序 isPublic | Integer | 是否是公共的 0-是私人 1-是公共 isFolder | Integer | 是否是文件夹 0-不是 1-是文件夹 departId | Integer | 部门id isPublic=2时使用 folderId | Integer | 文件夹id.二级文件. isPublic=2时,文件夹下的文件归属 fileSize | Integer | 文件大小 aesKey | String | cdn aesKey cdnThumbUrl | String | cdn fileid ### 编辑/收藏/添加素材 - url: /wechat_api/materiallibrary/saveMaterialLibrary - 调用方式: post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- id | Long | N | 素材库Id,更新时传 xml | String | N | 发送给腾讯中使用,xml格式,收藏时需要 url | String | Y | 素材的地址 imageUrl | String | N | 封面图的地址(视频暂无该功能) title | String | Y | 素材的标题 synopsis | String | N | 素材的摘要 source | String | N | 来源 type | Integer | Y| 素材类型 1-图文链接,2-视频,3-小程序 isPublic | Integer | Y | 是否是公共的 0-是私人 1-是公共 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 data | json | data: 属性名 | 类型| 备注 ---|--- | --- id | Long | 素材库Id adminUserId | Long | 用户Id xml | String | 发送给腾讯中使用,xml格式 url | String | 素材的地址 imageUrl | String | 封面图的地址 title | String | 素材的标题 synopsis | String | 素材的摘要 source | String | 来源 type | Integer | 素材类型 1-图文链接,2-视频,3-小程序 isPublic | Integer | 是否是公共的 0-是私人 1-是公共 isFolder | Integer | 是否是文件夹 0-不是 1-是文件夹 departId | Integer | 部门id isPublic=2时使用 folderId | Integer | 文件夹id.二级文件. isPublic=2时,文件夹下的文件归属 fileSize | Integer | 文件大小 aesKey | String | cdn aesKey cdnThumbUrl | String | cdn fileid ### 删除/批量删除标签 - url: /wechat_api/materiallibrary/deleteMaterial - 调用方式: post - 备注:这个接口没有自动更新顺序,需要自行调用更新顺序的接口 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- deleteIds | List | Y | 删除素材的Id ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 ### 设置为公有/私人的/部门 - url: /wechat_api/materiallibrary/saveToPublicOrMyself - 调用方式:post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- isPublic | Integer | Y | 想转成的类型,0-是私人 1-是公共 2-部门 id | Long | Y | 素材Id ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 ### 置顶 - url: /wechat_api/materiallibrary/updateSort - 调用方式:post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- isPublic | Integer | Y | 想转成的类型,0-是私人 1-是公共 id | Long | Y | 素材Id type | Integer | Y | 素材类型 1-图文链接,2-视频,3-小程序 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 ### 新建文件夹 - url: /wechat_api/materiallibrary/addFolder - 调用方式:post /json ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- isPublic | Integer | Y | 想转成的类型,0-是私人 1-是公共,2-部门 type | Integer | Y | 素材类型 1-图文链接,2-视频,3-小程序,4-图片,5-文件 title | Integer | Y | 文件夹命名 source| String | N | 来源 ##### 请求示例: { "isPublic":1, "type":"4", "title":"文件夹命名1", "type":5 } ### 修改文件夹名称 - url: /wechat_api/materiallibrary/updateFolderOrFileTitle - 调用方式:post /json ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- isPublic | Integer | Y | 想转成的类型,0-是私人 1-是公共,2-部门 type | Integer | Y | 素材类型 4-图片,5-文件 title | Integer | Y | 文件夹命名 id| Long | Y | 主键id isFolder| Integer | Y | 是否文件夹 departId | Integer | N | 部门id ##### 请求示例: { "isPublic":1, "type":"4", "title":"文件夹命名1", "id":123, "isFolder":1 } ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 ### 查询该文件夹下的文件或图片数据 - url: /wechat_api/materiallibrary/getFolderList - 调用方式:get ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- id | Long | Y | 文件夹的id pageNo| Integer | Y | 页码 limit| Integer | Y | 数量 title| String| N |名称 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 data | List | 图片或文件 id | Long | 素材库Id adminUserId | Long | 用户Idid xml | String | 发送给腾讯中使用,xml格式 url | String | 素材的地址 imageUrl | String | 封面图的地址 title | String | 素材的标题 synopsis | String | 素材的摘要 source | String | 来源 type | Integer | 素材类型 1-图文链接,2-视频,3-小程序 isPublic | Integer | 是否是公共的 0-是私人 1-是公共 2部门 isFolder | Integer | 是否是文件夹 0-不是 1-是文件夹 departId | Integer | 部门id isPublic=2时使用 folderId | Integer | 文件夹id.二级文件. isPublic=2时,文件夹下的文件归属 ### 添加图片或文件 - url: /wechat_api/materiallibrary/addFileOrImg - 调用方式:post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- folderId | Long | N | 如果是新增在文件夹下的则需要填文件夹的id url | String | Y | 素材地址 title | String | Y | 文件或图片名 type | Integer | Y | 素材类型 1-图文链接,2-视频,3-小程序,4-图片,5-文件 isPublic | Integer | Y | 是否是公共的 0-是私人 1-是公共 2部门 sort | Integer | N | 排序 source | String | N | 来源 fileSize | Integer | Y | 文件大小 ##### 请求示例: { "folderId":"2837", "url":"https://siyouyunsy-1253559996.file.myqcloud.com/common/BUG44/signature%3D73511e8a865c6f36afd13f2b6e6ac0bceba4f44d", "title":"惊呆", "type":5, "isPublic":2 } ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 ### 移动图片或文件 - url: /wechat_api/materiallibrary/moveFileOrImg - 调用方式:post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- folderId | Long | N | 如果是移动到该文件夹下,则必填该参数 id | Long | Y | 图片或文件id ##### 请求示例: { "id":123 } ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 data | Object | 返回数据 (内容同获取素材库数据一致) ### V4.1.1 查询是否同步过个人素材库数据 - url: /wechat_api/materiallibrary/isSynced - 调用方式:get ##### 传参:无 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 data | boolean| true:同步过,false:未同步过 ##### 出参示例: ``` { "code": 200, "msg": "操作成功!", "data": true } ``` ### V4.1.1 同步个人旧素材库数据 - url: /wechat_api/materiallibrary/syncMyselfData - 调用方式:post ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- | --- | --- outSynced| Boolean| N | true:不再同步 ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | 状态码 msg | String | 消息 data | Object| ##### 出参示例: ``` { "code": 200, "msg": "操作成功!", "data": null } 或 { "code": 400, "msg": "已同步过个人素材库数据,请勿重复同步!", "data": null } ```