API 2.0 新增功能与优化

本节介绍 API 2.0 在 1.0 基础上的更新内容。

新增接口

  • 新增以下会议室相关的接口:
    • 查询固定会议室(conference/query)
    • 查询临时会议室(instant_conference/query)
    • 查询会话中的会议室(conference/query_in_session)
    • 编辑固定会议室(conference/update)
    • 剔除成员(conference/kick_member)
    • 邀请成员(conference/add_member)
    • 静音/取消静音成员(conference/mute & conference/unmute)
  • 新增多方通话接口(call/add_member)

接口统一与优化

统一接口

统一下列接口的请求地址。

API 1.0 API 2.0
合并建立通话接口
extension/dial_extension call/dial
extension/dial_outbound
ivr/dial_extension
ivr/dial_outbound
queue/dial_outbound
ringgroup/dial_outbound
outbound/dial_outbound
合并播放语音接口
extension/playprompt call/playprompt
outbound/playprompt
extension/dial_number
合并挂断通话接口
extension/hangup call/hungup
inbound/hangup
outbound/hangup
合并查询通话接口
inbound/query call/query
outbound/query
合并通话转接接口
calltransfer call/attended_transfer

call/attended_transfer_operate

inbound/transfer_number
outbound/transfer_number
合并通话监听接口
extension/listen call/listen
extension/whisper
extension/barge
优化接口
  • 优化结束广播提示音接口:请求地址 paginggroup/hangup_music 修改为 paginggroup/hangup/music
  • 优化拒接来电接口:请求地址 inbound/refuse 修改为 call/refuse_inbound
  • 优化接听来电接口:请求地址 inbound/accept 修改为 call/accept_inbound
  • 优化通话静音接口:
    • 通话静音:请求地址 extension/mute 修改为 call/mute
    • 取消静音:请求地址 extension/unmute 修改为 call/unmute
  • 优化通话保持接口:
    • 通话保持:请求地址 extension/hold 修改为 call/hold
    • 恢复通话:请求地址 extension/unhold 修改为 call/unhold
  • 优化下载通话记录接口:请求参数 extid 修改为 number
  • 优化酒店相关接口:请求参数 extid 修改为 number
  • 优化语音留言相关接口:请求参数 extid 修改为 number
  • 优化广播相关接口:
    • 请求参数 extid 修改为 number
    • 请求参数和响应参数去除 id
    • 查询广播列表:请求地址 paginggrouplist/query 修改为paginggroup/list
  • 优化队列相关接口:
    • 请求参数 extid 修改为 extnumber
    • 请求参数 queueid 修改为 queuenumber
    • 队列迁出:请求地址 queue/del_dynamicagent 修改为 queue/delete_dynamicagent
    • 查询队列:请求地址 queuestatus 修改为 queue/query_status
    • 编辑队列:请求参数去除 queueid
    • 查询队列设置:返回参数去除 queueid
  • 优化 IVR 相关接口:
    • 查询 IVR:请求参数 ivrid 修改为 number;返回参数 ivrnumber 修改为 number
    • 修改 IVR 设置:请求参数去除 ivridivrnumber 修改为 number
  • 优化中继相关接口:
    • 查询中继列表:请求地址 trunklist/query 修改为 trunk/list;返回参数新增 id
    • 查询 SIP 中继设置:请求地址 siptrunk/query 修改为 trunk/query_siptrunk;请求参数去除 trunkname
    • 创建 SIP 中继:请求地址 siptrunk/add 修改为 trunk/add_siptrunk;返回参数新增 id
    • 编辑 SIP 中继:请求地址 siptrunk/update 修改为 trunk/update_siptrunk
    • 删除 SIP 中继:请求地址 siptrunk/updat 修改为 trunk/delete_siptrunk;请求参数去除 trunkname
  • 优化分机相关接口:
    • 查询分机列表:请求地址 extensionlist 修改为 extension/list;返回参数 extnumber 修改为 number
    • 查询分机设置:请求参数 extid 修改为 number;返回参数 extnumber 修改为 number
    • 修改分机设置:请求参数去除 extidextnumber 修改为 number
  • 优化呼入路由和呼出路由相关接口:
    • 请求参数 name 修改为 id
    • 创建呼入路由或呼出路由:返回参数新增 id

事件推送

  • 新增支持 TCP 长连接的方式发送 TCP 事件报告。
  • 变更如下报告的格式:
    • 来电呼叫请求(Invite)
    • 来电呼入请求(Incoming)
    • 呼叫失败(CallFailed)
    • 语音播放结束事件(PlayPromptEnd)
    • 呼叫转移事件(Transfer)
    • 呼叫前转事件(Forward)
    • 与会成员变更事件(ConferenceStatus)