IM链接引出简介

请使用  网页客服组件IM外链 中的方式替代该API

IM外链引出功能,能很方便的让企业通过更灵活的方式调用IM功能,并在多端,各种形式应用IM功能;IM外链引出能增加许多参数,以方便企业更灵活的应用此功能,具体请查看下面介绍。

此功能可以在系统下面位置设置和使用:

设置 > 网页客服组件 > 管理 > 组件引用

链接参数说明

不带任何参数的链接引出地址示例,其中1234为公司的随机生成ID号

https://yourdomain.kf5.com/kchat/1234

基础参数

下面是网页外链引出IM交谈框的基础参数,基础参数可以直接在系统内 网页客服组件 > IM外链引出 里自定义设置,并获取到带参数的链接


NameTypeComment
fromstring对话来源渠道,渠道名称将展示在对话侧栏及统计明细中
groupstring对话指定分配客服组
agentstring对话指定分配客服
forum_idsstring对话开启智能机器人后指定查询的帮助中心文档知识库的分类,可多选
category_idsstring对话开启智能机器人后指定查询的机器人题库的分类,可多选


基础参数示例地址

https://yourdomain.kf5.com/kchat/1234?from=system&agent=1234&forum_ids=1234,1235&category_ids=10,11

高级参数

下面是网页外链引出IM交谈框的高级参数,您可以根据实际情况向外链引出地址上额外增加这些参数,以实现数据传入功能


NameTypeComment
namestring用户的姓名或昵称
emailstring用户的邮箱地址
phonestring用户的手机号
metadatastring用户自定义信息,数组JSON字符串,每个元素是一个对象,每个对象包括两个键:name、value


高级参数示例地址

https://yourdomain.kf5.com/kchat/1234?from=system&agent=1234&forum_ids=1234,1235&category_ids=10,11&name=kf5&email=user@kf5.com&phone=13810111111&metadata=[{"name":"商品名称","value":"XXX手机"},{"name":"商品链接","value":"https://www.yourdomain.com/goods/xxxx.html"}]

注意:另需要对GET参数的值进行urlencode编码,实际访问时:

https://yourdomain.kf5.com/kchat/1234?from=system&agent=1234&forum_ids=1234,1235&category_ids=10,11&name=kf5&email=user@kf5.com&phone=13810111111&metadata=%5b%7b%22name%22%3a%22%e5%95%86%e5%93%81%e5%90%8d%e7%a7%b0%22%2c%22value%22%3a%22XXX%e6%89%8b%e6%9c%ba%22%7d%2c%7b%22name%22%3a%22%e5%95%86%e5%93%81%e9%93%be%e6%8e%a5%22%2c%22value%22%3a%22https%3a%2f%2fwww.yourdomain.com%2fgoods%2fxxxx.html%22%7d%5d

展示示例

传入的参数会在IM客服操作面板的侧栏里显示,客服可以对该信息进行确认、修改或者保存

总结

企业可以根据自己的场景灵活配置IM外链引出地址的参数,以达成实际的效果,非常灵活方便。