创建群活码

最后更新：2024/12/26

重要通告:2023年12月1日00:00后购买安装的企业将无法调用此接口,具体原因可咨询相关产品人员或开发人员

企业可通过此接口创建群活码

请求方式： POST（HTTPS）

请求地址： https://open.wshoto.com/openapi/qrcode/group_qr_code/create

Query参数：

参数 类型 必填 说明
access_token string 是 调用接口凭证

Body参数：

{
  "create_user_id": "YuHang",
  "qrcode_name": "group name",
  "qrcode_type": 3,
  "sequence_qrcode" : {
    "chat_list" :  [
      {
        "chat_id" : "wrDkH9EAAAaMiBfahQxUzi0OOA2-iBxg"
      }
    ],
    "rule" : {
      "auto_create" : 0
    }
  }
}
参数 类型 必填 说明
create_user_id string 是 创建人id
qrcode_name string 是 群活码名称
qrcode_type int 是 群活码类型,3:按顺序入群,4:按分类入群
chat_group_tags string 否 群标签,标签id,逗号分割
kf_staff_qrcode_id long 否 备用员工活码id
enable_limit_join int 否 是否启用限制入群,0:未启用，1:启用
limit_join_time long 否 限制入群时间
limit_customer int 否 老客限制,0：不限制，1：限制已加入任意客户群，2：限制已加入当前活码任意客户群
limit_scan_result int 否 限制扫码结果,0：无法入群展示拦截页面，1：无法入群展示员工活码，2：无法入群打开图片或小程序
limit_scan_show_materials string 否 限制扫码结果显示的素材信息,素材id，多个用逗号分隔
enable_personal int 否 是否启用个性化设置,0:未启用，1:启用
personal_title string 否 个性化设置-群活码标题
personal_guidance_top string 否 个性化设置-引导语
personal_template_id string 否 个性化设置-活码模板id（实际选中的模板id）
upload_template_id string 否 上传的模板id
personal_logo_image_url string 否 个性化设置-活码头像
source_type int 否 来源类型,1.普通类型，2.抽奖类型，默认普通类型
short_status int 否 短链打开设置：1开启，0不开启
app_image_status int 否 小程序落地页配置：0默认，1自定义图片
app_image_url string 否 小程序落地页配置：自定义配置
app_guidance_top string 否 小程序落地页配置：默认引导语
sequence_qrcode object 否 顺序进群配置（qrcode_type为3时必填）
  chat_list object[] 否 选择的群聊列表
    chat_id string 否 群聊id
    sort int 否 排序字段,排序值,值越小排越靠前
    chat_relation_id long 否 活码关联群聊id,为空代表新增
    operation_type string 否 操作类型,如果传了delete代表删除当前行,delete:删除
  rule object 否 自动建群规则
    rule_id long 否 规则id
    auto_create int 否 当群满了后，是否自动新建群,0-否；1-是。 默认为1
    chat_id string 否 自动建群的群名前缀,当autoCreate为1时有效
    base_id int 否 自动建群的群起始序号,当autoCreate为1时有效
category_qr_codes object[] 否 分类进群配置（qrcode_type为4时必填）
  category_id long 否 分类id,为空代表新增分类
  category_name string 否 分类名称
  sort int 否 自动建群规则
  chat_list object[] 否 选择的群聊列表
    chat_id string 否 群聊id
    sort int 否 排序字段,排序值,值越小排越靠前
    chat_relation_id long 否 活码关联群聊id,为空代表新增
    operation_type string 否 操作类型,如果传了delete代表删除当前行,delete:删除
  rule object 否 自动建群规则
    rule_id long 否 规则id
    auto_create int 否 当群满了后，是否自动新建群,0-否；1-是。 默认为1
    chat_id string 否 自动建群的群名前缀,当autoCreate为1时有效
    base_id int 否 自动建群的群起始序号,当autoCreate为1时有效

返回值：


{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "qrcode_id": 1523204162751760294
  }
}

参数说明：

参数 类型 说明
code int 返回码
msg string 对返回码的文本描述内容
data obj 返回对象
qrcode_id long 活码id

results matching ""

    No results matching ""