申请座席会议

前置条件

• 座席已签入

场景描述

座席调用该接口申请一个座席会议，调用成功后则需要等待后续的异步事件，申请成功后，申请会议的座席会成为会议主席。申请会议的座席接收到AgentConf_SelfJoinResult事件，表明申请会议的座席自身已加入到会议中，但还需要继续等待AgentConf_RequestSuccess事件后，座席才能进行会议主席相关的操作。在收到AgentConf_RequestSuccess事件前，座席调用会议相关的接口操作时，平台会直接返回失败。

• 当前座席处于空闲或者通话状态，处于通话状态时当前呼叫必须处于一个稳定状态，否则申请座席会议会失败，例如：在通话过程中进行放音、静音、保持呼叫、挂起转，则申请座席会议会返回失败。
• 三方通话过程中如果存在两个座席，被叫座席不允许发起座席会议。
• 与会者类型仅支持座席工号或电话号码。
• 电话会议方数小于等于vdn中设置的“并发语音最大呼叫数”。

接口方法

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

接口URI

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

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

日志中的方法名

requestAgentConf

请求说明

• 消息头

  表2 请求头参数说明

  序号	名称	参数类型	是否必选	说明
  1	Content-Type	string	True	消息主体编码方式，缺省值：application/json; charset=UTF-8
  2	Guid	string	True	静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。

• 消息体

  表3 消息体参数说明

  序号	名称	参数类型	是否必选	说明
  1	memberNum	int	True	会场能够容纳的与会人数。 取值范围：1～120。
  2	confCallerNo	String	False	会议外呼用户时显示的主叫号码。 最大长度为24字节。 不输入参数时，平台默认使用VDN配置台基本信息的系统主叫号码。在VDN有号码限制的情况，需要号码在限制范围内。
  3	time	int	False	会议申请时长。 单位：分钟。 取值范围：4～1440。 默认值为60。
  4	promptTime	int	False	会议结束前提示时长。 可选参数。 单位：分钟。 取值范围：3～1440。 默认值为3。 如果大于等于会议申请时长，按照申请时长-1计算。
  5	beepTone	boolean	False	有用户加入、退出会议时是否播放提示音。 默认值为false。
  6	playMode	int	False	2：播放指定文件音，默认值为2。
  7	voicePath	String	False	文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时，此参数必须设置并且playMode需要为2；当“BeepTone”设置为“false”时，此参数设置无效。 最大长度为127。

响应说明

触发事件

• 通话中（AgentState_Busy）
• 物理话机振铃（AgentOther_PhoneAlerting）
• 物理话机摘机（AgentOther_PhoneOffhook）
• 自己加入会议（AgentConf_SelfJoinResult）
• 会议申请成功（AgentConf_RequestSuccess）
• 会议申请失败（AgentConf_RequestFailed）
• 会议结束前提示时长：会议超时提醒事件（AgentConf_Timeout）

错误结果码

• 000-002
• 100-006
• 100-007

报文样例

• 消息头

  Content-Type:application/json; charset=UTF-8
  Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• 请求参数

  {
      "memberNum": 4,
      "confCallerNo": "10000",
      "time": 50,
      "promptTime": 5,
      "beepTone": true,
      "playMode": 2,
      "voicePath": "y:/conf/120/1136287.V3"
  }

• 响应参数

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