HiConf 电话会议二次开发文档

一、电话会议业务流程与接口地址 二、可用的接口功能 2.1 召集会议 2.2 添加参会人 2.3 结束会议 2.4 全体静音 2.5 除主持人外全体静音 2.6 全体发言 2.7 单个静音 2.8 单个发言 2.9 挂断单个参会人 2.10 重呼单个参会人 2.11 开始录音 2.12 停止录音 2.13 锁定会议 2.14 解锁会议 2.15 转移主持人 2.16 申请发言权限 2.17 更新一场会议的名称 2.18 更新一场会议的CustomData标记内容 2.19 更新一个会议参与者的姓名 2.20 查询一场正在召开的会议的状态 2.21 查询一个会议成员的状态 2.22 查询一场历史会议 2.23 创建一个新的呼入会议室 2.24 删除一个呼入会议室 2.25 修改一个呼入式会议室配置 2.26 为会议室生成新的密码组 2.27 查询所有呼入式会议室 2.28 查询单个呼入式会议室 2.29 开始对会议室放音 2.30 停止对会议室放音 三、回调消息的推送地址和接收响应 四、可用的回调消息 4.1 外呼式会议起始 4.2 开始呼叫主持人 4.3 主持人接通 4.4 主持人挂断 4.5 开始呼叫参会人 4.6 参会人接通 4.7 参会人挂断 4.8 外呼式会议结束 4.9 呼入式会议起始 4.10 参与者以参会人身份加入会议室 4.11 呼入式会议结束 4.12 某个会议参与者被设置为主持人 4.13 某个会议参与者被静音 4.14 某个会议参与者被取消静音 4.15 某个会议参与者申请发言权限 4.16 推送本次会议日志

2.1、召集会议

功能说明:

该接口用于发起一场呼出式会议,发起时仅需指定主持人的号码,在发起成功后将获得本场会议的序列号,用户需要保存该序列号,再使用添加参会人(AddAttendee)接口来添加其他参会人。


发送的XML数据包:

<xml>
  <ActionType>StartConference</ActionType>
  <UserName></UserName>
  <Token></Token>
  <EmceePhone></EmceePhone>
  <EmceePhoneEXT></EmceePhoneEXT>
  <EmceeName></EmceeName>
  <ConferenceDescription></ConferenceDescription>
  <Caller></Caller>
  <Record>true</Record>
  <Mute></Mute>
  <CallRepeatedly></CallRepeatedly>
  <IVR></IVR>
  <EndPolicy></EndPolicy>
  <CustomData></CustomData>
</xml>
			

发送的XML数据包参数说明:

参数必要性含义
ActionType必填固定值StartConference
UserName必填账号名
Token必填使用32位MD5对原始密码进行加密,并将加密结果转换为大写得出Token值
EmceePhone必填主持人电话号码
EmceePhoneEXT可选主持人分机号(如果有)
EmceeName可选主持人姓名
ConferenceDescription可选会议名称
Caller可选本场会议所要显示的主叫号码,该号码必须存在于管理后台中“码号资源列表”中所示的号码表并且可用于电话会议业务,留空使用系统默认号码
Record可选true或false,是否对会议进行录音,默认值:true
Mute可选true或false,用于设置当参会人以呼入方式加入本场会议时是否默认静音,默认值false
CallRepeatedly可选true或false,用于设置未呼通主持人时是否重复呼叫(最多呼叫3次),默认值true
IVR可选针对主持人进入会议时提示音的语种,可选的值有:
101:中文(默认值)
102:英语
语音资源序列号:已经通过管理后台上传的语音资源的序列号
EndPolicy可选会议的结束策略,可选的值有:
201:主持人挂断时会议结束(默认值)
202:主持人挂断时会议不结束,直到会议中只剩下最后一个人才结束
CustomData可选客户自定义字段,该字段将在回调消息中将被原样返回给客户系统,最长1024个字符

返回值:

<xml>
  <errcode></errcode>
  <errmsg></errmsg>
  <TaskSN></TaskSN>
  <PhoneSN></PhoneSN>
  <InBoundCallee></InBoundCallee>
  <InBoundPWD></InBoundPWD>
</xml>
			

返回值参数说明:

参数含义
errorcode调用成功时返回“0”,调用失败时返回大于0的失败代码并在errmsg中描述具体的失败原因
errmsg调用成功时返回“成功”,调用失败时返回具体的失败原因的中文描述
TaskSN调用成功返回本场会议的序列号,用户系统需要保存该序列号以区分回调消息的归属、进行会控和查询历史记录,调用失败时无此参数
PhoneSN主持人的呼叫序列号,用户系统需要保存该序列号以区分和主持人有关的回调消息,对主持人进行会控操作亦需要用到此序列号,调用失败时无此参数
InBoundCallee本场会议可用于呼入的电话号码,调用失败时无此参数
InBoundPWD本场会议的呼入密码,用户系统除了可以主动呼叫参会人外,还可以将该密码告知参会人,让参会人拨打本场会议的电话号码和输入密码来参加会议,调用失败时无此参数

该文档对问题描述清晰吗?