获取群活码详情
最后更新:2023/3/1企业可通过此接口获取群活码详情。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/qrcode/group_qr_code/detail
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"qrcode_id": 1619263549329161857
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
qrcode_id | long | 是 | 群活码id |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"status": "2",
"qrcode_id": 1619263549329161857,
"create_time": 1674897490,
"create_user_id": "admin",
"qrcode_name": "1231212",
"qrcode_type": 3,
"chat_group_tags": "",
"show_tag_list": null,
"kf_staff_qrcode_id": null,
"show_kf_staff_qrcode": null,
"enable_limit_join": 0,
"limit_join_time": null,
"limit_customer": null,
"limit_scan_result": null,
"limit_scan_show_materials": null,
"media_detail": null,
"enable_personal": 0,
"personal_title": "加入客户群 福利享不停",
"personal_guidance_top": "扫描下方二维码即可加入群聊",
"personal_template_id": null,
"personal_template_url": null,
"upload_template_id": null,
"personal_logo_image_url": null,
"qrcode_image_url": "https://javatest-1253767630.file.myqcloud.com/qrcode/20230128-9a083d6bc5c04290974431c58cff3eff.png",
"personal_qrcode_image_url": null,
"short_status": 1,
"app_image_status": 0,
"app_image_url": "",
"app_guidance_top": "加入客户群,福利享不停",
"sequence_qrcode": {
"rule": {
"rule_id": 1619263551321456257,
"auto_create": 0,
"base_name": "",
"base_id": 1
},
"chat_list": [
{
"owner": "YangJun",
"sort": 0,
"chat_relation_id": 1619263552604913282,
"chat_id": "wrDkH9EAAAGYKnMiRENqBJJzQAdl3OHA",
"chat_name": "测试群1"
}
]
},
"category_qr_codes": null
}
}
返回说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | obj | 群活码信息 |
qrcode_id | long | 群活码id |
create_time | long | 创建时间 |
create_user_id | string | 创建人id |
qrcode_name | string | 群活码名称 |
qrcode_type | int | 群活码类型,3:按顺序入群,4:按分类入群 |
status | string | 群活码状态,0:停用,1:创建中,2:启用中,-1:创建失败 |
chat_group_tags | string | 群标签,标签id,逗号分割 |
join_group_tips | obj | 加群提示 |
tag_id | string | 标签id |
tag_name | string | 标签名称 |
kf_staff_qrcode_id | long | 备用员工活码id |
show_kf_staff_qrcode | obj | 备用员工活码 |
kf_staff_qrcode_id | long | 备用员工活码id |
kf_staff_qrcode_name | string | 备用员工活码名称 |
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 | 限制扫码结果显示的素材信息 |
media_detail | media[] | 素材信息 |
id | long | 主键素材id |
type | int | 素材类型(1-海报, 2-文本, 3-图片, 4-文章, 5-语音, 6-视频, 7-文件, 8-小程序,9-外部链接) |
title | string | 素材标题 |
plain_text | string | plainText |
abstract_info | string | 摘要 |
image_base | long | 封面url的id |
image_base_url | string | 封面url地址 |
video_url | long | 视频文件的id |
video_cos_url | string | video cos 地址 |
video_file_full_name | string | 视频全称 |
file_url | long | 文件的id |
file_cos_url | string | 文件的cos地址 |
file_extension | string | 文件后缀 |
file_name | string | 文件名字 |
file_full_name | string | 文件全名 |
file_size | long | 文件大小(单位B) |
file_size_string | string | 文件大小 |
web_type | int | 网页种类 |
web_url | string | 网页地址 |
original_link | string | 原始链接 |
short_link | string | 短链接 |
app_id | string | 小程序id |
app_path | string | 小程序路径 |
app_original_id | string | 小程序原始id |
combination_id | long | 组合素材id |
package_config_id | int | 分类id |
send_type | int | 发送类型 1 轨迹发送 2 普通发送 |
enable_personal | int | 是否启用个性化设置,0:未启用,1:启用 |
personal_title | string | 个性化设置-群活码标题 |
personal_guidance_top | string | 个性化设置-引导语 |
personal_template_id | string | 个性化设置-活码模板id |
personal_template_url | string | 模板url |
upload_template_id | string | 上传的模板id |
personal_logo_image_url | string | 个性化设置-活码头像 |
qrcode_image_url | string | 群活码图片地址 |
personal_qrcode_image_url | string | 个性化群活码图片地址 |
short_status | int | 短链打开设置:1开启,0不开启 |
app_image_status | int | 小程序落地页配置:0默认,1自定义图片 |
app_image_url | int | 小程序落地页配置:自定义配置 |
app_guidance_top | int | 小程序落地页配置:默认引导语 |
sequence_qrcode | obj | 顺序进群配置 |
chat_list | obj[] | 选择的群聊列表 |
chat_relation_id | long | 活码关联群聊id |
chat_id | string | 群聊id,三方群聊id |
chat_name | string | 群名称 |
owner | string | 群主 |
sort | int | 排序字段,排序值,值越小排越靠前 |
rule | obj | 自动建群规则 |
rule_id | long | 规则id |
auto_create | int | 当群满了后,是否自动新建群,0-否;1-是。 默认为1 |
base_name | string | 自动建群的群名前缀,当autoCreate为1时有效 |
base_id | int | 自动建群的群起始序号,当autoCreate为1时有效 |
category_qr_codes | obj[] | 分类进群配置 |
category_id | long | 选择的群聊列表 |
category_name | string | 选择的群聊列表 |
sort | int | 排序字段,排序值,值越小排越靠前 |
chat_list | obj[] | 选择的群聊列表 |
chat_relation_id | long | 活码关联群聊id |
chat_id | string | 群聊id,三方群聊id |
chat_name | string | 群名称 |
owner | string | 群主 |
sort | int | 排序字段,排序值,值越小排越靠前 |
rule | obj | 自动建群规则 |
rule_id | long | 规则id |
auto_create | int | 当群满了后,是否自动新建群,0-否;1-是。 默认为1 |
base_name | string | 自动建群的群名前缀,当autoCreate为1时有效 |
base_id | int | 自动建群的群起始序号,当autoCreate为1时有效 |