页内打开对话

调用方法:ECHAT.customMiniChat(customObj)
描述:打开一个页内对话窗口,在当前网页中建立一个iframe打开对话。
效果图:

参数介绍:
customObj为json对象,json各属性描述如下:

属性名 类型 必须 描述 encode
echatTag String 否       对话入口参数。可传自定义字符串,比如:‘订单详情’ ‘product’ ‘after-sales’ ‘order’ 。用法1:可在“智能路由”里使用这个入口参数配置不同的路由规则 用法2:可用于分析数据,可到:数据分析-对话入口分析 查看 用法3:客服聊天界面会展示对话入口参数的具体内容,方便快速了解访客来源
lan String 打开对话窗口的语言,比如:en、zh、ja、de等
metaData String 会员对接中的会员加密身份信息,具体参见:业务系统集成
myData String 业务系统对接中传递的自定义业务数据,具体参见:业务系统集成
routeEntranceId String 接入对话的入口ID,入口id查看(更多设置-个性化-咨询入口)
visEvt String 图文消息,可对话开始前发送本次咨询的商品信息或者订单信息或者其他信息给客服。此属性的值为图文消息的json字符串,见下方详细描述
multipleFile String 是否支持上传多张图片:0:不支持 1:支持 默认为0 (最多上传9张图片)
chatWindowParam json PC新页面或者新窗口打开对话时设置的窗口参数。具体参数列表和含义见西方chatWindowParam个属性描述。
acdStaffId int 指派接待客服的ID(使用指定客服,scdStaffId 和 acdType都需必传)
acdType int 分配优先级,0-优先,1-指派
优先:客服在路由分配的组中,则优先分配给该名客服(在线/忙碌),不计接待能力。若客服「不在组中」或「在组中且离线(离开/隐身)」,则按照现有规则ACD分配规则
指派:只能由该客服进行服务。若客服「不在路由分配的组中」或「在组中且离线(离开/隐身)」,对话接待则进入下一个接待方式,留言/工单 则直接按全部分组分配给该名客服
formData String 业务主题数据业务主题字段

chatWindowParam 各属性描述:

属性名 类型 必须 描述
name String 是       打开新窗口的名字
width number 打开新窗口的宽度
height number 打开新窗口的高度
features String window.open的features参数
maxWidth number 对话窗口区域显示的最大宽度,如不设置宽度为窗口宽度
maxHeight number 对话窗口区域显示的最大高度,如不设置高度为窗口高度。
bgColor string 页面的背景颜色,在对话区域大小小于窗口大小时会看到背景颜色。例如:#ffffff 如不设置默认为 #ffffff
bgImage string 页面的背景图片,平铺。在对话区域大小小于窗口大小时会看到背景图片。bgImage存在时忽略bgColor参数。
bgRepeat number 背景图片平铺规则。0/1/2 默认为0. 居中实际大小显示。 1:拉伸平铺 2:重复平铺

visEvt图文消各属性描述:

属性名 类型 必须 描述
eventId String 否       图文消息的ID,可自定义前缀或者其他格式来通知业务系统图文消息的消息类型:比如:prod-123 ,order-123等
title String 图文消息的标题,如:新款风衣
content String 图文消息的描述,支支持div span style属性,如:产品的价格,优化信息等
imageUrl String 图文消息的图片地址
url(已废弃) String 客服端收到图文消息后点击图文消息的打开url
urlForVisitor String 图文消息提供给访客打开的url,可以为空。
url只允许为http[s]协议,支持新窗口打开以及对话窗口的互动窗口打开。协议格式:http(url,openType)
新窗口打开:http('http://m.echatsoft.com','blank')
互动窗口打开:http('http://m.echatsoft.com','inner')
urlForStaff String 图文消息提供给客服打开的url,可以为空。支持http[s]协议和apiUrl协议。
http协议和urlForVisitor参数中的http协议一致.
apiUrl协议:apiUrl(pageId,openType).
pageId:业务系统的页面ID
openType:打开类型 reload:重载打开 hash:不刷新已有的业务系统页面.
重载打开:apiUrl(123,'reload');
hash打开:apiUrl(123,'hash');
memo String 图文消息的描述,如:产品评价等
urlEnableForVisitor(已废弃) int 访客是否可点击图文消息打开设置的url。
1:可打开(默认)
0:不可打开
visibility int 图文消息的可见范围.
1:访客客服都可见(默认)
2:只有客服可见,访客不可见
customizeMsgType int 此消息的类型,关系到消息响应时长和访客会话条数指标。
1:访客/客服消息
2:系统消息 默认:首次打开对话窗口时携带的图文消息为系统消息

formData属性描述:

属性名 类型 必须 描述
chatSubject int 业务主题的id,该id是公司已存在的主题id;id>10
chatSubjectMemo String 业务主题评估的备注信息;最长不超过50
m1 - m10 String 业务自定义字段的value值;最长不超过50

图文消息效果图示如下:

示例代码:


function ECHATCustomMiniChat(echatTag, visEvt, lan, metaData, myData, routeEntranceId) { 
    var customObj= {}; 
    echatTag && (customObj.echatTag = echatTag); 
    visEvt && (customObj.visEvt = JSON.stringify(visEvt)); 
    lan && (customObj.lan = lan); 
    metaData && (customObj.metaData = metaData); 
    myData && (customObj.myData = myData); 
    routeEntranceId && (customObj.routeEntranceId = routeEntranceId); 
    ECHAT.customMiniChat(customObj); 
}