zhiChiSobot

• Method

startZhiChiSobot

getUnReadMessage

closeSobotChat

概述

智齿客服全面支持桌面网站、移动网站、微信、微博、APP五种接入方式，只要10分钟就可以将智齿客服嵌入所有营销路径，各渠道用户反馈汇总至智齿客服平台统一轻松管理，企业客服效率提升50%以上。

zhiChiSobot(原zhiChi升级版本)是一款实现手机用户与企业保持随时随刻沟通的客服工具。本模块封装了智齿客服的相关接口。使用此模块之前需要先注册智齿获取appkey

注册方法如下:

使用管理员账号登陆智齿管理后台，在 桌面网站客服 > APP >添加App 创建应用后可得到 appkey 用于配置。

注意：本模块在ios上支持最低版本为6.0

startZhiChiSobot

启动智齿客服

startZhiChiSobot(params)

params

初始化信息相关参数，适用于iOS和android系统(特殊说明除外)

appKey：

• 类型：字符串
• 默认值：无
• 描述：注册智齿后，从智齿后台获得的appKey，不可为空

platformUnionId：

• 类型：字符串
• 默认值：无
• 描述：智齿电商版唯一标识，注册智齿付费以后由智齿提供。（普通版本无效）。

transferKeyWord：

• 类型：字符串
• 默认值：无
• 描述：机器⼈模式下输⼊关键字主动转⼈⼯,多个请使用英文逗号隔开如”R,r,转人工”。可为空

receptionistId：

• 类型：字符串
• 默认值：无
• 描述：指定客服ID

tranReceptionistFlag：

• 类型：字符串
• 默认值：0
• 描述：定指客服时转接类型，0 可转入其他客服 1 必须转入指定客服（注意：如果当前指定的客服不在线，选择之后不能在转接到其他客服）

robotId：

• 类型：字符串
• 默认值：0
• 描述：对接机器人ID （可以转接到对应的机器人）

userId：

• 类型：字符串
• 默认值：无
• 描述：用户标识，自动备注客户资料，可为空（建议填写，对数据统计更准确，不填默认是设备唯一标识）

nickName：

• 类型：字符串
• 默认值：无
• 描述：用户昵称，可为空（填写后，客服后台会同步到备注）

phone：

• 类型：字符串
• 默认值：无
• 描述：用户电话，可为空

email

• 类型：字符串
• 默认值：无
• 描述：用户邮箱，可为空

qqNumber

• 类型：字符串
• 默认值：无
• 描述：用户QQ，可为空

avatarUrl

• 类型：字符串
• 默认值：无
• 描述：用户头像，可为空

sourceURL

• 类型：字符串
• 默认值：无
• 描述：接入的来源URL，可为空

serviceMode

• 类型：int
• 默认值：0
• 描述：自定义接入模式，1只有机器人,2.仅人工 3.智能客服-机器人优先 4智能客服-人工客服优先，可为空

userRemark

• 类型：字符串
• 默认值：无
• 描述：用户备注，可为空

customInfo

• 类型：json串
• 默认值：无
• 描述：自定义用户资料，自动同步到客户工作台，可为空

skillSetId

• 类型：字符串
• 默认值：无
• 描述：技能组编号，根据传递的值转接到对应的技能组，可选

skillSetName

• 类型：字符串
• 默认值：无
• 描述：技能组名称，可选

goodsTitle

• 类型：字符串
• 默认值：无
• 描述：内容描述，如果要显示必须填写；自定义咨询内容，在转接人工成功时，方便用户发送自己咨询的信息

goodsLabel

• 类型：字符串
• 默认值：无
• 描述：内容标签，如果要显示价格、分类等

goodsDesc

• 类型：字符串
• 默认值：无
• 描述：发送给客服的商品摘要，如果要显示必须填写；自定义咨询内容，在转接人工成功时，方便用户发送自己咨询的信息

goodsImage

• 类型：字符串
• 默认值：无
• 描述：图片URL；自定义咨询内容，在转接人工成功时，方便用户发送自己咨询的信息

goodsFromUrl

• 类型：字符串
• 默认值：无 必填，滨且是有效链接
• 描述：当前商品URL；自定义咨询内容，在转接人工成功时，方便用户发送自己咨询的信息

isCloseAfterEvaluation

• 类型：bool
• 默认值：NO
• 描述：评价完人工是否关闭会话,默认为NO。

isShowTansfer

• 类型：boolean
• 默认值：YES
• 描述：机器人优先模式，是否直接显示转人工按钮(值为NO时，会在机器人无法回答时显示转人工按钮)

isOpenRecord

• 类型：bool
• 默认值：YES
• 描述：是否开启语音功能，默认开启。

customUserOutWord

• 类型：字符串
• 默认值：无
• 描述：自定义用户超时下线提示语，默认为空。

customUserTipWord

• 类型：字符串
• 默认值：无
• 描述：自定义用户超时提示语，默认为空。

customAdminTipWord

• 类型：字符串
• 默认值：无
• 描述：自定义客服超时提示语,默认为空。

customRobotHelloWord

• 类型：字符串
• 默认值：无
• 描述：自定义机器人欢迎语,默认为空。

customAdminNonelineTitle

• 类型：字符串
• 默认值：无
• 描述：自定义客服不在线的说辞,默认为空。

customAdminHelloWord

• 类型：字符串
• 默认值：无
• 描述：自定义客服欢迎语,默认为空。

isShowEvaluate

• 类型：boolean
• 默认值：true
• 描述：点击返回时是否弹出满意度评价。默认true，弹出满意度评价，false不弹满意度。

customerFields：

• 类型：json串
• 默认值：无 例：{“weixin”:”55555”,”weibo”:”66666”,”userSex”:”女”,”birthday”:”2017-05-17”,”cardNo”:”142201198704102222”}
• 描述：固定KEY的自定义字段,设置用户自定义字段.(自定义字段的key参考 www.sobot.com登录成功—>设置—>自定义字段—>客户字段—>查看显示ID就是这里的key)

unWordsCount

• 类型：int
• 默认值：0
• 描述：未知问题或者向导问题出现 几次时，显示转人工按钮

isCustomLinkClick

• 类型：boolean
• 默认值：0
• 描述：自己处理消息中的链接，如果设置为1，将通过callBack返回到页面ret=1,value为link实际地址，desc为描述

isUseRobotVoice

• 类型：boolean
• 默认值：false
• 描述：是否使用机器人语音功能 默认false时机器人不可以使用语音功能。注意这是一个付费功能

titleImgId（仅适用Android）：

• 类型：int
• 默认值：#09aeb0
• 描述：设置头部为背景图片,可为空。 列：R.drawable.资源名称

themeColor（仅适用Android）：

• 类型：字符串
• 默认值：#09aeb0
• 描述：可设置头部颜色; 提交评价问题选中背景色以及提交评价按钮背景色; 聊天内容中，相似问题字体颜色和富文本类型中“阅读全文”字体颜色，可为空

isSetPhotoLibraryBgImage（仅适用iOS）:

• 类型：boolean
• 默认值：NO
• 描述：是否设置相册背景图片

isDebugMode（仅适用iOS）:

• 类型：boolean
• 默认值：NO
• 描述：根据此设置调用的推送证书，默认NO, NO:调用生产环境, YES:测试环境

自定义字体，（所有参数可选，并且仅适用iOS）

titleFont：

• 类型：Float
• 默认值：18.0
• 描述：顶部标题颜色、评价标题，可为空

listTitleFont：

• 类型：Float
• 默认值：16.0
• 描述：页面返回按钮，输入框，评价提交按钮、Toast提示语，可为空

listDetailFont：

• 类型：Float
• 默认值：14.0
• 描述：各种按钮，网络提醒，可为空

listTimeFont：

• 类型：Float
• 默认值：12.0
• 描述：消息提醒(转人工、客服接待等)，可为空

chatFont：（仅适用iOS）

• 类型：Float
• 默认值：15.0
• 描述：聊天气泡中文字，可为空

voiceButtonFont：

• 类型：Float
• 默认值：14.0
• 描述：录音按钮的文字，可为空

自定义背景颜色，（所有参数可选，并且仅适用iOS）

backgroundColor：

• 类型：字符串
• 默认值：#f0f0f0
• 描述：对话页面背景，可为空

customBannerColor：

• 类型：字符串
• 默认值：#08b0b0
• 描述：顶部banner颜色值，可为空

leftChatColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：左侧气泡颜色，可为空

rightChatColor：

• 类型：字符串
• 默认值：#08b0b0
• 描述：右边气泡颜色，可为空

backgroundBottomColor：

• 类型：字符串
• 默认值：#e6e9e9
• 描述：底部工具栏的背景颜色，可为空

bottomLineColor：

• 类型：字符串
• 默认值：#e6e9e9
• 描述：底部工具栏边框线颜色(输入框、录音按钮、分割线)，可为空

BgTipAirBubblesColor：

• 类型：字符串
• 默认值：#cacacb
• 描述：提示气泡的背景颜色，可为空

imagePickerColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：相册导航栏的颜色，可为空

imagePickerTitleColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：相册导航栏标题颜色，可为空

commentOtherButtonBgColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：评价普通按钮选中背景颜色和边框颜色，可为空

commentCommitButtonColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：评价(立即结束、取消)按钮文字颜色，可为空

commentCommitButtonBgHighColor：

• 类型：字符串
• 默认值：#089899
• 描述：评价提交按钮背景颜色和边框颜色，可为空

自定义文字颜色，（所有参数可选，并且仅适用iOS）

submitEvaluationColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：提价评价按钮的文字颜色，可为空

topViewTextColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：顶部文字颜色(返回、标题)，可为空

leftChatTextColor：

• 类型：字符串
• 默认值：#000000
• 描述：左边聊天气泡文字颜色，可为空

rightChatTextColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：右边聊天气泡文字颜色，可为空

timeTextColor：

• 类型：字符串
• 默认值：#666f6f
• 描述：聊天时间文字的颜色，可为空

tipLayerTextColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：提示气泡文字颜色，可为空

serviceNameTextColor：

• 类型：字符串
• 默认值：#67706e
• 描述：客服昵称文字颜色，可为空

nickNameTextColor：

• 类型：字符串
• 默认值：#888888
• 描述：提示cell中客服昵称文字颜色，可为空

chatLeftLinkColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：左边超链文字颜色，可为空

chatRightLinkColor：

• 类型：字符串
• 默认值：#0d81c0
• 描述：右边超链文字颜色，可为空

notificationTopViewLabelColor：

• 类型：字符串
• 默认值：#ffffff
• 描述：通告栏的文字颜色，可为空

notificationTopViewBgColor：

• 类型：字符串
• 默认值：#FFA500
• 描述：通告栏的背景色，可为空

satisfactionSelectedBgColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：评价页面中 已解决 未解决 按钮的选中的背景色，可为空

satisfactionTextSelectedColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：评价页面中 已解决，未解决 按钮的 高亮状态的文字颜色，可为空

2.7.9 新增（以下仅适用iOS）

realName：

• 类型：字符串
• 默认值：null
• 描述：用户的真实姓名

userSex：

• 类型：字符串
• 默认值：null
• 描述：用户的性别

notifitionIconUrl：

• 类型：字符串
• 默认值：nill
• 描述：通告的icon 的URL

platformKey：

• 类型：
• 默认值：#FFFFFF
• 描述：私钥

isEnableHotGuide：

• 类型：字符串
• 默认值：false
• 描述：是否允许请求热点引导问题接口

hotguideDict：

• 类型：字符串
• 默认值：nil
• 描述：热点引导问题的扩展字段

isEnableAutoTips：

• 类型：字符串
• 默认值：false
• 描述：机器人问答是否支持分词联想

goodMsgType：

• 类型：int
• 默认值：0
• 描述：自定发送商品订单信息类型

goodMsg：

• 类型：字符串
• 默认值：nil
• 描述：自动发送商品订单信息内容

queueFirst：

• 类型：字符串
• 默认值：int
• 描述：指定客户优先

isShowPortrait：

• 类型：BOOL
• 默认值：false
• 描述：仅支持竖屏

navcBarHidden：

• 类型：BOOL
• 默认值：false
• 描述：SDK 页面中使用自定义的导航栏不在使用 系统的导航栏

canSendLocation：

• 类型：BOOL
• 默认值：false
• 描述：人工状态，是否可以发送位置

isShowEvaluation：

• 类型：字符串
• 默认值：false
• 描述：导航栏右上角 是否显示 评价按钮 默认不显示

isShowCloseSatisfaction：

• 类型：字符串
• 默认值：false
• 描述：针对关闭按钮，单独设置是否显示评价界面，默认不显示

isShowTelIcon：

• 类型：字符串
• 默认值：false
• 描述：导航栏右上角 是否显示 拨号按钮 默认不显示 注意：和isShowEvaluation 互斥 只能设置一个有效

isShowClose：

• 类型：字符串
• 默认值：false
• 描述：导航栏左上角 是否显示 关闭按钮 默认不显示，关闭按钮，点击后无法监听后台消息

customTel：

• 类型：字符串
• 默认值：null
• 描述：设置电话号码

isUseImagesxcassets：

• 类型：BOOL
• 默认值：false
• 描述：是否使用Images

isOpenActiveUser：

• 类型：BOOL
• 默认值：false
• 描述：是否开启智能转人工,(如输入“转人工”，直接转接人工)

satisfactionTextSelectedColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：评价页面中 已解决，未解决 按钮的 高亮状态的文字颜色，可为空

scoreExplainTextColor：

• 类型：字符串
• 默认值：#faba4a
• 描述：满意度星级说明的文字颜色

trunServerBtnColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述：机器人的问答中 提示转人工按钮的文字颜色

notificationTopViewLabelFont：

• 类型：字符串
• 默认值：14.0
• 描述：通告栏的字体设置

satisfactionTextColor：

• 类型：字符串
• 默认值：#999999
• 描述：提交评价后将结束会话的文字颜色

noSatisfactionTextColor：

• 类型：字符串
• 默认值：#bbbbbb
• 描述： 暂不评价文字颜色

chatLeftMultColor：

• 类型：字符串
• 默认值：#4D9DFE
• 描述：多轮会话模板四的超链颜色

openMoreBtnTextColor：

• 类型：字符串
• 默认值：#0daeaf
• 描述：多轮会话中 展开和收起的文字颜色

moreBtnNolImg：

• 类型：字符串
• 默认值：nill
• 描述：更多按钮默认图片

moreBtnSelImg：

• 类型：字符串
• 默认值：nill
• 描述：更多按钮选中图片

turnBtnNolImg：

• 类型：字符串
• 默认值：nill
• 描述： 转人工按钮默认图片

turnBtnSelImg：

• 类型：字符串
• 默认值：nill
• 描述：转人工按选中图片

topBackNolImg：

• 类型：字符串
• 默认值：nill
• 描述：返回按钮默认图片

topBackSelImg：

• 类型：字符串
• 默认值：nill
• 描述：返回按钮选中图片

topBackNolColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：返回按钮的默认背景色

topBackSelColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：返回按钮的高亮背景色

topViewBgColor：

• 类型：字符串
• 默认值：#FDF6D7
• 描述：导航栏背景色 （单独修改）

satisfactionTextSelectedColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：评价页面中 已解决，未解决 按钮的 高亮状态的文字颜色，可为空

topBtnNolColor：

• 类型：字符串
• 默认值：#3D4966
• 描述：顶踩 文字 默认颜色

topBtnSelColor：

• 类型：字符串
• 默认值：#4D9DFE
• 描述：顶踩 文字 选中颜色

topBtnGreyColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：顶踩 文字 置灰颜色

topBackTitle：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：聊天页面 左上角 返回按钮的文字 （默认 返回）

leaveSubmitBtnTextColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：留言页面中 提交按钮的文字颜色

leaveSubmitBtnImgColor：

• 类型：字符串
• 默认值：#2fb9c3
• 描述： 留言页面中 提交按钮的背景颜色

scTopTextColor：

• 类型：字符串
• 默认值：#333333
• 描述：帮助中心 标题的文字颜色

scTopTextFont：

• 类型：字符串
• 默认值：14
• 描述：帮助中心 标题font

scTopBgColor：

• 类型：字符串
• 默认值：#FAFAFA
• 描述：帮助中心 导航条背景色

scTopBackTextColor：

• 类型：字符串
• 默认值：#FFFFFF
• 描述：帮助中心 顶部返回的文字颜色

scTopBackTextFont：

• 类型：字符串
• 默认值：14.0
• 描述：帮助中心 顶部返回按钮的文字字号

isSendInfoCard：

• 类型：BOOL
• 默认值：false
• 描述：商品卡片信息是否自动发送（转人工成功时，自动发送商品卡片信息）

示例代码

var param = {
    appkey:"f9caa813546b42c98d5f5701f6d1c30d",
    userId:"Your userId",
    nickName:"Your nickName",
    phone:"Your user phone",
    email:"Your email",
    customInfo:{"age":"18","uname":"智齿APICloud"},
    isShowEvaluate:true,
    isSettingSkillSet:false,
    skillSetId:"",
    isShowTansfer:true,
    titleFont:18.0,
    backgroundColor:"#f0f0f0",
    topViewTextColor:"#FFFFFF",
    isCustomLinkClick:false,
};
function callBack(ret,err){
    alert("ret.type="+ret.type+"\nvalue="+ret.value+"\nret.desc="+ret.desc);
}
var zhichi = api.require('zhiChiSobot');
zhichi.startZhiChiSobot(param,callBack);

getUnReadMessage

获取未读消息数

getUnReadMessage(params)

params

无需参数

示例代码

function getUnRead(){
        var zhiChiSobot = api.require('zhiChiSobot');
        var param = {
        };
        zhiChiSobot.getUnReadMessage(param,function(ret){
                                               alert("ret.type="+ret.type+"\nvalue="+ret.value+"\nret.desc="+ret.desc);
                                               });
    }

closeSobotChat

离线用户

closeSobotChat(params)

params

离线用户参数说明，适用于iOS和android系统(特殊说明除外)

isClosePush（仅适用iOS）:

• 类型：boolean
• 默认值：NO
• 描述：是否同时关闭推送(离线用户后，可以继续接受客服推送的离线消息;如果没有开启推送，无需关注)

示例代码

    function closeChat(){
        var zhiChiSobot = api.require('zhiChiSobot');
        zhiChiSobot.closeSobotChat({"isClosePush":true});
    }

补充说明

使用此模块，必须先传入appkey参数，其它参数可根据自己实际情况选择设置；

回调函数说明

ret：

• 类型：字典

• 描述：包含3个参数

  type:1、返回，2、点击链接（仅当isCustomLinkClick=1时触发），3、新消息，4、获取未读消息

  value: 【 type=2:链接地址
  type=3:当前未读消息内容
  type=4:未读消息数】

  desc:当前操作

err：未使用

可用性

iOS系统

可提供的2.7.12版本