NTalker

login logout startChat addUnreadMsgListener

概述

小能客服简介

小能客服成立于2007年，隶属于北京能通天下网络技术有限公司。作为智慧云客服解决方案服务商，一直是客服领域的先行者和倡领者。自2011年7月正式发布小能智慧客服平台以来，先后牵手各行业TOP知名企业，发布了9大行业解决方案，成为这些企业的长期战略合作伙伴。不仅如此，小能还联合华为、中国电信，发布了互联网呼叫中心，为企业用户提供更加完善、快捷的服务。

在集成此插件之前需要先配置config文件

  • 名称：NTalker

  • 参数：siteid

  • 描述：企业ID， 即企业唯一标识。格式示例：kf_9979，来源：开站邮件

  • 名称：NTalker

  • 参数：SDKKey

  • 描述：企业SDKkey，即小能通行密钥，来源：开站邮件

  • 配置示例:

<feature name="NTalker"> 
<param name="siteid" value="kf_9979" /> 
<param name="SDKKey" value="163114c8-31b5-4424-bb85-617f81cf54d9" /> 
</feature>

login

登陆

login(params)

params

userid:

  • 类型：字符串类型
  • 描述：登录用户的ID，小能识别用户身份唯一识别，不能重复，即不能传固定值！传值需要符合小能的传值规则 ：数字、英文字母和“@”、“.”、“_”三种字符。长度小于40,并且不能重复。

username:

  • 类型：字符串类型
  • 描述：（可选项）用户登录名称。传值需要符合小能的传值规则：字母、汉字、数字、_、@、.的字符串，长度小于32。 若用户游客身份则传入空字符串 ，系统随机会生成一个用户名, 如:“客人9527 ”。

userLevel:

  • 类型：数字类型
  • 描述：（可选项）登录用户的等级，1/0 0:普通用户 1：VIP用户
  • 默认：0

callback(ret, err)

ret:

  • 类型：JSON对象
  • 描述：登陆结果；
  • 内部字段：
{
     status:true  //布尔类型；是否登陆成功，true|false
     
}

err:

  • 类型：JSON对象
  • 描述：登陆结果；
  • 内部字段：
{
     code: '',           //字符串类型；错误码(code=2在android平台上表示重复登录，ios没有code=2的情况)
     msg: ''            //字符串类型；错误信息
}

示例代码

var NTalker = api.require('NTalker');
var params = {
        userid:'',
        username:'',
        userLevel:0
};
NTalker.login(params, function(ret, err) {
    if (ret.status) {
        api.alert({ msg:'登陆成功'});
    } else {
        api.alert({ msg:JSON.stringify(err)});
    }
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

logout

退出登陆

logout();

示例代码

var NTalker = api.require('NTalker');
NTalker.logout();

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

startChat

打开聊天页面

startChat();

params

settingid:

  • 类型：字符串类型
  • 描述：接待组ID，该组内必须有客服存在，两边不能有空格。
  • 来源：需要以管理员账号登陆小能PC客服端–>设置–>配置管理–>接待组–>接待组id，管理员账号由开站邮件提供

pushOrPresent:

  • 类型：布尔类型
  • 描述：（可选项）打开聊窗方式：push方式传true， present 方式：false，如果传错了，会导致返回方法失效！！！（仅ios有效）
  • 默认：true

kefuId:

  • 类型：字符串类型
  • 描述：（可选项）客服ID

kefuName:

  • 类型：字符串类型
  • 描述：（可选项）请求固定的客服(不建议使用)

userId:

  • 类型：字符串类型
  • 描述：（可选项）用户ID，(android不支持)

userName:

  • 类型：字符串类型
  • 描述：（可选项）用户名称，(android不支持)

productInfo：

  • 类型：JSON 对象
  • 描述：（可选项）商品信息
  • 内部字段：
{
   goodsId:'',            //商品id
   goodsURL:'',           //app端跳转的URL
   itemparam:'',          //商品扩展参数
   appGoods_type:0,       //app端展示规则 默认：0
                             0:不展示
                             1:传goodsid方式展示
                             2:webview方式:goods_showURL
                             3:数据方式展示:goods_imageURL;goodsTitle;goodsPrice;
   goods_imageURL:'',     //商品URL
   goodsTitle:'',         //商品标题	
   goodsPrice:'',         //商品价格	
   clientGoods_type:'',   //客户端展示规则 默认：0
                             0:不展示
                             1:传goodsid方式展示
                             2:传goods_showURL客服端直接展示(不推荐,此方法会影响客服端性能)		
   goods_showURL:''       //商品显示链接 
}

erpParams:

  • 类型：字符串类型
  • 描述：（可选项）erp信息

pageTitle:

  • 类型：字符串类型
  • 描述：（可选项）咨询发起页标题

pageURLString:

  • 类型：字符串类型
  • 描述：（可选项）咨询发起页URL

isSingle:

  • 类型：数字类型
  • 描述：（可选项）请求客服的方式,0:组内客服,-1:组间客服,1:固定客服，(android不支持)
  • 默认：0

isSimpleIntegration:

  • 类型：布尔类型
  • 描述：（可选项）集成类型，(android不支持)
  • 默认：true

defaultTitle:

  • 类型：字符串类型
  • 描述：（可选项）请求到客服前的默认导航栏标题显示内容，默认显示：”在线客服“ 比如商铺咨询入口想显示商铺名称，(android不支持)

isRefrashTitle:

  • 类型：布尔类型
  • 描述：（可选项）请求到客服后是否刷新导航标题显示内容：true：会更新成客服名称 false：保持显示默认标题不变，(android不支持)
  • 默认：true

isBackButtonHiden:

  • 类型：布尔类型
  • 描述：（可选项）返回按钮是否隐藏
  • 默认：false

isCancelButtonHiden:

  • 类型：布尔类型
  • 描述：（可选项）叉号按钮是否隐藏
  • 默认：false

isHaveVoice:

  • 类型：布尔类型
  • 描述：（可选项）设置是否有语音按钮 (true：有 false：没有)，(android不支持)
  • 默认：true

chat：

  • 类型：JSON 对象
  • 描述：（可选项）聊天界面设置，(android不支持)
  • 内部字段：
{
   chatBackgroundColor:'',             //设置聊天界面背景色；支持rgb、rgba、# 默认L：#f3f3f7
   inputViewBackgroundColor:'',        //设置输入工具条背景色；支持rgb、rgba、# 默认L：#f3f3f7
   emojiViewBackgroundColor:'',        //设置表情键盘背景色；支持rgb、rgba、# 默认L：#f3f3f7
   functionViewBackgroundColor:'',     //设置功能view背景色；支持rgb、rgba、# 默认L：#f3f3f7
 }

navigationBar：

  • 类型：JSON 对象
  • 描述：导航条样式配置
  • 内部字段：
{
    bgColor: '#d6d6d6',       //字符串类型；导航条背景色；默认：#d1d1d1(pushOrPresent为false无效)
    titleColor:‘’            //标题字体颜色，支持rgb、rgba、#  默认：#000000
}

示例代码

var NTalker = api.require('NTalker');
var params = {
        settingid:'',
        pushOrPresent: true
};
NTalker.startChat(params);

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

addUnreadMsgListener

未读消息的监听

addUnreadMsgListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     content:'',        //文本内容;
     settingId:'',      //客服组ID
     userName:'',       //客服名称
     unreadMsgNum:'',   //未读数量
}

示例代码

var NTalker = api.require('NTalker');
UIEaseChat.addUnreadMsgListener(function(ret) {
     api.alert({msg:ret});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24