API文档

# 数据渠道

# 新增渠道

# 接口说明

项 值
URL /v1/channel/add.json
描述 新增渠道
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
name string 名称，最长40字符。渠道名称不可重复。 是
desc string 描述，最长50字符 否
level int 渠道级别，取值范围 1~4 是

# 请求数据

{
    "name": "xxx",      // 名称，最长40字符。渠道名称不可重复。
    "desc": "xxxxxx",   // 描述，最长50字符
    "level": 1          // 渠道级别，取值范围 1~4 
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : "abc",     // 新增成功时，将返回渠道ID
    "pageDto": null
}

# 编辑渠道

# 接口说明

项 值
URL /v1/channel/mod.json
描述 编辑渠道信息
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 渠道ID 是
name string 名称，最长40字符。渠道名称不可重复。 否
desc string 描述，最长50字符 否
level int 渠道级别，取值范围 1~4 否
isEnabled int 0-禁用 1-启用 否

# 请求数据

{
    "id": "abc",        // 渠道ID
    "name": "xxx",      // 名称，最长40字符。渠道名称不可重复。
    "desc": "xxxxxx",   // 描述，最长50字符
    "level": 1,         // 渠道级别，取值范围 1~4
    "isEnabled": 1      // 0-禁用 1-启用
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : null,
    "pageDto" : null
}

# 获取渠道列表

# 接口说明

项 值
URL /v1/channel/list.json
描述 获取渠道列表
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
name string 根据渠道名模糊匹配 否
level int 根据渠道级别搜索，不填则返回全部 否
isEnabled int 根据渠道的开启状态搜索，0-禁用 1-启用，不填则返回全部 否
ids array 指定渠道id查询 否
pageSize int 每页显示数量（最大100） 否
pageNum int 页码 (从1开始) 否

# 请求数据

{
    "name": "",            // 根据渠道名模糊匹配
    "level": 1,            // 根据渠道级别搜索，不填则返回全部
    "isEnabled": 1,        // 根据渠道的开启状态搜索，0-禁用 1-启用，不填则返回全部
    "ids": ["", ""],       // 指定渠道id查询
    "pageDto" : {          // 分页信息
        "pageSize" : 20,   // 每页显示数量（最大100）
        "pageNum" : 1      // 页码 (从1开始)
    }
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : [
        {
            "id": "abc",                // 渠道ID
            "name": "SCRM官网",          // 渠道名
            "desc": "来自首页的自然流量",  // 描述
            "level": 1,                 // 渠道等级
            "isEnabled": 1,             // 当前渠道是否开启
            "childChannel": [{
              "name": "",            // 根据渠道名模糊匹配
              "desc": "来自首页的自然流量",  // 描述
              "level": 1,            // 根据渠道级别搜索，不填则返回全部
              "isEnabled": 1        // 根据渠道的开启状态搜索，0-禁用 1-启用，不填则返回全部
            }]
        }
    ],
    "pageDto" : {
        "pageSize" : 20,
        "pageNum" : 1,
        "count" : 1,
        "totalPageNum" : 1
    }
}

# 获取渠道信息

# 接口说明

项 值
URL /v1/channel/get.json
描述 获取渠道信息
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 渠道ID 是

# 请求数据

{
    "id": "abc"
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : {
        "id": "abc",                // 渠道ID
        "name": "SCRM官网",          // 渠道名
        "desc": "来自首页的自然流量",  // 描述
        "level": 1,                 // 渠道等级
        "isEnabled": 1,             // 当前渠道是否开启
        "childChannel": [{
          "id": "abc",                // 渠道ID
          "name": "",            // 根据渠道名模糊匹配
          "desc": "来自首页的自然流量",  // 描述
          "level": 1,            // 根据渠道级别搜索，不填则返回全部
          "isEnabled": 1        // 根据渠道的开启状态搜索，0-禁用 1-启用，不填则返回全部
        }]
    },
    "pageDto" : null
}

# 根据渠道获取渠道管理者联系二维码

# 接口说明

项 值
URL /v1/channel/getChannelMasterQrcode.json
描述 获取渠道信息
请求方式 POST
需要登录 否
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 渠道ID 是

# 请求数据

{
    "id": "abc"
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : "",   //企微联系我二维码链接
    "pageDto" : null
}

← 数据字典 →