批量邀请与会者

前置条件

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

场景描述

主席邀请多个与会者参与会议。

接口方法

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

接口URI

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

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

日志中的方法名

batchAddParticipant

请求说明

• 消息头

  表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	批量邀请的与会者信息。 数组最大长度为120。 该对象的参数说明请参考表4。
  2	beepTone	boolean	False	有用户加入会议时是否对该用户播放欢迎语。 默认值为false。
  3	playMode	int	False	放音模式。 2：播放指定文件音。 默认值为2。
  4	voicePath	String	False	文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时，此参数必须设置并且playMode需要为2；当“BeepTone”设置为“false”时，此参数设置无效。 最大长度为127个字符。
  5	caller	String	False	主叫号码。在VDN有号码限制的情况，需要号码在限制范围内。 最大长度为24个字符。

  表4 与会者对象参数说明

  序号	名称	参数类型	是否必选	说明
  1.1	addressType	String	True	地址类型。 6：电话号码 9：座席工号
  1.2	address	String	True	地址标识。 最大长度为24个字符。
  1.3	deviceCallType	int	False	自定义的设备呼叫类型，详细见表3。 不填或者填null，使用默认值，默认值为0。 取值范围为0-255。
  1.4	deviceType	int	False	自定义的设备类型，详细见表2。 不填或者填null，使用默认值，默认值为0。 取值范围为0-255。

响应说明

触发事件

• 与会者变更事件（AgentConf_ParticipantChanged）

错误结果码

• 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",
              "deviceCallType": 1,
              "deviceType": 66
          }
      ],
      "beepTone": false,
      "playMode": 2,
      "voicePath": "y:/conf/120/1136287.V3",
      "caller": "1111"
  }

• 响应参数

  {
    "result": {},
    "message": "success",
    "retcode": "0"
  }