本文为您介绍了话务管理相关的接口说明。

API列表

API名称 描述
StartHotlineService 坐席签入,开始热线服务
SuspendHotlineService 坐席小休,暂停热线服务
FinishHotlineService 坐席签出,结束热线服务
AnswerCall 坐席接听来电
HangupCall 坐席挂机
TransferCallToSkillGroup 单/双步转至技能组
TransferCallToPhone 单/双步转至电话
StartCall 发起外呼
ListOutboundPhoneNumber 获取外呼号码列表
SendHotlineHeartBeat 发送热线心跳
ListHotlineRecord 获取热线录音列表
SendOutboundCommand 发送呼叫命令
GetNumLocation 获取号码归属地

StartHotlineService

坐席签入,开始热线服务

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Data String 坐席心跳Token
Code String 错误编码
Message String 错误描述

SuspendHotlineService

坐席小休,暂停热线服务

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

FinishHotlineService

坐席签出,结束热线服务

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

AnswerCall

接听来电

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
CallId String 热线会话ID
JobId String xxx
ConnectionId String xxx

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

HangupCall

挂机

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
CallId String 热线会话ID
JobId String xxx
ConnectionId String xxx

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

TransferCallToSkillGroup

挂机

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
CallId String 热线会话ID
JobId String xxx
ConnectionId String xxx
HoldConnectionId String xxx
IsSingleTransfer Boolean true:单步转,false:双步转。默认单步转

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

TransferCallToPhone

挂机

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
Caller String 热线转交主叫号码
Callee String 热线转交被叫号码
CallId String 热线会话ID
JobId String xxx
ConnectionId String xxx
HoldConnectionId String xxx
IsSingleTransfer Boolean true:单步转,false:双步转。默认单步转

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

StartCall

发起外呼

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
Caller String 主叫号码
Callee String 被叫号码

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

ListOutboundPhoneNumber

获取指定坐席下的外呼号码列表

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述
Data List<String> 外呼号码列表

SendHotlineHeartBeat

发送热线心跳

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
Token String 心跳签名

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述

ListHotlineRecord

获取热线录音列表

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
CallId String 热线会话ID

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Code String 错误编码
Message String 错误描述
Data.N.CallId String 热线会话ID
Data.N.ConnectionId String xxx
Data.N.Url String 录音文件URL
Data.N.StartTime String 录音开始时间
Data.N.EndTime String 录音结束时间

SendOutboundCommand

发送呼叫命令(后端发起呼叫)

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
AccountName String 坐席账号名
CalledNumber String 被叫号码
CallingNumber String 主叫号码
CustomerInfo String 客户侧业务信息(jsonstring)

返回数据

参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Data String 呼叫业务信息
Code String 错误编码
Message String 错误描述

GetNumLocation

获取号码归属地

请求参数

参数名称 类型 是否必填 描述
InstanceId String 实例ID,在控制台上可以看到
PhoneNum String 号码
返回数据
参数名称 类型 是否为空 描述
RequestId String 请求ID,用于跟踪错误原因
Success Boolean 接口调用是否成功
Data String 归属地信息
Code String 错误编码
Message String 错误描述