查询保持列表
前置条件
- 座席已签入,接听方式为非自动应答
- 座席正在通话中,并保持该通话
场景描述
座席签入后,查询保持列表。
接口方法
设置成“GET”。该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/calldata/{agentid}/holdlist
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
1 |
agentid |
string |
True |
座席的工号,取值范围:101~59999。 |
日志中的方法名
queryHoldListInfo
请求说明
- 消息头
表2 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。
- 消息体
无
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述 |
2 |
retcode |
string |
错误码。取值如下: 0:成功 非0:失败 |
3 |
result |
object |
查询成功后,返回呼叫保持列表对象。 该对象的参数说明请参见表4。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
3.1 |
callfeature |
int |
呼叫类型,请参考表1 |
3.2 |
callid |
string |
呼叫ID |
3.3 |
caller |
int |
主叫号码 |
3.4 |
called |
int |
被叫号码 |
3.5 |
callskill |
string |
呼叫技能描述 |
3.6 |
callskillid |
int |
未使用该返回参数 |
3.7 |
orgicallednum |
string |
未使用该返回参数 |
3.8 |
calldata |
string |
未使用该返回参数 |
3.9 |
begintime |
long |
未使用该返回参数 |
3.10 |
endtime |
long |
未使用该返回参数 |
触发事件
- 无
错误结果码
- 100-006
- 300-001
- 400-003
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
无
- 响应参数
{ "message": "", "retcode": "0", "result": [ { "callfeature": 7, "callid": "1501127996-2", "caller": "10086", "called": "70943", "callskill": "voice", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null } ] }