批量删除与会者
前置条件
- 座席已签入
- 当前座席是会议主席
场景描述
主席批量删除与会者。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持GET、PUT和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/agentconf/{agentid}/batchremoveparticipant
其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
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。
响应说明
触发事件
- 其他与会者收到:与会者变更事件(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": [] } }