# 获取渠道分组

请求方式: GET(HTTPS

请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-channel/v1/channel_group/list

请求参数说明:

参数 必须 说明
app_id 企微中台应用 id
is_all 是否全部项目(返回全局和全部项目,不考虑 organ_proj_id)
organ_proj_id 项目 id 为空时返回全局渠道分组,有值为指定项目
is_filter_empty_channel 是否过滤没有渠道码的分组,true-过滤无渠道码的分组
is_page 是否分页
pager 分页信息
pager.page 页码
pager.page_size 分页行数

请求示例:

https://nbd-api.myscrm.cn/open-nbd-qw-channel/v1/channel_group/list?app_id=xxx&is_all=false&organ_proj_id=xxx&is_filter_empty_channel=false&is_page=true&pager.page=1&pager.page_size=10

返回数据:

{
  "errcode": 0,
  "errmsg": "ok",
  "items": [
    {
      "group_id": "39fe21fb-7bd1-12e7-85a6-ceda76edf1fe",
      "group_name": "哈哈",
      "organ_proj_name": "全局",
      "channel_code_num": "8"
    }
  ],
  "pager": {
    "page": 1,
    "page_size": "2",
    "total_rows": "3"
  }
}

返回参数说明:

名称 备注
items 分组记录
group_id 渠道分组 id
group_name 分组名称
organ_proj_id 项目 id 空表示全局
organ_proj_name 项目名称
channel_code_num 渠道码数量
pager 分页参数
pager.page 页码
pager.page_size 分页行数
pager.total_rows 总行数