emicnet-bs-sdk v1.0.54

易米 SDK

概述

将 bs 客户端所有通话相关的操作和消息推送整合在这 SDK 中。

安装

// or pnpm
npm i emicnet-bs-sdk

接口及使用方式

初始化 （init）

// 引入
import sdk from 'emicnet-bs-sdk'

// 参数及回调初始化
const { status, message } = sdk.init(params)
// message maybe is a ParamsError information

// or
sdk.init(params, ({ status, message }) => {})

init 参数说明

params 参数说明

示例代码

const { status, message } = sdk.init(params)

sdk.on('WSReady', ({ status, message }) => {})

sdk.init() 的返回值中，status === 1 代表初始化完成，不代表初始化成功。

初始化是否成功需要通过监听 sdk.on('WSReady', ({ status, message }) => {}), 判断 status 是否等于 1，status === 1 则代表 websocket 连接成功并使用传入的坐席信息通过了 websocket 服务器的验证，此时才是初始化成功。如果 status === 0，通过 message 可以得知原因。

message 的值包括 success，failed，disconnect，${ error }; success 表示连接上服务器并鉴权成功；failed 表示连接上服务器但是鉴权失败。

实例销毁 （destroy）

用于销毁当前的 SDK 实例。

sdk.destroy()

sdk.destroy() 内部的逻辑主要是释放内存和断连 websocket。

websocket 重连 （wsReconnect）

用于手动重新连接 websocket。

sdk.wsReconnect()

websocket 断连 （wsDisconnect）

用于手动断开 websocket 连接。

sdk.wsDisconnect()

token 更新（refreshToken）

用于更新在 sdk.init() 中传入的 token。

sdk.refreshToken(token)

参数说明

签入（checkIn）

用于将签入坐席。

try {
    const { code, data } = await sdk.checkIn(params)
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

签出（checkOut）

用于签出坐席。

try {
    const { code, data } = await sdk.checkOut(params)
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

置闲（setReady）

用于设置坐席为空闲状态。

try {
    const { code, data } = await sdk.setReady()
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

置忙（setBusy）

用于设置坐席为忙碌状态。

try {
    const { code, data } = await sdk.setBusy(params)
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

坐席模式切换（changeSeatMode）

用于设置坐席为移动坐席或固定坐席。

try {
    const { code, data } = await sdk.changeSeatMode(params)
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

坐席开启夜间模式（setNightMode）

用于为坐席开启夜间模式。

try {
    const { code, info } = await sdk.setNightMode(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

预设忙碌（preSetBusy）

在通话中时，可将坐席通话结束后的状态设置为忙碌。

try {
    const { code, data } = await sdk.preSetBusy(params)
    // code === 200 代表接口调用成功
    // data.data.status 是 CR 给的状态码 200 表示成功
    // data.data 是一个对象里面有当前坐席的状态信息
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

取消预设忙碌（cancelPreSetBusy）

在通话中时，取消 preSetBusy 操作。

try {
    const { code, data } = await sdk.cancelPreSetBusy(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

呼出（callOut）

用于发起呼叫。

try {
    const { status, data, info } = await sdk.callOut(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

挂机（hungUp）

在通话中时，坐席主动挂断通话。

try {
    const { status, data, info } = await sdk.hungUp(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

通话保持（callKeep）

在通话中时，坐席保持通话。

try {
    const { status, data, info } = await sdk.callKeep(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

取消通话保持（callResume）

在通话中时，坐席取消保持通话。

try {
    const { status, data, info } = await sdk.callResume(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

流转（callFlow）

呼入振铃时，坐席流转该通话。

try {
    const { status, data, info } = await sdk.callFlow(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

应答（callInAnswer）

呼入振铃时，坐席应答通话。

try {
    const { status, data, info } = await sdk.callInAnswer(params)
    // status 是 CR 给的状态码 200 表示成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

代答（callPickup）

呼入振铃时，坐席应答通话。

try {
    const { code, data, info } = await SDK.callPickup()
    if (code !== 200) {
        log('CALL_PICKUP error data:', data)
    } else {
        log('CALL_PICKUP success:', info)
    }
} catch (error) {
    log('CALL_PICKUP error:', error)
}

忙时来电应答（busyCallAnswer）

有忙时来电时，坐席应答通话。

try {
    const { code, data, info } = await SDK.busyCallAnswer({ callId: this.callId })
    if (code !== 200) {
        log('BUSY_CALL_ANSWER error data:', data)
    } else {
        log('BUSY_CALL_ANSWER success:', info)
    }
} catch (error) {
    log('BUSY_CALL_ANSWER error:', error)
}

通话强插（callForceInsert）

用于被叫是 DND 或通话中时，强插通话或在被叫 DND 时强制呼叫。

try {
    const { code, data, info } = await sdk.callForceInsert(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

通话录音状态修改（changeCallRecordingStatus）

用于可录音通话中，暂停或继续录音。

try {
    const { code, data, info } = await sdk.changeCallRecordingStatus(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

转通话子流程（callTransferToIvr）

用于通话中，转接通话子流程。

try {
    const { code, data, info } = await sdk.callTransferToIvr(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

技能组排队优先通话或插入通话（callInsertFromQueue）

用于技能组有排队时，接入技能组的排队通话。

try {
    const { code, data, info } = await sdk.callInsertFromQueue(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

通话静音（callMutely）

用于静音通话中的对象，对象可以是坐席自身，也可以是客户以及其他与会坐席。

try {
    const { code, data, info } = await sdk.callMutely(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

多方通话（callMultiParty）

通话中时，用于发起多方通话。

try {
    const { code, data, info } = await sdk.callMultiParty(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

设置接听电话技能组（setAnswerGroups）

用于通话中，转接通话子流程。

try {
    const { code, data, info } = await SDK.setAnswerGroups({
        gidList: '1,2,3',
        gNameList: 'one,two,three',
    })
    if (code !== 200) {
        log(`CHANGE_CALL_GROUP failed: code:${code} info:${info}`)
    } else {
        log(`CHANGE_CALL_GROUP success: code:${code} info:${info}`)
    }
} catch (error) {
    log('CHANGE_CALL_GROUP error:', error)
}

params 参数说明

转接（callTransfer）

通话中时，用于发起通话转接。

try {
    const { code, data, info } = await sdk.callTransfer(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

取消转接（callTransferAbort）

通话中，用于发起通话转接后取消转接。

try {
    const { code, data, info } = await sdk.callTransferAbort(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

三方（callThreeParty）

通话中，用于发起三方通话。

try {
    const { code, data, info } = await sdk.callThreeParty(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

三方取消（callThreePartyAbort）

通话中，用于发起取消三方通话。

try {
    const { code, data, info } = await sdk.callThreePartyAbort(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

咨询（callConsult）

通话中，用于发起咨询通话。

try {
    const { code, data, info } = await sdk.callConsult(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

咨询取消（callConsultAbort）

通话中，用于发起取消咨询通话。

try {
    const { code, data, info } = await sdk.callConsultAbort(params)
    // code === 200 代表接口调用成功
} catch (error) {
    // may be is a ParamsError
}

params 参数说明

班长监听（callMonitor）

班长坐席监听技能组内坐席通话的操作。

try {
    const { code, data, info } = await SDK.callMonitor({
        callId: this.callId,
        seatId: '1111',
    })
    if (code !== 200) {
        log(`CALL_MONITOR failed: code:${code} info:${info}`)
    } else {
        log(`CALL_MONITOR success: code:${code} info:${info}`)
    }
} catch (error) {
    log('CALL_MONITOR error:', error)
}

params 参数说明

班长结束监听（hungUp）

班长坐席监听技能组内坐席通话触发结束监听时调用挂断接口hungUp。

班长强插（callMonitorInsert）

班长坐席监听技能组内坐席通话中进行强插操作进入三方通话。

try {
    const { code, data, info } = await SDK.callMonitorInsert({
        callId: this.callId,
    })
    if (code !== 200) {
        log(`callMonitorInsert failed: code:${code} info:${info}`)
    } else {
        log(`callMonitorInsert success: code:${code} info:${info}`)
    }
} catch (error) {
    log('callMonitorInsert error:', error)
}

params 参数说明

班长强拆（callMonitorBreak）

班长坐席监听技能组内坐席通话中进行强拆操作结束通话。

try {
    const { code, data, info } = await SDK.callMonitorBreak({
        callId: this.callId,
    })
    if (code !== 200) {
        log(`callMonitorBreak failed: code:${code} info:${info}`)
    } else {
        log(`callMonitorBreak success: code:${code} info:${info}`)
    }
} catch (error) {
    log('callMonitorBreak error:', error)
}

params 参数说明

班长拦截（callMonitorIntercept）

班长坐席监听技能组内坐席通话中进行拦截操作结束坐席与客户的通话，班长与客户进入通话中。

try {
    const { code, data, info } = await SDK.callMonitorIntercept({
        callId: this.callId,
    })
    if (code !== 200) {
        log(`callMonitorIntercept failed: code:${code} info:${info}`)
    } else {
        log(`callMonitorIntercept success: code:${code} info:${info}`)
    }
} catch (error) {
    log('callMonitorIntercept error:', error)
}

params 参数说明

事件

SDK 的事件主要分为两类，一类是用于监听 SDK 内部 websocket 的状态，一类用于监听通话相关的推送。

使用方式

// 监听某个事件
sdk.on('eventName', () => {
    // do something
})

// 注销某个事件的监听
sdk.off('eventName')

// 注销所有事件
sdk.off()

事件类型列表