员工活码创建

最后更新：2024/6/27

企业可通过此接口，创建员工活码

请求方式： POST（HTTPS）

请求地址： https://open.wshoto.com/openapi/qrcode/staff/v2/add

参数说明：

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

Body参数：

{
  "user_id": "admin",
  "qrcode_name": "活码名称",
  "qrcode_group_id": 0,
  "type": 1,
  "multiple_type": 1,
  "time_slice_list": [
    {
      "week_day": [
        "1",
        "2",
        "3"
      ],
      "start_time": "09:00",
      "end_time": "09:00",
      "user_list": [
        {
          "dept_id": null,
          "user_id": "Hwang"
        }
      ]
    }
  ],
  "stand_by_time_slice": {
    "dept_id": null,
    "user_id": "Hwang"
  },
  "day_add_up_mark": false,
  "staff_count_add_up_mark": false,
  "user_list": [
    {
      "dept_id": null,
      "user_id": "Wing",
      "day_add_up_number": 10,
      "staff_count_up_number": 50,
      "is_standby_staff": false
    }
  ],
  "without_confirm": 1,
  "time_list": [
    {
      "week_day": [
        "1",
        "2",
        "3"
      ],
      "start_time": "09:00",
      "end_time": "09:00"
    }
  ],
  "tag_list": [
    "tag_1",
    "tag_2"
  ],
  "channel_ids": "",
  "greeting_list": [
    {
      "greeting_type": 1,
      "greeting": "欢迎语",
      "week_day": [
        "1",
        "2",
        "3"
      ],
      "start_time": "09:00",
      "end_time": "09:00",
      "material_info_list": [
        {
          "type": 3,
          "id": 123456,
          "send_type": 2
        }
      ]
    }
  ],
  "greeting_other": {
    "greeting": "欢迎语",
    "material_info_list": [
      {
        "type": 3,
        "id": 123456,
        "send_type": 2
      }
    ]
  },
  "qrcode_model": "1",
  "model_title": "",
  "guide_msg": "引导语",
  "logo_img": "",
  "staff_promotion_flag": 0,
  "custom_remark": ""
}

参数说明：

参数 类型 必填 说明
user_id string 是 创建人user_id
qrcode_name string 是 活码名称
qrcode_group_id long 否 活码分组id，不填则为默认分组
type int 是 活码类型：1:单人，2：多人 必填
multiple_type int 否 使用员工，1-全天可添加，2-分时段添加，仅 type = 2时有效
time_slice_list TimeSlice[] 否 分时段添加使用员工配置,仅 multipleType = 2 生效且必填
  week_day string[] 否 星期，1:周一，2：周二，3：周三，4：周四，5：周五，6：周六，7：周日，多个数字之间用,隔开
  start_time string 否 开始时间 HH:mm,如：09:00
  end_time string 否 结束时间 HH:mm,如：09:00
  user_list User[] 否 用户列表，注意每个时段内员工和部门里面的员工id去重不得大于100
    dept_id string 否 部门id
    user_id string 否 员工id
stand_by_time_slice TimeSlice 否 其他分时段 multipleType = 2 有效且必填
  dept_id string 否 部门id
  user_id string 否 员工id
day_add_up_mark bool 否 每日添加上限标志：true:开启，false:关闭 仅type = 2有效
staff_count_add_up_mark bool 否 员工人数添加上限标志：true:开启，false:关闭 仅type = 2有效
user_list User[] 否 用户列表，用于填写全天可添加的员工、添加上限、备用员工，以及分时段可添加的添加上限、备用员工。
multiple_type不填时，则表示为单人活码，只能入参一个员工id，不支持填部门，也不支持填上限、备用员工。
multiple_type=1，则表示多人活码且全天可添加，员工和部门里面的员工id去重不得大于100，不包含备用员工；可分别定义员工和部门的添加上限；
multiple_type=2，则表示多人活码且分时段可添加，需填写分时段列表和默认时段列表数据；此处在day_add_up_mark或staff_count_add_up_mark为true时生效，可填写分时段、默认时段内员工的添加上限；
关于添加上限：如都未填写，则不会生效；部分填写部分未填写，则未填写的部分则默认上限为100；如同一个员工/部门填写多个上限，则以最高为准
备用员工，仅multiple_type=1和2时生效，备用员工和其他员工不得重复。
  is_standby_staff bool 否 是否备用员工
  dept_id string 否 部门id，和员工id至少且仅支持填写一个
  user_id string 否 员工id，和部门id至少且仅支持填写一个
  day_add_up_number int 否 员工通过本活码每日添加的客户数上限
  staff_count_up_number int 否 员工通过本活码累计添加的客户数上限
without_confirm int 是 验证标志，1-自动通过，2-手动通过，3-分时段自动通过 必填
time_list Time[] 否 通过时间，如填写了星期则开始和结束时间必填，请务必保证开始时间小于结束时间。
  week_day string[] 否 星期，1:周一，2：周二，3：周三，4：周四，5：周五，6：周六，7：周日
  start_time string 否 开始时间 HH:mm,如：09:00
  end_time string 否 结束时间 HH:mm,如：09:00
tag_list string[] 否 关联标签id，可填企业标签-企微标签、企业标签-内部标签、业务标签，最多20个标签，请输入对应标签id，多个标签之间用“;”隔开，其中业务标签仅支持导入创建人作为分级管理员的管理组对应的业务标签，超级管理员暂不支持设置业务标签
channel_ids string 否 获客渠道id，需按实际的获客渠道级联填写，每级之间用逗号分隔，可从获取自定义字段列表 · 企微管家API 获取渠道id信息。
greeting_list Greeting[] 否 欢迎语列表
  greeting_type int 否 欢迎语类型，1：固定欢迎语，2：分时段欢迎语
  greeting string 否 欢迎语内容，最多1300个字符
  week_day string[] 否 星期，1:周一，2：周二，3：周三，4：周四，5：周五，6：周六，7：周日；欢迎语类型为2时必填，如填写了星期则开始和结束时间必填，请务必保证开始时间小于结束时间。
  start_time string 否 开始时间 HH:mm,如：09:00
  end_time string 否 结束时间 HH:mm,如：09:00
  material_info_list Material[] 否 附件信息 重复入参相同的素材，会取第一个素材
    type string 否 素材类型 如填写附件则类型必填。 3：图片，4：文章，6：视频，7：文件，8：小程序，9：网页。附：暂不支持其他类型，如需使用可在页面选择素材，通过活码详情查看出参参数。
    id string 否 素材id
    send_type string 否 发送类型 1 以轨迹形式发送 2 以普通形式发送，附1：传入后系统都会记录，但是系统实际下发时仅轨迹素材生效。附2：针对视频、文件素材超过10M大小的、excel类型的文件素材，无论填写哪种类型，最后都以轨迹形式发送；
greeting_other Greeting 否 其他时段欢迎语
  greeting string 否 欢迎语内容，最多1300个字符
  material_info_list Material[] 否 附件信息 重复入参相同的素材，会取第一个素材
    type string 否 素材类型 如填写附件则类型必填。 3：图片，4：文章，6：视频，7：文件，8：小程序，9：网页 附：暂不支持其他类型，如需使用可在页面选择素材，通过活码详情查看出参参数。
    id string 否 素材id
    send_type string 否 发送类型 1 以轨迹形式发送 2 以普通形式发送，附1：传入后系统都会记录，但是系统实际下发时仅轨迹素材生效。附2：针对视频、文件素材超过10M大小的、excel类型的文件素材，无论填写哪种类型，最后都以轨迹形式发送；
qrcode_model string 否 活码模板，默认为100， 100指无模板， 填数字1 2 3 4 5固定模板，请参考页面对应的模板排序，自定义模板，通过自定义模板接口获取到模板id后填入。
model_title string 否 模板标题
guide_msg string 否 引导语
logo_img string 否 活码头像logo，可入参图片url
staff_promotion_flag int 否 使用员工是否可推广活码，0 否，1 是，默认是
custom_remark string 否 自定义备注名，选填，最多20个字符。支持客户昵称和添加日期的占位符，占位符可通过在前后输入#来表示。比如 “#添加日期#新客#客户昵称# ”，表示在客户昵称前面添加了日期占位符和文案新客。

返回值：


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

参数说明：

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

results matching ""

    No results matching ""