创建或修改识客码接口文档
最后更新:2025/09/18企业可通过此接口创建或修改识客码
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/qrcode/oldqrcode/createOrUpdateQrOldCode
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"creator_id": "",
"id": 0,
"name": "",
"logo": "",
"scan_range": 0,
"range_user_ids": [""],
"range_dept_ids": [""],
"old_tag_req_list": [
{
"tag_id": "",
"tag_type": 1,
"rule_group": 0
}
],
"old_material_info": {
"old_type": 1,
"material_id": 0,
"content_key": "",
"material_use_flag": 0,
"send_type": 1,
"qr_code_path": "",
"app_guide_word": "",
"jump_style": 0,
"app_path": ""
},
"qr_new_material_info": {
"join_state": 1,
"guide_title": "",
"type": 1,
"new_material_id": 0,
"new_content_key": "",
"material_use_flag": 0,
"qr_code_path": "",
"send_type": 1
},
"qr_code_id_list": [0],
"qrcode_type": 1
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
creator_id | string | 是 | 操作人id |
name | string | 是 | 识客码名称 |
logo | string | 否 | 活码头像地,仅支持填写素材中心的url,可通过【获取素材列表】接口获取指定图片素材的url。 |
scan_range | Integer | 是 | 老客类型;0: 已添加任意员工的客户;1:已添加指定员工的客户 |
range_user_ids | List |
否 | 员工列表,可填写员工id,「已添加指定员工的客户」里面配置的员工,如果老客类型为2,则此项和下面部门列表至少填写一个。 |
range_dept_ids | List |
否 | 部门列表,可填写部门id,「已添加指定员工的客户」里面配置的部门,如果老客类型为2,则此项和上面员工列表至少填写一个。 |
old_tag_req_list | List | 否 | 老客客户标签列表 |
tag_id | string | 否 | 标签id |
tag_type | Integer | 否 | 标签的类型:1-企业标签,2-个人标签(未使用),3-业务标签 |
rule_group | Long | 否 | 业务标签的时候使用规则组字段 |
old_material_info | Object | 是 | 老客素材跳转 |
old_type | Integer | 是 | 扫码打开类型 1.二维码,2.图片,3.网页,4.文章,5.小程序,6.聊天 |
material_id | Long | 否 | 扫码打开的素材,可填写素材id,如扫码打开类型为1到5,则必填。 扫码打开类型为1、2,填写为素材类型为图片的素材id; 扫码打开类型为3,则填写素材类型为网页的素材id; 扫码打开类型为4,则填写素材类型为文章的素材id; 扫码打开类型为5,则填写素材类型为小程序的素材id; |
content_key | String | 否 | 素材key-用于上下游的素材必填这个参数 |
send_type | Integer | 否 | 发送类型 1 轨迹发送 2 普通发送。扫码打开类型为3、4时填写生效 |
jump_style | Integer | 否 | 小程序的跳转样式 0:默认,1自定义样式 |
app_guide_word | String | 否 | 引导语文案,扫码打开类型为小程序时,设置的跳转页样式的引导语文案,最多14个字符,不填则默认文案为“打开小程序” |
app_path | String | 否 | 自定义图片,扫码打开类型为小程序时,设置的跳转页样式的自定义图片,可填写素材类型为图片类型的素材id; 扫码打开类型为小程序时,自定义图片和引导语文案必填,且只能填写一个 |
qr_new_material_info | Object | 否 | 新客扫码页设置信息 |
join_state | Integer | 否 | 0.客户跳过加好友,1.客户需要加好友 |
guide_title | String | 否 | 按钮文案 |
type | Integer | 否 | 类型: 1.二维码,2.图片,3.网页,4.文章,5.小程序 |
new_material_id | Long | 否 | 素材id |
qr_code_path | String | 否 | 二维码解析的地址 |
send_type | Integer | 否 | 发送类型 1 轨迹发送 2 普通发送 |
qrcode_type | Integer | 是 | 选中员工活码类型:1-员工活码,2-获客链接 |
qr_code_id_list | List |
是 | 活码或者获客链接id列表 |
返回值:
{
"code": 0,
"sub_code": "",
"msg": "",
"data": {
"id": 0
}
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回码,0-请求成功, |
msg | string | 对返回码的文本描述内容 |
data | object | 响应结果 |
id | Long | 识客码id |
code_url | string | 识客码二维码 |