jarvis-js-sdk v1.7.1

Classes

Typedefs

Client

Kind: global class

• Client
  • new Client(handler, options)
  • instance
    • .open()
    • .close()
    • .isOpened() ⇒ boolean
    • .isConnecting() ⇒ boolean
    • .buildMessage(messageType, content, conversationId) ⇒ Message
    • .sendMessage(message, toId) ⇒ Promise
    • .recallMessage(messageId) ⇒ Promise
    • .readMessage(messageId) ⇒ Promise
    • .closeConversation(conversationId) ⇒ Promise
    • .inviteRate(userId) ⇒ Promise
    • .selectMenuItem(menuItemId) ⇒ Promise
    • .inputting(content, conversationId, toId) ⇒ Promise
    • .getUserInfo() ⇒ Promise
    • .updateMyProfile(data) ⇒ Promise
    • .getConversations(params) ⇒ Promise
    • .getConversationById(conversationId) ⇒ Promise
    • .updateUserProfile(id, data) ⇒ Promise
    • .rateStaff(score, suggestion, ratingTagIds) ⇒ Promise
    • .getVisitInfo(id) ⇒ Promise
    • .getPendingCount() ⇒ Promise
    • .addCustomerTag(id, data) ⇒ Promise
    • .deleteCustomerTag(id, tagId) ⇒ Promise
    • .getQuickReply() ⇒ Promise
    • .addQuickReply(data) ⇒ Promise
    • .editQuickReply(id, data) ⇒ Promise
    • .deleteQuickReply(id) ⇒ Promise
    • .adminCloseConversation(id) ⇒ *
    • .exportHistoryConversations(data) ⇒ Promise
    • .getTransferServiceList(params) ⇒ Promise
    • .conversationTransfer(id, data) ⇒ Promise
    • .requestConversations(data) ⇒ Promise
    • .getConversationsCount(params) ⇒ Promise
    • .uploadBlobs(file, onUploadProgress) ⇒ Promise
    • .likeRobotAnswer(id) ⇒ Promise
    • .dislikeRobotAnswer(msgId) ⇒ Promise
    • .getSuggestions(query, subChannelId) ⇒ Promise
    • .getPendingPosition(convId) ⇒ Promise
    • .getCurrentConversationList() ⇒ Promise
    • .getSubChannel(subChannelId) ⇒ Promise
    • .getHotFaqs(groupID, limit, page) ⇒ Promise
    • .getRatings() ⇒ Promise
    • .updateConversationRemark(id, data) ⇒ Promise
  • static
    • .getAnonymousToken() ⇒ Promise

new Client(handler, options)

构造函数

client.open()

打开WebSocket连接

Kind: instance method of Client

client.close()

关闭WebSocket连接

Kind: instance method of Client

client.isOpened() ⇒ boolean

WebSocket是否已开启

Kind: instance method of Client

client.isConnecting() ⇒ boolean

WebSocket是否正在连接

Kind: instance method of Client

client.buildMessage(messageType, content, conversationId) ⇒ Message

构造一条Message

Kind: instance method of Client

client.sendMessage(message, toId) ⇒ Promise

发送消息

Kind: instance method of Client
Returns: Promise - 当消息发送成功时resolve

client.recallMessage(messageId) ⇒ Promise

撤回消息

Kind: instance method of Client

client.readMessage(messageId) ⇒ Promise

消息已读

Kind: instance method of Client

client.closeConversation(conversationId) ⇒ Promise

关闭会话

Kind: instance method of Client

client.inviteRate(userId) ⇒ Promise

邀评，仅供客服调用

Kind: instance method of Client

client.selectMenuItem(menuItemId) ⇒ Promise

点选菜单项，仅供客户调用

Kind: instance method of Client

client.inputting(content, conversationId, toId) ⇒ Promise

正在输入

Kind: instance method of Client

client.getUserInfo() ⇒ Promise

获取个人信息

Kind: instance method of Client

client.updateMyProfile(data) ⇒ Promise

更新个人信息

Kind: instance method of Client

client.getConversations(params) ⇒ Promise

批量获取会话

Kind: instance method of Client

client.getConversationById(conversationId) ⇒ Promise

获取单条会话

Kind: instance method of Client

client.updateUserProfile(id, data) ⇒ Promise

更新用户信息

Kind: instance method of Client

client.rateStaff(score, suggestion, ratingTagIds) ⇒ Promise

评价客服

Kind: instance method of Client

client.getVisitInfo(id) ⇒ Promise

根据会话ID获取用户资料访问信息

Kind: instance method of Client

client.getPendingCount() ⇒ Promise

获取当前排队人数

Kind: instance method of Client

client.addCustomerTag(id, data) ⇒ Promise

增加访客标签

Kind: instance method of Client

client.deleteCustomerTag(id, tagId) ⇒ Promise

删除访客标签

Kind: instance method of Client

client.getQuickReply() ⇒ Promise

获取快速回复

Kind: instance method of Client

client.addQuickReply(data) ⇒ Promise

增加快速回复

Kind: instance method of Client

client.editQuickReply(id, data) ⇒ Promise

修改快速回复

Kind: instance method of Client

client.deleteQuickReply(id) ⇒ Promise

删除快速回复

Kind: instance method of Client

client.adminCloseConversation(id) ⇒ *

管理员强制关闭会话

Kind: instance method of Client

client.exportHistoryConversations(data) ⇒ Promise

导出历史会话

Kind: instance method of Client

client.getTransferServiceList(params) ⇒ Promise

获取客服用户列表（转接使用）

Kind: instance method of Client

client.conversationTransfer(id, data) ⇒ Promise

会话转接

Kind: instance method of Client

client.requestConversations(data) ⇒ Promise

历史会话发起会话

Kind: instance method of Client

client.getConversationsCount(params) ⇒ Promise

获取会话统计

Kind: instance method of Client

client.uploadBlobs(file, onUploadProgress) ⇒ Promise

上传附件

Kind: instance method of Client

client.likeRobotAnswer(id) ⇒ Promise

机器人满意回答

Kind: instance method of Client

client.dislikeRobotAnswer(msgId) ⇒ Promise

机器人不满意回答

Kind: instance method of Client

client.getSuggestions(query, subChannelId) ⇒ Promise

问题自动补全

Kind: instance method of Client

client.getPendingPosition(convId) ⇒ Promise

当前排队位置

Kind: instance method of Client

client.getCurrentConversationList() ⇒ Promise

获取当前会话列表

Kind: instance method of Client

client.getSubChannel(subChannelId) ⇒ Promise

获取渠道信息

Kind: instance method of Client

client.getHotFaqs(groupID, limit, page) ⇒ Promise

获取热门问题

Kind: instance method of Client

client.getRatings() ⇒ Promise

获取评分等级

Kind: instance method of Client

client.updateConversationRemark(id, data) ⇒ Promise

更改会话备注

Kind: instance method of Client

Client.getAnonymousToken() ⇒ Promise

获取匿名Token

Kind: static method of Client

OnOpen : function

WebSocket建立成功回调函数

Kind: global typedef

OnClose : function

WebSocket关闭回调函数

Kind: global typedef

OnError : function

WebSocket错误回调函数

Kind: global typedef

OnMessage : function

收到消息回调函数

Kind: global typedef

Message : Object

消息

Kind: global typedef
Properties

MessageType : 'Text' | 'Image' | 'Video' | 'Attachment'

消息类型，可以是以下字符串中任意一个

Kind: global typedef

OnConversationBuilt : function

会话建立回调函数

Kind: global typedef

OnConversationClosed : function

会话关闭回调函数

Kind: global typedef

OnMessageRecall : function

消息被撤回回调函数

Kind: global typedef

OnManualServiceStart : function

人工会话建立回调函数

Kind: global typedef

OnStaffBusy : function

客服繁忙回调函数

Kind: global typedef

OnStaffOffline : function

客服不在线回调函数

Kind: global typedef

OnMultipleLogin : function

多端登录回调函数

Kind: global typedef

OnConversationTransfer : function

会话转接回调函数

Kind: global typedef

OnInputting : function

会话转接回调函数

Kind: global typedef

OnStaffTimeout : function

客服回复超时回调函数

Kind: global typedef