模板接口


通过本章节可获取H5、长页、海报、表单和互动类模板的分类列表,可用于模板选择的导航筛选功能。

平台模板分类

  • 接口描述:获取模板的分类列表。
  • 接口地址:/api/v1/base/tag/list/display?token=TOKEN
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    pId Long 标签父id,互动为5,H5为5000,海报为6000,长页为7000,表单为8000
  • 代码示例:
    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
      {
        "id": 5001,
        "title": "用途",
        "parentId": 5000,
        "sort": 5001,
        "status": 1,
        "children": [{
                      "id": 1001679,
                      "title": "红桃",
                      "parentId": 1001678,
                      "sort": 0,
                      "status": 1,
                      "children": null,
                      "bizCode": "5",
                      "relId": "1002",
                      "statusTitle": "正常",
                      "name": "红桃",
                      "type": 4
                  }],
        "bizCode": null,
        "relId": "0",
        "name": "用途",
        "type": 1
      },
      {
        "id": 5013,
        "title": "行业",
        "parentId": 5000,
        "sort": 5013,
        "status": 1,
        "children": null,
        "bizCode": null,
        "relId": "0",
        "name": "行业",
        "type": 1
      },
      ...
    ]
    }
    
  • 返回参数:
    参数 参数类型 说明
    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,默认为按时间降序排列
  • 代码示例:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": {
          "pageNo": 1,
          "count": 1,
          "pageSize": 24,
          "end": false
      },
      "list": [{
          "id": 31144,
          "code": "tmxuHyxP0",
          "title": "感恩回馈客户幸运大抽奖红色大转盘互动小游戏",
          "modifyTime": "2017-11-11T03:11:11",
          "description": "【玩法】点击中间按钮,转动大转盘即可抽奖;\n【场景】电商促销活动、现场抽奖互动;\n【用途】提升销售额、产品推广、店铺引流、品牌宣传。",
          "createTime": "2021-11-15T10:17:27",
          "createUser": "ff8080814edda3eb014ef19a58526f72",
          "coverUrl": "https://asset.eqxiu.cn/material/4cfc29835bf74746b621cdc389e434dd/1636966334682-hjz6bu3796i.png",
          "shareUrl":"http://xyz.eqshow.cn/template/v/33406?cc=tuoFNg3mU",
          "mobileShareUrl":"http://xyz.eqshow.cn/template/pv/33406?cc=tuoFNg3mU",
          "sourceId": 31144,
          "sort": 0,
          "views": 1637,
          "favorites": 0,
          "likes": 0,
          "price": 0,
          "status": 1,
          "productTypeMap": {
              "cover": "material/4cfc29835bf74746b621cdc389e434dd/1636966334682-hjz6bu3796i.png",
              "tplType": "2",
              "tmbPath": "material/4cfc29835bf74746b621cdc389e434dd/1636966334682-hjz6bu3796i.png",
              "longImagePath": "/store/2/d5a528909223ae1c4d69ae617779a78e.gif"
          },
          "bizType": 2
      }]
    }
    
  • 返回参数:

    参数 参数类型 说明
    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
  • 返回值

    {
      success:true,
      code:"200",
      obj:"9L-5KnDvOq"
    }
    
  • 备注
    将模版链接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条
  • 代码示例:
    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": {
      "pageNo": 1,
      "count": 4,
      "pageSize": 30,
      "end": true
    },
    "list": [
      {
        "id": 5309403,
        "code": "zGkxKwbv",
        "title": "未命名作品",
        "name": "未命名作品",
        "modifyTime": 1639561217750,
        "description": "轻松制作海报、邀请函、微信公号图,快来使用吧!",
        "categoryId": 0,
        "createTime": 1639561217750,
        "sourceId": 22643,
        "price": 0,
        "status": 1,
        "type": 0,
        "productTypeMap": {
          "cover": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "tmbPath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "answerPagePath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34"
        },
        "memberFreeFlag": "false",
        "count": 0,
        "sceneType": "design",
        "shareUrl":"http://xxx.xxx.xxx/ls/KOPfDmX9?id=9000515&tpl=1"
      }
    ]
    }
    
  • 返回参数:
    参数 参数类型 说明
    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
  • 代码示例:
    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": {
        "id": 5309403,
        "code": "zGkxKwbv",
        "title": "未命名作品",
        "name": "未命名作品",
        "modifyTime": 1639561217750,
        "description": "轻松制作海报、邀请函、微信公号图,快来使用吧!",
        "createTime": 1639561217750,
        "createUser": "9a1a23cb67f44583af968c989a735089",
        "sourceId": 22643,
        "sort": 0,
        "views": 1,
        "status": 1,
        "sourceUser": "9a1a23cb67f44583af968c989a735089",
        "type": 0,
        "productTypeMap": {
          "cover": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "tmbPath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "answerPagePath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34"
        },
        "memberFreeFlag": "false",
        "count": 0,
        "sceneType": "design"
      },
    "map":null,
    "list":null
    }
    
  • 返回参数:
    参数 参数类型 说明
    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:同步。默认同步
  • 代码示例:
    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list":  [
      {
        "id": 5309403,
        "code": "zGkxKwbv",
        "title": "未命名作品",
        "name": "未命名作品",
        "modifyTime": 1639561217750,
        "description": "轻松制作海报、邀请函、微信公号图,快来使用吧!",
        "createTime": 1639561217750,
        "createUser": "9a1a23cb67f44583af968c989a735089",
        "sourceId": 22643,
        "sort": 0,
        "views": 1,
        "status": 1,
        "sourceUser": "9a1a23cb67f44583af968c989a735089",
        "type": 0,
        "productTypeMap": {
          "cover": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "tmbPath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34",
          "answerPagePath": "/material/h2/9a1a23cb67f44583af968c989a735089/1aaa0aa2e4160c4865184435778d0042df34"
        },
        "memberFreeFlag": "false",
        "count": 0,
        "sceneType": "design",
        "shareUrl":"http://xxx.xxx.xxx/ls/KOPfDmX9?id=9000515&tpl=1"
      }
    ]
    }
    
  • 返回参数:
    参数 参数类型 说明
    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
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

查询企业模板标签

  • 接口描述:获取企业模板标签列表。
  • 接口地址:/api/v1/base/tag/list?token=TOKEN
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    pId Long 父标签id(pid=0时一级标签)
    querySubTag Boolean 是否查询下级标签
    bizType Integer 标签类型:2-企业自定义标签、3-员工自定义标签
    bizCode String 业务类型:template_corp(企业模板)
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
      {
        "id": 100038,
        "title": "东方闪电",
        "parentId": 317,
        "sort": 0,
        "status": 1,
        "children": null,
        "bizCode": null,
        "relId": "9a1a23cb67f44583af968c989a735089",
        "name": "东方闪电",
        "type": 3
      }
    ]
    }
    
  • 返回值说明:

    参数 参数类型 说明
    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
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

删除企业模板标签

  • 接口描述:删除一个企业模板标签。

  • 接口地址:/api/v1/base/tag/delete?token=TOKEN

  • 请求方式:POST

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    id Long 标签id
    bizType Int 标签类型:2-企业自定义标签
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

企业模板绑定标签

  • 接口描述:通过企业模板ID绑定标签。

  • 接口地址:/api/v1/biz/template/tag/corp/{templateId}?token=TOKEN

  • 请求方式:POST

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    templateId Long 模板id
    tagIds String 标签Ids 例:id1,id2,id3
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

企业模板使用记录

  • 接口描述:通过企业模板ID查询使用记录。

  • 接口地址:/api/v1/biz/template/record/{templateId}?token=TOKEN

  • 请求方式:GET

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    templateId Long 模板id
    pageNo Integer 分页查询,默认第一页
    pageSize Integer 分页查询,默认每页10条
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": {
      "pageNo": 1,
      "count": 1,
      "pageSize": 20,
      "end": true
    },
    "list": [
      {
        "count": 1,
        "corpId": "fb4c0dba6ded4d7db695715a0b56d89d",
        "staffId": "9a1a23cb67f44583af968c989a735089",
        "templateId": 5309544,
        "createTime": "2021-12-29 14:06:34",
        "deptNames": "我的企业",
        "avatar": null,
        "name": "管理员"
      }
    ]
    }
    
  • 返回值说明:

    参数 参数类型 说明
    count
    corpId
    staffId
    templateId
    createTime
    deptNames
    avatar
    name

企业模板使用汇总

  • 接口描述:获取模板统计数据(使用人数、生成作品数、累计浏览数(pv)、累计访客数(uv)、累计表单数)。

  • 接口地址:/api/v1/biz/template/corp/total/{templateId}?token=TOKEN

  • 请求方式:GET

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    templateId Long 模板id
  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": {
          "useTotal": 1,
          "creationTotal": 2,
          "pvTotal": 4,
          "uvTotal": 3,
          "formTotal": 0,
          "shareTotal": 0
      },
      "map": null,
      "list": null
    }
    
  • 返回值说明:

    参数 参数类型 说明
    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
  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": null,
      "list": [{
          "cover": "https://asset.eqxiu.cn/2305f122afa04fadb4216b49bc69caee/9a9cfd5e24e048409f0b457dccc79cb9",
          "creationName": "易企秀企业用户满意度问卷",
          "pvTotal": 4,
          "uvTotal": 3,
          "formTotal": 0,
          "shareTotal": 0,
          "createDate": "2022-08-26 14:08:10",
          "createUser": "谢均",
          "deptName": "子账号",
          "creationId": 69923,
          "publishStatus": 1,
          "staffId": "67770565fcf44e2496a0181f69336f88"
      }, {
          "cover": "https://asset.eqxiu.cn/2305f122afa04fadb4216b49bc69caee/9a9cfd5e24e048409f0b457dccc79cb9",
          "creationName": "易企秀企业用户满意度问卷",
          "pvTotal": 0,
          "uvTotal": 0,
          "formTotal": 0,
          "shareTotal": 0,
          "createDate": "2022-08-31 10:53:33",
          "createUser": "谢均",
          "deptName": "子账号",
          "creationId": 70552,
          "publishStatus": 0,
          "staffId": "67770565fcf44e2496a0181f69336f88"
      }]
    }
    
  • 返回值说明:

    参数 参数类型 说明
    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
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

获取企业模板关联的标签列表

  • 接口描述:获取企业模板关联的标签列表。

  • 接口地址:/api/v1/biz/template/tag/all?token=TOKEN

  • 请求方式:GET

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    templateId Long 模板id
  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": null,
      "list": [
          {
              "id": 300147,
              "title": "测试标签",
              "type": 2,
              "relId": "12b6f5e987f841e8b2047716f4d1e60b",
              "parentId": 300143,
              "sort": 0,
              "status": 1
          }
      ],
      "details": null
    }
    
  • 返回参数:

    参数 参数类型 说明
    id Long 标签id
    title String 标签名称
    parentId Long 上级id
    sort Int 排序
    status Int 1:有效 -1:删除
    relId String 企业ID
    title String 标签名称
    type Int 类型:企业配置

will 2024年3月21日 15:33 6110 收藏文档