通过本章节可获取H5、长页、海报、表单和互动类模板的分类列表,可用于模板选择的导航筛选功能。
平台模板分类
- 接口描述:获取模板的分类列表。
- 接口地址:
/api/v1/base/tag/list/display?token=TOKEN
- 请求方式:
GET
- 传参方式:
- 参数列表:
参数名 是否必须 参数类型 说明 pId 是 Long 标签父id,互动为5,H5为5000,海报为6000,长页为7000,表单为8000
- 代码示例:
- 返回参数:
参数 参数类型 说明 id Long 标签id title String 标签名称 parentId Long 上级id sort Int 排序 status Int 1:启用 children List 子标签 bizCode String 业务分类 relId String type=1时为0;type=2时为corp_id;type=3时为用户id;type=4时为平台id name String 标签名称 type Int 类型:1,系统自定义,2:企业配置;3:用户自定义;4:平台
平台模板列表
- 接口描述:获取当前账号权限的所有模板资源列表。
- 接口地址:
/api/v1/biz/template/list/display?token=TOKEN
- 请求方式:
GET
- 传参方式:
- 参数列表:
参数名 是否必须 参数类型 说明 name 否 String 模板名称,支持模糊匹配 type 是 String 作品类型 tagIds 否 String 标签id组,多个用英文逗号分割,例:”1,2,3” pageNo 否 Integer 分页查询,默认第一页 pageSize 否 Integer 分页查询,默认每页10条 orderBy 否 String 分页排序,排序值为hots:热度,create_time:时间 , 升序为asc 降序为desc 例如热度降序:hots desc,默认为按时间降序排列
代码示例:
返回参数:
参数 参数类型 说明 id Long 模板唯一标识数字型 code String 模板唯一标识字符型 title String 模板标题 description String 模板描述 coverUrl String 模板封面(完整) bizType int 模板类型 modifyTime Date 更新时间 createTime Date 创建时间 shareUrl String pc端预览链接 mobileShareUrl String 手机端预览链接 (需拼接code) createUser sourceId sort views int 浏览量 favorites likes int 点赞量 price status productTypeMap.cover String 模板封面 productTypeMap.tplType String 模板封面图 productTypeMap.tmbPath String 模板封面长图 productTypeMap.longImagePath String 作品描述 获取模版手机预览token
接口描述:获取模版手机预览token,有效期为30分钟
接口地址:/api/v1/editor/template/token?token=TOKEN
方法类型:POST
接口入参
参数名 是否必须 参数类型 参数说明 id 必须 Long 模版Id 返回值
备注
将模版链接mobileShareUrl例如【https://testg.eqxiu.cn/template/pv/33489?cc=】
拼装token后【https://testg.eqxiu.cn/template/pv/33489?cc=&token=9L-5KnDvOq】
拼装后的地址即可手机扫码体验,不过有效期为token有效期一致企业模板列表
接口描述:获取当前账号权限的企业模板资源列表。
接口地址:
/api/v1/biz/template/corp?token=TOKEN
请求方式:
POST
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 type 是 String 作品类型 tagIds 否 String 标签Ids,例:id1,id2,id3 name 否 String 模板名称 pageNo 否 Integer 分页查询,默认第一页 pageSize 否 Integer 分页查询,默认每页10条
- 代码示例:
- 返回参数:
参数 参数类型 说明 id Long 模板ID code String 模板唯一标识字符型 title String 模板标题 name modifyTime description String 模板描述 bizType int 模板类型 createTime Date 创建时间 modifyTime Date 更新时间 views int 浏览量 status type memberFreeFlag count sceneType shareUrl String 分享链接 productTypeMap.cover String 模板封面 productTypeMap.tmbPath String 模板封面长图 productTypeMap.longImagePath String 作品描述
模板信息
- 接口描述:根据模板ID获取模板信息。
- 接口地址:
/api/v1/biz/template?token=TOKEN
- 请求方式:
GET
- 传参方式:URL显式参数
- 参数列表:
参数名 是否必须 参数类型 说明 id 是 Long 模板ID
- 代码示例:
- 返回参数:
参数 参数类型 说明 id Long 模板ID code String 模板唯一标识字符型 title String 模板标题 name modifyTime description String 模板描述 bizType int 模板类型 modifyTime Date 更新时间 createTime Date 创建时间 createUser sourceId sort views int 浏览量 status sourceUser type memberFreeFlag count — — — sceneType — — — productTypeMap.cover String 模板封面 productTypeMap.tmbPath String 模板封面长图 productTypeMap.longImagePath String 作品描述
设置作品为企业模板
- 接口描述:将作品设置为企业模板。
- 接口地址:/api/v1/biz/template/corp/add?token=TOKEN&openId=OPEN_ID
- 接口地址:
/api/v1/editor/creation/corp/template/save?token=TOKEN&openId=OPEN_ID
- 请求方式:
POST
- 传参方式:URL显式参数
- 参数列表:
参数名 是否必须 参数类型 说明 creationIds 是 Long 作品ID,限制单次数量不超过10个 async 否 Boolean true:异步;false:同步。默认同步
- 代码示例:
- 返回参数:
参数 参数类型 说明 id Long 模板ID code String 模板唯一标识字符型 title String 模板标题 name modifyTime description String 模板描述 bizType int 模板类型 createTime Date 创建时间 modifyTime Date 更新时间 createUser sourceId sort views int 浏览量 status type memberFreeFlag count sceneType shareUrl String 分享链接 — — — productTypeMap.cover String 模板封面 productTypeMap.tmbPath String 模板封面缩略长图 productTypeMap.longImagePath String 模板封面长图
删除企业模板
接口描述:根据模板ID删除一个企业模板。
接口地址:
/api/v1/biz/template/corp/delete/{templateId}?token=TOKEN
请求方式:
GET
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id 返回值:
查询企业模板标签
- 接口描述:获取企业模板标签列表。
- 接口地址:
/api/v1/base/tag/list?token=TOKEN
- 请求方式:
GET
- 传参方式:
- 参数列表:
参数名 是否必须 参数类型 说明 pId 是 Long 父标签id(pid=0时一级标签) querySubTag 是 Boolean 是否查询下级标签 bizType 是 Integer 标签类型:2-企业自定义标签、3-员工自定义标签 bizCode 是 String 业务类型:template_corp(企业模板)
返回值:
返回值说明:
参数 参数类型 说明 id Long 标签id title String 标签名称 parentId sort status children bizCode relId name type
新增企业模板标签
接口描述:增加一个企业模板标签。
接口地址:
/api/v1/base/tag/add?token=TOKEN
请求方式:
POST
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 pId 否 Long 父标签id,值来源企业的模板标签(不传为一级标签) title 是 String 标签名称(不超过50个字符) bizType 是 Int 标签类型:2-企业自定义标签 bizCode 是 String template_corp-企业模板tag 返回值:
删除企业模板标签
接口描述:删除一个企业模板标签。
接口地址:
/api/v1/base/tag/delete?token=TOKEN
请求方式:
POST
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 id 是 Long 标签id bizType 是 Int 标签类型:2-企业自定义标签 返回值:
企业模板绑定标签
接口描述:通过企业模板ID绑定标签。
接口地址:
/api/v1/biz/template/tag/corp/{templateId}?token=TOKEN
请求方式:
POST
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id tagIds 是 String 标签Ids 例:id1,id2,id3 返回值:
企业模板使用记录
接口描述:通过企业模板ID查询使用记录。
接口地址:
/api/v1/biz/template/record/{templateId}?token=TOKEN
请求方式:
GET
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id pageNo 否 Integer 分页查询,默认第一页 pageSize 否 Integer 分页查询,默认每页10条 返回值:
返回值说明:
参数 参数类型 说明 count corpId staffId templateId createTime deptNames avatar name
企业模板使用汇总
接口描述:获取模板统计数据(使用人数、生成作品数、累计浏览数(pv)、累计访客数(uv)、累计表单数)。
接口地址:
/api/v1/biz/template/corp/total/{templateId}?token=TOKEN
请求方式:
GET
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id 返回值:
返回值说明:
参数 参数类型 说明 useTotal int 使用人数 creationTotal int 生成作品数 pvTotal int 累计浏览数(pv) uvTotal int 累计访客数(uv) formTotal int 累计表单数 shareTotal int 分享数(此字段数据仅供参考)
企业模板使用详情列表
接口描述:获取企业模板对应各个作品的使用详情。
接口地址:
/api/v1/biz/template/corp/detail/list/{templateId}?token=TOKEN
请求方式:
GET
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id userId 否 String 员工id deptId 否 Long 部门id 返回值:
返回值说明:
参数 参数类型 说明 cover String 作品封面 creationName String 作品名称 pvTotal int 累计浏览数(pv) uvTotal int 累计访客数(uv) formTotal int 累计表单数 shareTotal int 分享数(此字段数据仅供参考) createDate dateTime 创建日期 createUser String 创建人 deptName String 部门名称 creationId Long 作品id publishStatus int 发布状态 staffId String 员工id
企业模板标签解绑
接口描述:通过企业模板ID与标签进行解绑。
接口地址:
/api/v1/biz/template/tag/unbind?token=TOKEN
请求方式:
POST
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id tagIds 是 String 标签Ids 例:id1,id2,id3 返回值:
获取企业模板关联的标签列表
接口描述:获取企业模板关联的标签列表。
接口地址:
/api/v1/biz/template/tag/all?token=TOKEN
请求方式:
GET
传参方式:URL显式参数
参数列表:
参数名 是否必须 参数类型 说明 templateId 是 Long 模板id 返回值:
返回参数:
参数 参数类型 说明 id Long 标签id title String 标签名称 parentId Long 上级id sort Int 排序 status Int 1:有效 -1:删除 relId String 企业ID title String 标签名称 type Int 类型:企业配置