多人分发接口


支持基于同一个作品生成每个成员的个人专属链接进行传播,并独立统计每个成员的传播情况(pv、uv、表单收集量等)

注意事项

  1. 多次保存时,若成员与已存在的成员重复,则添加时跳过重复的人。若渠道名称与当前列表重复,则添加时跳过重复的渠道。

保存分发

  • 接口描述:创建分发数据

  • 接口地址:/api/v1/editor/creation/distribute/save/{creationId}?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json 数组

  • 接口入参:

    参数名 必须 参数类型 参数说明
    id String 唯一标识,如果传递则作为该分发数据的唯一标识,建议格式:作品id_xxx,保证全局唯一(最大长度为32)
    creationId Long 作品唯一标识
    relType Int 关联类型:1.渠道 2.成员
    relId String 关联的唯一标识,当rel_type为1时,为’’,为2时为员工的id(取查询员工列表返回的id)
    name String 名称,最大长度为256
  • 请求示例:

    [
    {
      "name": "open@test",
      "creationId": 25485,
      "relType": 2,
      "relId": "b95804db510849dfa0cf566d25c9dbc4"
    },
    {
      "name": "open@test222",
      "creationId": 25485,
      "relType": 2,
      "relId": "01a375ebbabb40d6931b03dce4276ae4"
    },
    {
      "id": "25485_000d8248a385439895b4f3f72497fd2c",
      "relType": 1,
      "name": "渠道1",
      "creationId": 25485
    },
    {
      "relType": 1,
      "name": "渠道2",
      "creationId": 25485
    }
    ]
    
  • 接口出参:

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

查询分发列表

  • 接口描述:查询分发列表

  • 接口地址:/api/v1/editor/creation/distribute/list?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    creationId Long 作品唯一标识
    relType Int 关联类型:1.渠道 2.成员
  • 请求示例:

    {
    "creationId": 25485
    }
    
  • 接口出参:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
      {
        "id": "3728574e1dbf461c95007f458eea941e",
        "relType": 1,
        "name": "渠道22",
        "deptName": null,
        "avatar": null,
        "staffDelFlag": 0,
        "self": 0,
        "relId": null,
        "code": null,
        "shareUrl": "https://cn3liobq.eqxiu.cn/fv/pLOA8Ivy?e_ff_i=3728574e1dbf461c95007f458eea941e"
      },
      {
        "id": "672ed43393fe4e1786b35cb54a180745",
        "relType": 1,
        "name": "渠道1",
        "deptName": null,
        "avatar": null,
        "staffDelFlag": 0,
        "self": 0,
        "relId": null,
        "code": null,
        "shareUrl": "https://cn3liobq.eqxiu.cn/fv/pLOA8Ivy?e_ff_i=672ed43393fe4e1786b35cb54a180745"
      },
      {
        "id": "d70129bb49004cf29ad1ee9119c66e30",
        "relType": 1,
        "name": "渠道1\n渠道2",
        "deptName": null,
        "avatar": null,
        "staffDelFlag": 0,
        "self": 0,
        "relId": null,
        "code": null,
        "shareUrl": "https://cn3liobq.eqxiu.cn/fv/pLOA8Ivy?e_ff_i=d70129bb49004cf29ad1ee9119c66e30"
      },
      {
        "id": "1db2513d8115429d81a327de04fdca51",
        "relType": 2,
        "name": "open@test222",
        "deptName": "我的企业",
        "avatar": null,
        "staffDelFlag": 0,
        "self": 0,
        "relId": "01a375ebbabb40d6931b03dce4276ae4",
        "code": "2202158",
        "shareUrl": "https://cn3liobq.eqxiu.cn/fv/pLOA8Ivy?e_ff_i=2202158"
      },
      {
        "id": "ff622092b409485989093a64c3ac9c7a",
        "relType": 2,
        "name": "open@test",
        "deptName": "我的企业",
        "avatar": null,
        "staffDelFlag": 0,
        "self": 0,
        "relId": "b95804db510849dfa0cf566d25c9dbc4",
        "code": "2202146",
        "shareUrl": "https://cn3liobq.eqxiu.cn/fv/pLOA8Ivy?e_ff_i=2202146"
      }
    ]
    }
    

    参数说明

    参数名 必须 参数类型 参数说明
    id String 分发唯一标识
    relType Int 关联类型:1.渠道 2.成员 (这里只能传1)
    name String 名称,最大长度为256
    deptName String 部门名称
    avatar String 头像
    staffDelFlag Int 员工是否删除 0-未删除 1-已删除
    relId String 员工的id(取查询员工列表返回的id)
    code String 员工code
    shareUrl String 分享url

修改分发渠道

  • 接口描述:修改分发的渠道名称

  • 接口地址:/api/v1/editor/creation/distribute/update?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    id String 分发唯一标识
    relType Int 关联类型:1.渠道 2.成员 (这里只能传1)
    name String 名称,最大长度为256
  • 请求示例:

    {
    "id": "3728574e1dbf461c95007f458eea941e",
    "name": "渠道22",
    "relType": 1
    }
    
  • 接口出参:

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

删除分发

  • 接口描述:删除分发数据,这里不会删除已产生的相关数据

  • 接口地址:/api/v1/editor/creation/distribute/delete?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    id String 分发唯一标识
  • 请求示例:

    ["3728574e1dbf461c95007f458eea941e"]
    
  • 接口出参:

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

第三方渠道批量添加

  • 接口描述:批量添加第三方渠道
  • 接口地址:/api/v1/editor/creation/distribute/third-channel?token=TOKEN&openId=OPENID
  • 请求方式:POST
  • 请求格式:json
  • 接口入参:
    参数名 必须 参数类型 参数说明
    creationId String 作品id
    thirdChannels.relId String 渠道唯一标识id
    thirdChannels.name String 渠道名称
  • 请求示例:

    {
      "creationId": 35638,
      "thirdChannels": [
          {
              "relId": "1",
              "name": "测试1"
          },
          {
              "name": "测试3"
          }
      ]
    }
    
  • 接口出参:

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

will 2024年9月10日 09:48 5509 收藏文档