What is New in API 2.0

This topic describes what is new in 2.0 based on 1.0.

New interface

  • Added support for the following conference interfaces:
    • Query conference (conference/query)
    • Query instant conference (instant_conference/query)
    • Query in-session conference (conference/query_in_session)
    • Edit conference (conference/update)
    • Invite conference members (conference/add_member)
    • Kick conference members (conference/kick_member)
    • Mute or unmute conference members (conference/mute & conference/unmute)
  • Added an interface to invite a member to a call (call/add_member)

Interface unification and optimization

Interface unification

Unify the request URL of the following interfaces.

API 1.0 API 2.0
Unify call establishment interface
extension/dial_extension call/dial
extension/dial_outbound
ivr/dial_extension
ivr/dial_outbound
queue/dial_outbound
ringgroup/dial_outbound
outbound/dial_outbound
Unify prompt playback interface
extension/playprompt call/playprompt
outbound/playprompt
extension/dial_number
Unify call hangup interface
extension/hangup call/hungup
inbound/hangup
outbound/hangup
Unify call query interface
inbound/query call/query
outbound/query
Unify call transfer interface
calltransfer call/attended_transfer

call/attended_transfer_operate
inbound/transfer_number
outbound/transfer_number
Unify call monitor interface
extension/listen call/listen
extension/whisper
extension/barge
Interface optimization
  • Optimized call refuse interface: Changed the request URL from inbound/refuse to call/refuse_inbound.
  • Optimized call accept interface: Changed the request URL from inbound/accept to call/accept_inbound.
  • Optimized call mute and call unmute interfaces:
    • Call mute: Changed the request URL from extension/mute to call/mute.
    • Call unmute: Changed the request URL from extension/unmute to call/unmute.
  • Optimized call hold and call resume interfaces:
    • Call hold: Changed the request URL from extension/hold to call/hold.
    • Call resume: Changed the request URL from extension/unhold to call/unhold.
  • Optimized CDR download interfaces: Changed the request parameter from extid to number.
  • Optimized hotel interfaces: Changed the request parameter from extid to number.
  • Optimized voicemail interfaces: Changed the request parameter from extid to number.
  • Optimized paging group interfaces:
    • Changed the request parameter from extid to number.
    • Deleted id from request parameters and response parameters.
    • Query paging group list: Changed the request URL from paginggrouplist/query to paginggroup/list.
  • Optimized queue interfaces:
    • Changed the request parameter from extid to extnumber.
    • Changed the request parameter from queueid to queuenumber.
    • Queue logout: Changed request URL from queue/del_dynamicagent to queue/delete_dynamicagent.
    • Queue query: Changed the request URL from queuestatus to queue/query_status.
    • Queue update: Removed queueid from the request parameters.
    • Queue settings query: Removed queueid from response parameters.
  • Optimized IVR interfaces:
    • IVR query: Changed the request parameter from ivrid to number; changed the response parameter from ivrnumber to number.
    • IVR settings update: Removed ivrid from request parameters; changed the request parameter from ivrnumber to number.
  • Optimized trunk interfaces:
    • Trunk list query: Changed the request URL from trunklist/query to trunk/list; added id to response parameters.
    • Trunk settings query: Changed the request URL from siptrunk/query to trunk/query_siptrunk; removed trunkname from request parameters.
    • SIP trunk creation: Changed the request URL from siptrunk/add to trunk/add_siptrunk; added id to response parameters.
    • SIP trunk edit: Changed the request URL from siptrunk/update to trunk/update_siptrunk.
    • SIP trunk deletion: Changed the request URL from siptrunk/updat to trunk/delete_siptrunk; removed trunkname from request parameters.
  • Optimized extension interfaces:
    • Extension list query: Changed the request URL from extensionlist to extension/list; changed the response parameter from extnumber to number.
    • Extension settings query: Changed the request parameter from extid to number; changed the response parameter from extnumber to number.
    • Extension settings update: Removed extid from request parameters; changed the request parameter from extnumber to number.
  • Optimized interfaces of inbound route and outbound route:
    • Changed the request parameter from name to id.
    • Inbound route and Outbound route creation: Added id to response parameters.

API events

  • Changed the format of the following reports:
    • Invite
    • Incoming
    • CallFailed
    • PlayPromptEnd
    • Transfer
    • Forward
    • ConferenceStatus