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

批量删除与会者

前置条件

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

场景描述

主席批量删除与会者。

接口方法

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

接口URI

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

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

日志中的方法名

batchRemoveParticipant

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    addresses

    array

    True

    批量删除的与会者信息。

    数组最大长度为30。

    该对象的参数说明请参考表4

    表4 AgentConfAddressExParam对象

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    addressType

    String

    True

    地址类型。

    6:电话号码

    9:座席工号

    1.2

    address

    String

    True

    地址标识。

    最大长度为24个字符。

响应说明

表5 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

说明:

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

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

map

请参考表6

表6 不存在的与会者列表参数说明

序号

名称

参数类型

说明

3.1

noExistParticipants

array

请参考表7

表7 与会者参数说明

序号

名称

参数类型

说明

3.1.1

addressType

string

地址类型

3.1.2

address

string

地址标识

触发事件

  • 其他与会者收到:与会者变更事件(AgentConf_ParticipantChanged)
  • 被删除的与会者座席收到:自己离开会议事件(AgentConf_SelfLeaveResult)

错误结果码

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

报文样例

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