API 2.0 Change Logs

This topic describes the change logs of API 2.0.

Release Date Description
2024-4-7
  • Added the following parameters for Conference interfaces conference/query and conference/update.
    • mute: Query or configure whether to mute all participants except for moderators when entering a specific conference.
    • prompt: Query or configure the prompt used for the login and logout of conference members.
  • Added the following parameters for Queue interfaces queue/query and queue/update.
    • disallow_to_join_when_empty: Query or configure whether to disallow callers to join a queue where no agents are available.
    • empty_defined_for_disallow_to_join_when_empty: Query or configure the scenario(s) in which the queue will be considered to have no agents, and callers are NOT allowed to join.
    • empty_defined_for_leave_empty: Query or configure the scenario(s) in which the queue will be considered to have no agents, and on-hold callers will be forced out of the queue.
  • Added support for QueueAgentRingNoAnswerTimeout and QueueAutoPause events.
  • Fixed the following conference issues:
    • Invited users to join a conference with call recording enabled by calling the conference/add_member interface, but there was no call log and no call recording after the conference call ended.
    • The 10110 error (The conference number does not exist) was responded when querying the settings of multiple in-session conferences by calling the conference/query_in_session interface if there was no participant in the first queried conference.
  • Fixed the queue issue: Failed to obtain the caller number when querying queue status.
  • Fixed the voicemail issue: If users called to PBX via physical trunk and left voicemail messages, the caller number would be missing when querying these voicemails.
  • Fixed the recording issue: The 20014 error (The recording file does not exist) was responded when downloading recording file of conference calls.
  • Fixed the hotel issues:
    • API was disconnected when querying alarm settings of all extensions.
    • After adding an alarm for an extension registered on multiple endpoints, only a single endpoint would receive the wake-up call at the alarm time.
2021-05-24
  • Added the following interfaces to control call parking calls:
    • Query call parking status: callpark_status
    • Park a call: call/callpark
      Note: To retrieve a parked call, use the interface call/dial.
  • Added the following interfaces to control calls via User Agent Computer Supported Telecommunications Application (uaCSTA):
    • Hang up calls: uacstacall/hangup
    • Refuse a call: uacstacall/refuse_inbound
    • Answer a call: uacstacall/accept_inbound
  • Added support for uaCSTA call events.
  • Added the following interfaces to configure extension groups:
    • Query extension group settings: extensiongroup/query
    • Delete extension groups: extensiongroup/delete
    • Edit extension groups: extensiongroup/update
    • Add an extension group: extensiongroup/add
  • Fixed the issue of Company Contacts: The maximum number of company contacts was incorrect.
    Note: Check the maximum number of company contacts in the following table:
    S50 S100 S300
    2000 5000 5000
2021-01-28
  • Added musiconhold parameter for the following interfaces:
    • conference/update: Enable or disable music on hold.
    • conference/query: Query the status of music on hold.
  • Optimized queue/query_status interface: Added channelid parameter in response parameters.
  • Optimized ExtensionStatus report: Added registeredIP parameter, which is used to display the IP address of the device where extension registered.
  • Optimized the BLF key status display for an agent: The BLF key status can be changed when you pause or resume agent service by API.

  • Fixed the conference issues:
    • If there were no participants in a conference room, members could not be invited to join the conference by the conference/add_member interface.
    • If editing basic settings of a conference by conference/update interface, all the conference numbers would be changed to the same.
  • Fixed the issue of NewCdr report: If a queue call was not answered, the agentringtime in NewCdr report would be 0.
  • Fixed the issue of NewCdr report: The pushed NewCdr report was incorrect when an FXS extension received an inbound call.
2020-11-09
  • Added the following interfaces for Contacts:
    • companycontacts/query
    • companycontacts/add
    • companycontacts/update
    • companycontacts/delete
  • Added support for querying call status of extensions.

  • Optimized the following interfaces to reduce configuration reload frequency, and improve system stability.

    • extension/update
    • hotel/checkout
  • Fixed the issue of auto recording: The call placed via IVR could not be recorded automatically.
2020-07-01
  • Added support for querying the status of Linkus clients.
  • Added support for sending emails to Linkus users.
  • Added support for enabling and disabling Linkus feature for extensions.
  • Optimized the following interfaces:

    • inroute/update
    • outroute/update
    • siptrunk/update
    • pagingroup/update
  • Fixed the CDR download issue: If users called the API interface to download call records, some call records would display incorrectly.
2020-05-07 First release.