中通天鸿开发者平台

中通天鸿开发者平台

  • 开发文档
  • API文档

›wincall V2

快速入门

  • 如何认证

wincall

    wincall V2

    • 快速入门
    • CTIPlus实例对象
    • 坐席操作
    • 会话对象
    • 监听强插操作
    • 基础信息获取
    • 事件

toolbar

  • 电话工具条

在线客服

  • APP SDK推送接口
  • im-api
  • iOS SDK 开发指南
  • Android SDK 开发指南

CTI-PLUS

  • 接口文档
  • 参考手册
  • WS消息参考手册

外呼机器人

  • 外呼机器人对外接口文档_v1.0
  • 外呼机器人对外接口文档_v2.0
  • 媒体库对外接口文档_v1.0
  • 外呼机器人NLP接口参考手册_v1.0

MakeCall

  • MakeCall外呼发起及事件订阅服务_v1.0

自定义报表

  • 新老报表指标映射

坐席操作

坐席操作

签入

CTI.Agent.login(params,callback)

参数对象params

参数类型可选描述
bindTelString必选绑定电话
loginTypeInt可选签入模式类型 取值1.动态模式,2静态模式,默认为动态模式
stateInt可选签入状态 取值1.置闲,2置忙,默认为置闲
notReadyReasonInt可选置忙原因

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

签出

CTI.Agent.logout(params,callback)

参数对象params

参数类型可选描述
logoutTypeInt可选签出类型 枚举值 1 : 完全退出 2:仅退出动态模式(默认)

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

置闲

CTI.Agent.ready(callback)

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

置忙

CTI.Agent.unready(params,callback)

参数对象params

参数类型可选描述
reasonInt可选置忙类型 取值说明:置忙原因id,可以通过CTI.Info.getBusyReason获得

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

外呼

CTI.Agent.callOut(params,callback)

参数对象params

参数类型可选描述
agPhostring可选坐席分机
telString必选外呼号码。支持编码,例如base64格式:B64:+ 具体base64编码的电话号码
callerIDString可选客户侧外显号码
agCallerIDString可选坐席侧显示号码
encryptionint可选0不加密,1加密,默认0
queueIdint可选呼出所属技能组
userDataString可选自定义字段 json格式字符串,传入的值会打入通道变量,格式:json字符串{"key":"value"}

如果需要加密,即 encryption 设置为 1 时,请先到管理后台配置具体的加密算法(目前仅支持 ECB 类型加密方式,包括 AES-ECB 类型)和秘钥。

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

呼叫坐席

CTI.Agent.callInner(params,callback)

参数对象params

参数类型可选描述
calledAgNoString必选被叫坐席工号
callerIDString可选主叫号码(中继号)

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

修改绑定电话

CTI.Agent.changeBindTel(params,callback)

参数对象params

参数类型可选描述
bindTelString必选绑定电话
isWebrtcBoolean可选切换的电话是否使用webrtc

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

*isWebrtc属性会在切换号码时,自动维护当前webrtc状态(注销、重新注册)。如果不加上该参数,默认是不会做任何webrtc处理操作的。

获取主叫列表

CTI.Agent.getCallList(callback)

返回字段说明

参数类型说明
codeint结果码(0为成功,其他为失败,具体失败原因见message)
messagestring返回结果描述
dataobject主叫列表信息

响应结果示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "num": [
            {
                "name": "自动选择",
                "value": "",
                "type": "auto"
            },
            {
                "name": "呼入号码组",
                "value": "g:132",
                "type": "group"
            },
            {
                "name": "01012345678",
                "value": "01012345678",
                "type": "phone"
            }
        ]
    }
}

进入自动外呼

CTI.Agent.agentAtIn(params,callback)

参数对象params

参数类型可选描述
agNoString必选座席工号(取值3-20位数字或字母)
proIDint必选

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

退出自动外呼

CTI.Agent.agentAtOut(params,callback)

参数对象params

参数类型可选描述
agNoString必选座席工号(取值3-20位数字或字母)

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

获取坐席项目列表

CTI.Agent.getPro(params,callback)

参数对象params

参数类型可选描述
agNoString必选座席工号(取值3-20位数字或字母)

返回字段说明

参数类型说明
codeint结果码
messagestring返回结果描述

响应结果示例

{
    "code": 0,
    "message": "成功",
    "data": [
        {
            "pro_id": "620",
            "pro_name": "预测试外呼",
            "pro_state": "1"
        }
    ]
}

结果说明 根据收到的结果,将data中的num数组作为下拉选择的项来显示即可,name为显示的值,value为外呼时传递的主叫号码的值,type为类型说明,说明如下

  • auto-自动选择:自动选择为一个固定值,外呼时传递的主叫号码为空,这样后端将在分配给企业的号码列表中随机选择一个号码
  • group-号码组:号码组为在后台配置的号码组,一个号码组可以包含多个号码,如果外呼时传递的主叫为号码组的话,那么会从该号码组中随机选择一个号码来外呼
  • phone-中继号码:phone为实际的中继号码,外呼时直接传递即可
Last updated on 8/27/2021 by yanda
← CTIPlus实例对象会话对象 →
  • 坐席操作
    • 签入
    • 签出
    • 置闲
    • 置忙
    • 外呼
    • 呼叫坐席
    • 修改绑定电话
    • 获取主叫列表
    • 进入自动外呼
    • 退出自动外呼
    • 获取坐席项目列表
中通天鸿开发者平台
产品中心
呼叫中心在线客服工单系统IM机器人CTI-PLUS语音机器人通信云资源云
帮助中心
常见问题更新日志
关于我们
公司简介联系我们友情链接
Copyright © 2021 中通天鸿(北京)通信科技股份有限公司