# 查询渠道码列表

请求方式： GET（HTTPS）

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

注意：该接口不会返回标识为隐藏的渠道码

请求参数说明：

参数	必须	说明
app_id	是	企微中台应用 ID
organ_proj_id	否	项目 id（organ_proj_id 和 group_id 都为空时，则返回全局项目下渠道码）
group_id	否	渠道码分组 id
keyword	否	关键词
pager	否	分页信息
pager.page	否	页码
pager.page_size	否	页数

请求示例：

https://nbd-api.myscrm.cn/open-nbd-qw-channel/v1/channel-code/list?app_id=xxx&organ_proj_id=xxx&group_id=xxx&keyword=xxx&pager.page=1&pager.page_size=10

返回数据：

{
  "errcode": 0,
  "errmsg": "ok",
  "channel_info_list": [
    {
      "channel_id": "39fea754-779c-2641-9131-a83de62c1c3e",
      "channel_name": "假装是裂变渠道码",
      "organ_proj_id": "",
      "organ_proj_name": "全局",
      "group_id": "39fe4b87-9047-1c56-6d1b-cb5d16b3ef4b",
      "group_name": "默认分组",
      "organ_fission_id": "fuzz",
      "organ_fission_name": "裂变活动名称",
      "channel_code_num": "1",
      "is_enabled": 1,
      "create_time": "2021-08-30 11:43:28",
      "modify_time": "2021-08-30 14:43:15"
    }
  ],
  "pager": {
    "page": "1",
    "page_size": "10",
    "total_rows": "1"
  }
}

返回参数说明：

参数	说明
channel_info_list	渠道码列表
channel_info_list.channel_id	渠道码 id
channel_info_list.channel_name	渠道名称
channel_info_list.organ_proj_id	关联项目 id
channel_info_list.organ_proj_name	关联项目名称
channel_info_list.group_id	渠道分组 id
channel_info_list.group_name	渠道分组名称
channel_info_list.activity_id	关联活动
channel_info_list.activity_name	关联活动名称
channel_info_list.channel_code_num	渠道码占用个数
channel_info_list.is_enabled	是否有效 1-有效 2-失效
channel_info_list.create_time	创建时间，格式 yyyy-mm-dd
channel_info_list.modify_time	修改时间，格式 yyyy-mm-dd
pager.page	页码
pager.page_size	分页行数
pager.total_rows	总行数

← 获取渠道分组查询渠道码信息 →