文档首页/ 云客服/ API参考/ 座席工作台/ 座席控制/ 呼叫控制类:voicecall/ 取消保持
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

取消保持

前置条件

  • 座席已签入
  • 座席有已经保持的呼叫

场景描述

座席对已经保持的呼叫进行取消保持操作。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/gethold?callid={callid}

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号，取值范围：101～59999。

2

callid

string

False

呼叫唯一标识callid。

日志中的方法名

getHold

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。
  • 消息体

    无

响应说明

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下：

0：成功

非0：失败

3

result

object

预留字段

触发事件

  • 座席进入（AgentEvent_Talking）

错误结果码

  • 100-006
  • 100-007
  • 200-015
  • 200-016

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

    无

  • 响应参数 
    {
  "result": {},
  "message": "success",
  "retcode": "0"
}

相关文档