更新时间:2023-12-19 GMT+08:00

停止座席会议通道放音

前置条件

  • 座席已签入
  • 当前座席是会议主席

场景描述

调用此接口,可以停止电话会议通道放音,只有主席才有权限停止电话会议通道放音。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/agentconf/{agentid}/stopvoicetoparticipant

其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号,取值范围:101~59999。

日志中的方法名

stopVoiceToParticipant

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    addressType

    String

    True

    地址类型。

    6:电话号码

    9:座席工号

    2

    address

    String

    True

    地址标识。

    最大长度为24字节。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

说明:

当出现错误提示“Unknown ERROR._*****”时,*****表示CTI错误结果码,详情请参见表2

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

map

只有失败时,才返回该参数。请参考表5

表5 停止放音失败原因

序号

名称

参数类型

说明

3.1

errorReason

int

停止放音失败时透传排队机侧返回的失败原因码。

触发事件

错误结果码

  • 000-002
  • 100-006
  • 100-007
  • 101-001
  • 101-002

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "addressType": "9",
        "address": "2002"
    }
  • 响应参数
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }