# 查询渠道码信息

请求方式： GET（HTTPS）

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

请求参数说明：

参数	必须	说明
app_id	是	企微中台应用 ID
channel_id	是	渠道 id

请求示例：

https://nbd-api.myscrm.cn/open-nbd-qw-channel/v1/channel-code/get?app_id=xxx&channel_id=xxx

返回数据：

{
  "errcode": 0,
  "errmsg": "ok",
  "channel_id": "39fea754-779c-2641-9131-a83de62c1c3e",
  "group_id": "39fe4b87-9047-1c56-6d1b-cb5d16b3ef4b",
  "channel_name": "渠道码名称",
  "type": 2,
  "app_id": "39fdde5b-f8cb-2246-cf8a-43902bd31084",
  "qw_users": [
    {
      "qw_user_id": "939fea758a72664cac50d8904cc51eff",
      "qw_user_name": "严玲"
    }
  ],
  "add_organ_tag": true,
  "organ_tags": [
    {
      "code": "channel_tag",
      "value": "1001"
    }
  ],
  "is_enabled": true,
  "welcome_type": 4,
  "preset_welcome_api_name": "智能名片",
  "preset_welcome_api": "http://a.com",
  "preset_welcome_code": "code-card",
  "welcome_text": "xxxx",
  "channel_attachments": [
    {
      "attachment_id": "39fea754-79e2-1391-509d-7fe5a20c677d",
      "type": 2,
      "is_custom_miniprogram": true,
      "miniprogram_title": "httpxx",
      "miniprogram_appid": "xxx",
      "miniprogram_url": "xx",
      "miniprogram_pic_url": "xx"
    }
  ],
  "is_fission": true,
  "organ_fission_id": "fuzz",
  "organ_fission_name": "裂变活动名称"
}

返回参数说明：

参数	说明
channel_id	渠道 id
group_id	所属渠道分组 id
channel_name	渠道名称
type	渠道类型：1-多人一码，2-批量单人码
app_id	所属企微中台应用 id
need_add_confirm	客户添加时是否需要员工确认
add_nickname_remark	是否开启扫码客户自动添加备注
nickname_remark	自动添加的昵称备注
add_description	是否开启扫码客户自动添加描述
client_description	自动添加的客户描述
is_enabled	是否有效
welcome_type	欢迎语类型：1-默认欢迎语，2-自定义欢迎语，3-不设置，4-预设欢迎语
welcome_text	欢迎语文本
preset_welcome_api_name	预设欢迎语 API 名称
preset_welcome_api	预设欢迎语 API 地址
preset_welcome_api_code	预设欢迎语 API code
add_tag	是否开启扫码客户自动添加标签
is_fission	是否裂变
organ_fission_id	接入方裂变 id
organ_fission_name	接入方裂变名称
organ_proj_id	所属项目 id
qw_users	关联员工的企微成员
qw_users.qw_user_id	企微里的 userid
qw_users.qw_user_name	企微成员姓名
corp_tags	自动添加的客户标签 id 列表，已被删除的标签不会再返回
corp_tags.id	标签 id
corp_tags.name	标签名称
corp_tags.create_time	标签创建时间
corp_tags.order	标签排序
corp_tags.deleted	是否已删除
add_organ_tag	是否开启接入方自定义标签
organ_tags	接入方自定义标签。add_organ_tag = true 时必传
organ_tags.code	标签 code
organ_tags.value	标签值
channel_attachments	欢迎语附件
channel_attachments.attachment_id	欢迎语附件 id
channel_attachments.type	附件类型：1-图片，2-小程序，3-H5，4-视频，5-文件
channel_attachments.img_url	图片 URL
channel_attachments.h5_href	h5 链接
channel_attachments.h5_title	h5 标题
channel_attachments.h5_description	h5 描述
channel_attachments.h5_cover_url	h5 封面
channel_attachments.video_url	视频 url
channel_attachments.file_url	文件 url
channel_attachments.is_custom_miniprogram	是否自定义小程序
channel_attachments.miniprogram_title	小程序标题
channel_attachments.miniprogram_appid	小程序 appid
channel_attachments.miniprogram_page_group	选择已有小程序时的页面分类
channel_attachments.miniprogram_page_name	选择已有小程序时的页面名称
channel_attachments.miniprogram_url	小程序路径
channel_attachments.miniprogram_pic_url	小程序封面 url

← 查询渠道码列表获取渠道二维码地址 →