SOP API

Description

This module installs a HTTP/XML based Application Programmer Interface. The SOP API module consists of a series of XML events, HTTP call control actions and HTTP database access actions allowing you to integrate your business applications with the SOP.

Release notes

Show release notes
Version 5.10.0 - Deprecated
  • Feature: Allow to set state for one/all queue policies of a user (M25122)
  • Bugfix: Allow to unset a profile parameter (M0)
  • Deprecated: Allow to set state for one/all queue policies of a user does not work (M25122)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 3.6.2+
    • Shell Module >= 1.23.0
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Software Sources module >= 1.2.2
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.10.4 - Early deployment
  • Bugfix: Fixed pumLogin and pumLogout Internal Server error (Backport) (M13628)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.3.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.10.3 - Early deployment
  • Bugfix: Fixed pumLogin and pumLogout method (Backport) (M13628)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.3.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.10.2 - Early deployment
  • Bugfix: Only select phones resources dbGetPhoneStatus (M11186)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.3.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.10.1 - General deployment
  • Bugfix: ccPhone API would not reboot the phone (M10701)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.3.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.10.0 - General deployment
  • Feature: Added dbAddFeedback that collects feedback from users (M9434)
  • Feature: Added dbGetTimezone that gives the current time zone of the SOP (M9551)
  • Feature: Added dbGetUser that gives optimized information about a user for ESCAUX Connect (M9676)
  • Feature: Added pumLogin and pumLogout that allow to connect and disconnect extension with PUM enabled on a given phone (M9738)
  • Feature: dbCheckPinCode & dbGetParkedChannels can now be called through the network (M9372)
  • Feature: Added error trace to feedback (M0)
  • Feature: Added the API ccGetVar (M9501)
  • Bugfix: dbSetProfile API call would not change intentional status if the context was not provided. Now, the default context is "1" (M9730)
  • Bugfix: default values could be incorrect when upgrading from a previous version and new options are available (M10261)
  • Bugfix: Close remote api access security breach in dbGetMConnectProvisioning (M10442)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.3.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.9.1 - General deployment
  • Bugfix: Correct the API dbSetProfile method (M9676)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.9.0 - Deprecated
  • Feature: Support for new profile parameter types (M8737)
  • Feature: Return outgoing number in dbGetDirectoryInfo (M8821)
  • Feature: Return extension's context name in dbGetDirectoryInfo (M8755)
  • Improvement: Allow local channels for ccHangup (M9064)
  • Bugfix: Set user when X-REMOTE-USER is given
  • Improvement: Allow ccRedirect on channels whose current user is participating (M9112)
  • Improvement: dbGetCallHistory can now output in JSON (M9114)
  • Bugfix: Take context_id into account when updating profile status
  • Bugfix: Queue call counters in net.Supervisor were not updated properly in some cases (M9261)
  • Deprecated: The API dbSetProfile method failed silently (M9676)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.8.1 - General deployment
  • Improvement: Added a new "local_only" parameter to dbGetDirectoryInfo to only fetch directory of local SOP (M8646)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.8.0 - General deployment
  • Feature: Forward API requests when "mc_api_forwarding_server" is given (M8626)
  • Feature: Return extension's SOPKEYs and IPs (M8626)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.7.1 - General deployment
  • Improvement: Allow star character (*) and hash character (#) in profile parameters (M8587)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.7.0 - General deployment
  • Feature: provisioning call for m.Connect (M8103)
  • Improvement: Avoid starting the scheduled task at the same minute for each VSOP (M7978)
  • Improvement: Allow phone pattern to be given to ccPhoneReboot (M8415)
  • Improvement: Do not return net.PBX contacts when source is set to something else (M8428)
  • Bugfix: Allow accented characters in the values of profile parameters (M8387)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.6.0 - General deployment
  • Feature: Log user responsible for profile parameter or status change into attribute log (M7502)
  • Feature: Exposed the parameter 'filename' for ccRecord API (M7961)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 2.1.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.5.0 - General deployment
  • Bugfix: Attempting reboot of an unsupported phone reported success instead of reporting failure (M7890)
  • Feature: Requests to the API are now propagated to the other SOP in case of active-active (M7940)
  • Feature: dbGetDirectoryInfo now returns contacts imported through UC Model (M7749)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.8.1+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.4.0 - General deployment
  • Feature: dbGetMemberInfo now also returns the user's language (M7822)
  • Feature: Enhanced the API module to allow the usage of the contact of the csv file to be used in net.Desktop (M7521)
  • Bugfix: Extension owner check are now case insensitive like on the SMP (M0)
  • Feature: Support for Communication Server 3 (M7853)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.7.0+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.3.3 - Early deployment
  • Bugfix: Incorrect premission on process-template (M12275)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.3.2 - Early deployment
  • Bugfix: Mail to Fax no longer working due to sudo permission problem (M0)
  • Bugfix: Remove unused columns in dbGetProfileParameters (M0)
  • Bugfix: Incorrect premission on process-template (M12275)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.3.1 - Early deployment
  • Bugfix: Log UserEvent manager interface messages to allow to disable other events and increase system performance. (M11983)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.3.0 - General deployment
  • Bugfix: phone_queue class is not set to NULL anymore when a phone leaves a queue (M6381)
  • Bugfix: Colon was not allowed in profile parameters value (M0)
  • Feature: ccQueueAdd and ccQueueRemove are now accessible from network (M7219)
  • Feature: Allow users to specify not equal is where clauses for extension select and selection list global parameters (M7286)
  • Feature: Translate the display field of extension select and extension list global parameters (M7287)
  • Feature: Allow profile parameters values to be shown in extension select and extension list global parameters (M7303)
  • Bugfix: Where clauses of extension select and extension list global parameters were not parsed correctly (M0)
  • Feature: Extension select and extension list global parameters now support two clauses (M7389)
  • Feature: dbGetProfileParameterLayout now returns the admin vars when asked (M7389)
  • Feature: It is now possible to translate the content of directory entry fields for extension select and extension list global parameters (M7353)
  • Feature: Added support for test on empty fields for extension select and extension list (M0)
  • Feature: Added match on Profile Parameter value in API, allowing all characters(M0)
  • Feature: ccRebootPhone is now accessible from network (M7450)
  • Feature: ccReconfigurePhone is now available. (M7450)
  • Feature: Add an option to dbGetDirectoryInfo to show profile parameter, and filter by admin. (M7598)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.27.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.5 - Early deployment
  • Bugfix: It was not possible to retrieve the profile paraemeters (M220070)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.4 - General deployment
  • Bugfix: Backport from 4.9.0, Queue call counters in net.Supervisor were not updated properly in some cases (M9261)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.3 - General deployment
  • Bugfix: added the "TO" parameter to the "dbSetProfile" method (M9542)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.2 - General deployment
  • Bugfix: there was an error in a db query of dbGetProfileParameter (M8358)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.1 - Deprecated
  • Bugfix: ccRetreiveCall from net.Desktop was not working (M7771)
  • Deprecated: error in a db query of dbGetProfileParameter (M8358)
  • Dependency:
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.2.0 - General deployment
  • Feature: Allow authorization through http headers (M0006817)
  • Feature: Allow letters in extensions (M0007215)
  • Feature: Allow exposing the API in JSON format (M0006948)
  • Improvement: Allow to retrieve "dynamic" or "static" status of a QueueMember with ccGetQueueMembers (M6834)
  • Feature: Allow "+" character in usernames and phone numbers
  • Feature: Added the possibility to make a ccRetrieveCall based on the channel ID (M7246)
  • Feature: Added translated statuses when available (M7243)
  • Dependency:
    • Database Schema module 1.25.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.1.4+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.10 - General deployment
  • Feature: Backport from 4.10.0, Added pumLogin and pumLogout that allow to connect and disconnect extension with PUM enabled on a given phone. (M9738)
  • Dependency:
    • Database Schema module 1.22.0+
    • PUM 2.5.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.9 - General deployment
  • Bugfix: Error when setting a new password with dbAuthenticate if the old one is empty (M6806)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.8 - General deployment
  • Bugfix: ccGetQueueMembers did not return the name and extension details of a member device that was only assigned as a secondary phone (M6067)
  • Bugfix: phone parameter for ccGetQueueMembers was no longer taken into account since API 4.0.0 (M6643)
  • Bugfix: async mode was not available in API 4 (M6650)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.7 - General deployment
  • Bugfix: some ccOriginate parameters were not parsed correctly (M6543)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.6 - General deployment
  • Feature: Set GetXPathError to indicate http query result (M6543)
  • Bugfix: GetXPath could hang until timeout when no variable was set (M6426)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.5 - General deployment
  • Improvement: Improve parameters' validation when invoked loopback address(M0)
  • Improvement: Ported changes of ccConsultationCall from API2 (M6418)
  • Bugfix: Incorrect caller id and colp when called is transferred (M6474)
  • Bugfix: GetXPath action was not working when no SetVar action was used in any callflow (M6426)
  • Bugfix: dbGetSMPUserUrl was not returning the correct url (M6478)
  • Bugfix: net.Desktop was showing the number of the last extension the call was sent through instead of the dialled number (M6346)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4
    • Breaks: Communication Server 2.0.0+: CallerID is not correct for some transfer when the option "o" has not been removed from the global parameter "DialAsteriskOption"

Version 4.1.4 - General deployment
  • Improvement: API dbgetcallhistory for an extension without phone configured (M6378)
  • Improvement: Port ccConsulationCall development from API2 to API4 (M6418)
  • Bugfix: calledid not updated when going through startdynamicapplication (M6330)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.1.3 - General deployment
  • Bugfix: Fixed net.Desktop pickup on Communication Server 2. (M6112)
  • Bugfix: When CallDevices fails to call a phone, a pickup is shown instead of a missed (M6292)
  • Bugfix: Call going through successive extension are not shown in the call history (M6295)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.1.2 - General deployment
  • Feature: Profile documentation is now available in API4. (M0005984)
  • Improvement: dbGetCallHistory now displays missed call on failed calls (M0006036)
  • Bugfix: Blind transferred call were not displayed in call history (M0006081) * Bugfix: ccSetVar was not compatible with Communication Server 2.0 (M0005880)
  • Bugfix: ccOriginate ignored 'var' parameter (M0005736)
  • Bugfix: dbGetCallHistory is encoded using UTF-8
  • Bugfix: Removed validation step in dbGetIntentionalStatus. (M0005985)
  • Bugfix: When extending dbGetDirectory function to another server, only the first criteria is taken into account (M0005992)
  • Bugfix: some empty imput parameter were not allowed in ccOriginate and ccConsultationCall
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.1.1 - General deployment
  • Bugfix: Filesystem permissions were incorrect for the ccRecord API call when used with the Communication Server module (M0005885)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.1.0 - General deployment
  • Bugfix: dbGetPhones was missing from API 4 in compatibility mode (M5817)
  • Feature: Make translation available in dbGetProfileParameters, dbGetIntentionalStatus, dbGetProfileParametersLayout (M0005372)
  • Feature: Add connected line update events to proxy.pl (M5658)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.0.3 - General deployment
  • Bugfix: Do not display invalid call history entries (M5781)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.0.2 - General deployment
  • Bugfix: There was a hanging call after doing the call transfer via net.Desktop (M0005730)
  • Bugfix: Profile parameter layout was incorrect.
  • Bugfix: Elements in selection list profile parameters we missing.
  • Bugfix: net.Desktop attended transfer was not working.
  • Improvement: Move library to SOP Base to avoid duplicate implementations.
  • Feature: Make the startup of proxy.pl optional (M0005500)
  • Feature: Make translation available in dbGetProfileParameter, dbGetCallflow (M0005372)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.22.0+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.3+
    • Web Server 1.0.0+
    • Breaks: SNMP Agent < 2.7.4

Version 4.0.1 - General deployment
  • Bugfix: ccRetrieveCall used for net.Desktop based call transfer causes lost call (M5388)
  • Bugfix: set empty profile parameters
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.18+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.1+
    • Web Server 1.0.0+

Version 4.0.0 - General deployment
  • Feature: Potential update impact level 3 DONE: in the event this update contains a bug, it might have critical impact. ERROR! Given the complexity of the update, it is advised to contact ESCAUX support before applying this update. New version of the API. Previous undocumented behaviour could have been removed.
  • Feature: Web server now also exposes the API using HTTPS protocol. (M0004293)
  • Feature: When using API with HTTPS protocol we use authorization. (M0004256)
  • Feature: dbGetProfileParameter now supports global parameters of type enumeration (M0004557)
  • Feature: added 'show_admin' parameter for dbGetProfileParameters (M00047047)
  • Feature: Provides new private API (M0004705)
  • Improvement: Improved security aspects on the API. If you use netDesktop Module or netSupervisor Module, be sure to upgrade to the latest version available and enable the secure mode. (M0004256)
  • Improvement: Compatibility with the Communication Server module (M0004841)
  • Improvement: Moved shared libraries to SOP Base.
  • Improvement: Security fix for dbGetDirectoryInfo (M0006788)
  • Bugfix: net.desktop / API: api.ini should contain own sop as first entry. (M0004627)
  • Bugfix: added vars for dbGetProfileParameters and dbSetProfileParameters (M0004707)
  • Dependency:
    • SOP baseline >= 2.0.7
    • Database Schema module 1.18+
    • Asterisk-1.2 module 2.32.2+ OR Communication Server module 2.0.0+
    • SOP Base 1.4.1+
    • Web Server 1.0.0+

Version 3.1.5 - Deprecated
  • Bugfix: Wrong number was showing in netDesktop popup (M0003607)
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0+ which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.1.4 - Deprecated
  • Bugfix: Implicit wildcard removed for 'grp' parameter in dbGetDirectoryInfo.php (M0004242)
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0+ which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.1.3 - Deprecated
  • Improvement: proxy.pl binds on localhost if possible. (M0004124)
  • Bugfix: ExecuteCOMXML failed when XML tag contained newline.
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0+ which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.1.2 - Deprecated
  • Bugfix: GetXPath was redirected to wrong extension.
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.1.1 - Deprecated
  • Improvement: AGI script to allow backward compatibility with GetXpath 1.00 action
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.1.0 - Deprecated
  • Improvement: AGI script to allow multivalued results in GetXpath action
  • Bugfix: Phone reboot through phone status page does not work (M0003758)
  • Deprecated: If a GetXpath action is executed, and empty result now contains an empty value instead of a "Array" value. This might break certain callflows
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.0.6 - Deprecated
  • Bugfix: Buddy list in m.Connect does not work
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.0.5 - Deprecated
  • Feature: Null check in Buddy list
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.0.4 - Deprecated
  • Feature: Implemented modularity - license checking and access based on WCM* user resources
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.0.3 - Deprecated
  • Feature: Implemented modularity - license checking and access based on WCM* user resources
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.3

Version 3.0.2 - Deprecated
  • Improvement: Demo version
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.2

Version 3.0.1 - Deprecated
  • Feature: added buddy list support for mconnect (M3583)
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.2
    • Application Management Server v.3.2.2

Version 3.0.0 - Deprecated
  • Feature: added webapi for mconnect
  • Deprecated: v3.x.x of the API is deprecated. You should use instead v2.32.0 which contains every update done in v3.x.x, if you are using mConnect you should update your Unified Communication Module to v1.9.0+ (M0004545)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+
    • Unified Communication Model v1.7.1
    • Application Management Server v.3.2.0

Version 2.33.14 - Early deployment
  • Bugfix: phone_queue class is not set to NULL anymore when a phone leaves a queue - backport (M12026)
  • Dependency:
    • Database Schema module v1.22 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.13 - Early deployment
  • Bugfix: Installation of the module failed on a standby SOP
  • Dependency:
    • Database Schema module v1.22 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.12 - General deployment
  • Bugfix: ccGetQueueMembers did not return the name and extension details of a member device that was only assigned as a secondary phone (M6067)
  • Dependency:
    • Database Schema module v1.22 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.11 - General deployment
  • Bugfix: Removed debugging statements
  • Dependency:
    • Database Schema module v1.22 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.10 - General deployment
  • Bugfix: Do not display invalid call history entries (M5781)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.9 - General deployment
  • Feature: Make the the startup of proxy.pl optional (M0005500)
  • Bugfix: Call pick-up not correctly detected in call history (M0005526)
  • Bugfix: There was a hanging call after doing the call transfer via net.Desktop (M0005730)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.8 - General deployment
  • Bugfix: Don't expose AdminVar in ProfileParametersLayout
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.7 - General deployment
  • Bugfix: Agents going from paused to free do not update the UI (M0004875)
  • Bugfix: ccRetrieveCall used for net.Desktop based call transfer causes lost call (M5388)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.6 - General deployment
  • Bugfix: dbSetProfileParameters: parameters starting with "0" were not always synced correctly (M0005150)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.5 - General deployment
  • Bugfix: Some calls appear twice in the call history (M0005208)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.4 - General deployment
  • Bugfix: Disposition incorrect when a phone is in a queue
  • Bugfix: 'via' field and transfer incorrect when user is caller of both calls (M0004983)
  • Bugfix: Use SOP2 as fallback in case SOP1 database is down for dbAuthenticate (M0005103)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.3 - General deployment
  • Bugfix: API proxy daemon sometimes stops monitoring asterisk's event which can causes the AutoRecall action to miss behave (M0004886)
  • Bugfix: Query for dbGetDirectoryInfo fails if a "&" is in the internal directory. Note that now characters: '&' (ampersand) becomes '&', '"' (double quote) becomes '"', "'" (single quote) becomes ''', '<' (less than) becomes '<', '>' (greater than) becomes '>' (M0003168)
  • Improvement: Introduce wildcards support for dbGetDirectoryInfo (M0005098)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.2 - General deployment
  • Bugfix: net.Desktop attended transfer fails after attended transfer (M0004906)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.1 - General deployment
  • Bugfix: net.Desktop attended transfer fails after attended transfer (M0002475)
  • Bugfix: unable to transfer a call to non-standard location with netDesktop (M0003512)
  • Bugfix: Better memory management for the API proxy (M0004534)
  • Dependency:
    • Database Schema module v1.18 or higher
    • Asterisk-1.2 module v2.32.2 or higher

Version 2.33.0 - General deployment
  • Bugfix: e-mail addresses are now treated case insensitive (M0001427)
  • Bugfix: dbAuthenticate now works when the password is a parameter other than the first 12 of the profile (M0003984)
  • Bugfix: Agent Tab - Extension and first-name information not shown in some cases (M0004542)
  • Feature: Provides new private API (M0004705)
  • Feature: expose office in dbGetDirectoryInfo.php (M0003441)
  • Improvement: proxy.pl phone status publishing now depends on proxy.ini configuration file. (M0004527)
  • Dependency:
    • Database Schema module v1.18+
    • Asterisk-1.2 module v2.19+

Version 2.32.2 - Deprecated
  • Bugfix: Always connect on localhost for the Asterisk manager ccOriginate API calls (M0004726)
  • Deprecated: Module was rejected by or has not been validated by our quality assurance department. (M5733)
  • Dependency:
    • Database Schema module v1.17+
    • Asterisk-1.2 module v2.19+

Version 2.32.1 - General deployment
  • Bugfix: dbAuthenticate failed when SOP1 was down (M0004583)
  • Bugfix: net.desktop / API: api.ini should contain own sop as first entry. (M0004627)
  • Bugfix: dbGetPhoneState doesn't take the parameter 'phone_state' into account (M0002705)
  • Bugfix: added vars for dbGetProfileParameters and dbSetProfileParameters (M00047047)
  • Feature: added 'show_admin' parameter for dbGetProfileParameters (M00047047)
  • Dependency:
    • Database Schema module v1.17+
    • Asterisk-1.2 module v2.1+

Version 2.32.0 - General deployment
  • Feature: dbGetProfileParameter now supports global variables of type Enumeration (M0004557)
  • Improvement: When using GetXPath action, you can use variables with spaces (M0002251)
  • Improvement: proxy.pl binds on localhost if possible (M0004124)
  • Bugfix: ExecuteCOMXML failed when XML tag contained newline
  • Bugfix: Implicit wildcard removed for 'grp' parameter in dbGetDirectoryInfo.php (M0004242)
  • Bugfix: Wrong number was showing in netDesktop popup (M0003607)
  • Dependency:
    • Database Schema module v1.17+
    • Asterisk-1.2 module v2.1+

Version 2.31.0 - General deployment
  • Feature: ccOriginate will now set on the channels created the variable AuthenticatedExtension whose value is the one provided in the request. (M0004368)
  • Bugfix: Removed extra returning line in ccGetQueueMember which sometimes causes GetXpath to fail.
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.30.2 - General deployment
  • Bugfix: Allow the retrivieving of 42 profile parameters with dbGetProfileParameters (M0004707)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.30.1 - General deployment
  • Improvement: AGI script to allow backward compatibility with GetXpath 1.00 action
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.30.0 - Deprecated
  • Improvement: AGI script to allow multivalued results in GetXpath action
  • Bug: Phone reboot through phone status page does not work (M0003758)
  • Deprecated: If a GetXpath action is executed, and empty result now contains an empty value instead of a "Array" value. This might break certain callflows.
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.29.0 - General deployment
  • Feature: Able to ask if a phone is in a queue with ccGetQueueMembers
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.28.1 - General deployment
  • Bug: API proxy restart shell pluggin is not displayed
  • Bug: Installation not correct on baseline2
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.28.0 - General deployment
  • Feature: added support for Baseline 2.0 (M0003103)
  • Feature: notify a service extension when dbSetProfile is called (M0003156)
  • Feature: enable to restart API proxy in shell
  • Improvement: Rename net.PBX as SOP ip address
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.10 - General deployment
  • Bugfix: Backport from 2.33.3, Check for SOP1 down when (re)setting pincode too (M0005150)
  • Bugfix: Backport from 2.33.6, dbSetProfileParameters: parameters starting with "0" were not always synced correctly (M0005150)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.9 - General deployment
  • Bugfix: Backport from 2.33.3, API proxy daemon sometimes stops monitoring asterisk's event which can causes the AutoRecall action to miss behave (M0004886)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.8 - General deployment
  • Bugfix: Backport from 2.32.1, dbAuthenticate failed when SOP1 was down (M0004583)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.7 - General deployment
  • Improvement: Added show_invisible flag to dbGetDirectoryInfo in order not to filter out hidden directory entries (M0003330)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.6 - General deployment
  • Improvement: dbGetDirectoryInfo will accept the office search term
  • Improvement: dbAuthenticate will work also other types of parameters besides UserVar
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.5 - General deployment
  • Feature: dbGetDirectoryInfo can return a sorted list by last name, first name, extension or email address
  • Feature: wildcards in front of search terms can be enforced explicitely
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.4 - General deployment
  • Bug fix: ccGetChannels does not take into account parked_only and hold_only filters (M0002710)
  • Feature: Directory search for Swissvoice IP10S IP phones supported
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.3 - General deployment
  • Bug fix: No new voicemail notification (M0002176)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.2 - General deployment
  • Bug fix: dbGetExtensionState crashes on special extension such as '*666' (M0002483)
  • Bug fix: logrotate configuration files contains duplicate entry which causes logrotate to stop working (M0002220)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.1 - General deployment
  • Bug fix: Empty remote channel when local channel are used for example when call is done via the action CallExtension (M0002417)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.27.0 - General deployment
  • Bug fix: phone registration out of sync with the one of Asterisk (M0002067)
  • Feature: Added commands for UserPinCode handling
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.26.0 - General deployment
  • Improvement: avoid useless attribute_log entries (channels, probe messages, ...)
  • Bugfix: update attribute_state before attribute_log (netDesktop sometimes wrong callerid on incoming call)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.25.0 - General deployment
  • Bug fix: not able to pick up a call from your Group Pickup (M0001671)
  • Bug fix: Dynamic profile change not properly notified to the cluster (M0001682)
  • Feature: able to set callflow variable through ccOriginate 'var' parameter (format var1=value1|var2=value2 ...) (M0001707)
  • Feature: able to force a caller name for an extension through ccOriginate using the 'extname' parameter. (M0001707)
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.24.0 - General deployment
  • Bug fix (2.22+): ccOriginate should not set LastUserExt
  • Bug fix (2.22+): missing phone/channel sate event on unlink of two channels
  • Bug fix: incorrect remote channel after call transfer
  • Improvement: improved log file
  • Improvement: ccOriginate build caller name based on ext and not on phone_id
  • Improvement: added logrotate for /var/log/queue_log.log
  • Improvement: Force any GetXPath action to time out after 5 seconds
  • Improvement: Adapt apache configuration to deal with lot's of net.Desktop and net.Console instance
  • Feature: Added dbGetSMPUserURL to return the url of the smp user site.
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.23.0 - Deprecated
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • Feature: Added support of LDA phone in dbGetExtensionState
  • Bug Fix: hangup event does not always generate Idle channel state
  • Bug Fix: high CPU usage from mysql while handling queue events
  • Improve: reworked handling of field 'net.PBX IP addresses'
  • Improve: added logrotate for /var/log/queue_log.log
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.22.0 - Deprecated
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • Improvement: Added monitoring of AgentCalled in order to inform netConsole about the remote channel when its phone is ringing
  • Improvement: Added defence for queue_log
  • Bug fix: phone state not correct when asterisk answers directly the call (e.g. VoiceMail, IVR, etc.)
  • *Improvement:*Added possibility to add and remove non-SIP devices to a queue (ccQueueAdd, ccQueueRemove)
  • Bug fix: correctly return non-SIP queue members in ccGetQueueMembers
  • Feature: new attended transfer APIs (ccConsultationCall, ccRetreiveCal and ccTransferCall)
  • Improvement: Remote channel published from beginning of call setup
  • Bug fix: Remote Channel incorrect when CallExtension action is used (local channel instead of real channel)
  • Bug fix: Record call did not work when no voicemail was received
  • Improvement: added logrotate for /var/log/queue_log.log
  • Dependency:
    • Database Schema module v1.6+
    • Asterisk-1.2 module v2.1+

Version 2.21.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • ccScheduleApiCall API action added
  • Queue Member and MeetMe Usernum added in attribute_state
  • dbGetQueueInfo API action added
  • Channel state updated to 'Conversation' when hitting a MusicOnHold, Voicemail, Queue, ...
  • ccProvisionPhone API action added
  • ccRedirect improved with strict mode, preventing redirecting a channel to a non-existing extension
  • dbGetMobileStatus.php : giving a profile, return the external numbers dedicated to the satus change for that profile
  • improved parkedCall monitoring
  • added possibility to provide a list of queues in ccQueueAdd and ccQueueRemove
  • Dependency:
    • Database Schema module v1.6+

Version 2.20.0 - Deprecated
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • ccScheduleApiCall API action added
  • Queue Member and MeetMe Usernum added in attribute_state
  • dbGetQueueInfo API action added
  • Channel state updated to 'Conversation' when hitting a MusicOnHold, Voicemail, Queue, ...
  • ccProvisionPhone API action added
  • ccRedirect improved with strict mode, preventing redirecting a channel to a non-existing extension
  • new callerid was not notified after call transfer
  • Dependency:
    • Database Schema module v1.6+

Version 2.19.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • Improved garbage cleaning in asterisk listener process
  • Phone state detection improvement
    • Exposed in attribute bus
    • Used in dbGetPhoneState
    • Used in dbGetExtensionState
  • New event MessageWaiting
  • dbCallCount
  • dbGetDirectoryInfo: exposure of user fields

Version 2.18.0 - General deployment
  • I0
  • support of user fields in dbGetDirectoryInfo

Version 2.17.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
    • Fix attribute_state garbage collector. Channels in atribute_state did not reflect the actual channels in Asterisk. As a result net.Desktop could get several non needed popups upon incoming calls
    • Fix dbGetProfileParameters
    • Improved ccOriginate, taking into account the restriction group of a phone

Version 2.16.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
    • ccQueueAdd: members are now being added without penalty
    • dbGetExtensionStatus added to allow call toggling on primary and secondary phone (net.Console)
    • ccPickup added, allowing a user to pickup the call on colleagues phone
    • dbGetCallHistory, adaptation needed to display picked up calls

Version 2.15.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
    • Correction to dbGetDirectoryInfo to take into account the additional owner field in SMP 1.4

Version 2.14.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • dbGetMemberInfo
    • if exists, owner field is taken into account instead of admin field
    • member name is added in the MemberInfo section.
    • ERROR! This change has a major impact on existing installations. Make sure to set the correct the extension <-> owner relationship
  • ccOriginate
    • 'calledid' and 'uuid' channel variables set upon local channel creation
  • dbGetDirectoryInfoBody
    • if it exists, visibility flag is taking into account
  • proxy process
    • MASQ, ZOMBIE and AsyncGoto channels are being ignored
  • dbSetProfileParameters
    • uuid ignored
  • During an attended transfer, one of the channels was not removed from the attribut_state

Version 2.13.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • new dependencies added
    • escaux-base-1.3.deb
    • iputils-arping_3%3a20020927-2_i386.deb
    • escaux-phone-2.4.deb
  • phone state events are sent after all other events

Version 2.12.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • new dependencies added
    • escaux-base-1.3.deb
    • iputils-arping_3%3a20020927-2_i386.deb
    • escaux-phone-2.4.deb
  • phone state events are sent after all other events, hence avoiding possible race conditions
  • dbGetNextStatus API call added

Version 2.11.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations. IMPORTANT: upgrading from 2.10 to 2.11 requires assistance from Escaux. The unique constraint on attribute_state cannot be set if duplicates exist.
  • fix unique constraint on attribute_state
  • fix ref to svn repos for *.dbmu
  • uses 2.10 deb pkg

Version 2.10.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • attribute log rewrited
  • attribute log bug correction
  • attribute log debugging improvement

Version 2.9.0 - General deployment
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • Performance issue in dbGetCallHistory solved
  • Additional indexes are being placed on the CDR database. Beware when installing this version of the API module. The installation can impact DB performance during a couple of minutes.

Version 2.8.0 - Deprecated
  • Potential update impact level 1 DONE: no critical impact expected. Update can be applied without risk of breaking critical functionality.
  • ccRecord action added
  • attribute bus added

Version 2.7.0 - Deprecated
  • Potential update impact level 1 DONE: no critical impact expected. Update can be applied without risk of breaking critical functionality.
  • removed dbGetConsoleState.php
  • installed as a .deb package
  • Now also sending evPhoneState when a channel is being hung up

Version 2.6.0 - Deprecated
  • development version
  • Potential update impact level 1 DONE: no critical impact expected. Update can be applied without risk of breaking critical functionality.
  • rewrite of dbGetPhoneState to distinguish internal and external conversations
  • correction of Newcallerid event handling
  • correction of bogus evParked event sending

Version 2.5.0 - Deprecated
  • supports advanced reporting + queue reporting

Version 2.4.0 - Deprecated
  • Potential update impact level 1 DONE: no critical impact expected. Update can be applied without risk of breaking critical functionality.
  • rewrite of dbGetPhoneState to distinguish internal and external conversations
  • proxy.pl: correction of Newcallerid event handling and evNewOrigChannel display
  • proxy.pl: correction of bogus evParked event sending

Version 2.3.0 - Deprecated
  • Potential update impact level 2 DONE: in the event this update contains a bug, it might have critical impact. Respect dependencies and retest your most important callflows and applicative integrations.
  • Minor modifications have been made to proxy.pl. It is not expected that there is an impact on existing functionality but due to the importance of the proxy.pl process, the impact level is 2.
  • proxy.pl
    • added updateparkslots, allowing to retrieve the parked channels and slots via dbGetParkedChannels.php
    • improved updatechannels, improving the robustnes of dbGetPhoneState.php
    • various events are sotred in the attribute_log table
  • New API calls:
    • ccGetQueueMembers.php
    • ccGetQueueStatus.php
    • ccSetVar.php
    • ccGetVar.php
    • ccQueueAdd.php
    • ccQueueRemove.php
    • ccQueuePause.php
    • dbGetConsoleState.php
    • dbSetCustomAttributeLog.php
    • dbGetCustomAttributeLog.php
    • dbGetParkedChannels.php
    • dbGetPhoneTrigger.php
  • required for net.Console
  • required for net.Desktop
  • Known bugs:
    • proxy.pl fires off a bogus evParkedCall every minute. This displays a bogus parked channel in the VB COnsole application. Recommended workaround is to install version 2.2.

Version 2.2.0 - Deprecated
  • Accepting Queue Calls in Operator Console

Version 2.1.0 - Deprecated
  • Callback installation fix

Version 2.0.0 - Deprecated
  • attribute log
  • required for net.Desktop
  • compatible with smp 2.x branch

Version 1.13.0 - Deprecated
  • required with asterisk 1.2
  • proxy.pl adapted to asterisk 1.2: Callerid changed to CallerID

Version 1.12.0 - Deprecated
  • based on 1.8 (not 1.10)
  • solves a bug in 1.8 where dbGetDirectoryInfo.php returns false 'busy' extensions
  • last stable version for asterisk 1.0

Version 1.8.0 - Deprecated

Version 1.7.0 - Deprecated

Version 1.6.0 - Deprecated

Version 1.5.0 - Deprecated

Version 1.4.0 - Deprecated

Version 1.3.0 - Deprecated

Version 1.2.0 - Deprecated

Version 1.1.0 - Deprecated

Version 0.0.0 - Deprecated
  • Improvement: ccQueueAdd: members are now being added without penalty
  • Improvement: dbGetExtensionStatus added to allow call toggling on primary and secondary phone (net.Console)
  • Improvement: ccPickup added, allowing a user to pickup the call on colleagues phone
  • Improvement: dbGetCallHistory, adaptation needed to display picked up calls
  • Deprecated: Significant improvements have been done in a higher version

Module configuration interface

create_resource_form: .:/usr/share/escaux/glue/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib:/usr/share/escaux/glue/bin/gen_wiki_documentation/src/lib/

Extension called on intentional status change
Mode
Enable Proxy engine API
Extensions called on profile parameter change (YAML)
Extension called on queue toggle
Permission constraints on status (YAML)
Extension called on queue policy toggle
Queue policy default

Administrator guide

For installation of SOP API 4.0.0, please refer to the administrator guide.

Module configuration parameters

  • SOP IP addresses: Enter a comma separated list of SOP servers in your network. It accepts IP addresses as well as SOP keys (for example: 4, 128, 010, 0024, ..., 00000009). If this field is left empty, the default value will be the IP address of the local SOP. Do not include gateways and standby servers as these servers will be queried iteratively during an API call. (Since version 4.16.0 this option has been deprecated, it is recommended to use Unified Communication Model to import contacts)
  • dbSetProfile callback service extension: If not empty, the specified extension will be called when the dbSetProfile API is called after the profile/status has been changed. Note that status change on the SMP prior to SMP 5.3.0 does not make use of the SOP API. The extension will receive the following API call variable environment:
    • ${CALLERID(num)} is the extension for which the profile/status has been changed.
    • ${dbSetProfileProfile} is the new profile.
    • ${dbSetProfileStatus} is the new status.
  • Mode
    • Compatibility - when using this mode, you will be able to access the contents of the API using port HTTP on port 80 . As well as HTTPS on port 443.
    • Secure - when using this mode, you will not bet be able to access the contents of the API using port HTTP on port 80 from an external source, you might still use GetXPath to make requests to localhost. You will be able to execute requests in HTTPS on port 443.
  • Certificate Validity Period - Expresses the number of days that your certificate will be valid. The SOP API module must be reinstalled to renew the certificate validity period.
  • HTTPS ports - Lists the ports to be used by HTTPS. Do not force the usage of port 4446 when using compatibility mode. Letting this field blank is generally the best option.
  • Enable Proxy : Enable the generation of events sent to desktop applications. Enable this if you need net.Desktop or net.Supervisor. Note that net.Console is not affected by this setting.

Example of use

A callcenter wants to use the status of an agent to define if the phone has to be in a queue. For example, when the agent is in status 'office', the phone should be placed in the callcenter queue. If the agent changes his status to 'outofoffice', the phone should be taken out of the queue. If the status is 'Pause', the phone should be paused in the queue To achieve this, you will have to define a callflow that handles this logic (ex: *055):
  • First action : look if ${CHANNEL:0:5} equals 'Local'. This should be done because the API will set up a complete call to this extension (ie: the first and second call leg will call this extension). To avoid that this callflow gets executed twice, just hangup if the parameter does not contain 'Local'.
    • If it contains 'Local', you could, for example, lookup the profile of ${CALLERID(num)} using GetXPath: this is the profile of the extension for which the status has changed. If the profile is not Agent, just hangup the call (you only want to put the phone of an agent in the queue). When hanging up, force the call to be answered first. If you fail to do this, this will indicate an error in the logs
      • If the profile is 'Agent' , you need to know which phone he has in order to add/remove it from the queue. To do this, you can use the action GetExtensionInfo.
        • check if the status changed to a specific status (the name of the status will be in ${dbSetProfileStatus} ) and put the logic you want behind (addqueuemember if the status changes to office, removequeuemember for outofoffice, ...)
        • hang up the call and force the call to be answered first to avoid errors

After this, link this callflow to a profile.status (Callflow studio -> Callflow assignment), for example: STARTAPPLICATION dbSetProfileAgentLogger Status *055

Make an internal extension (ex: 9999) with this profile.status and fill in this extension in the SOP API module. If someone changes his status, 9999 will be called, meaning that your callflow with status changing logic will be executed.

API Reference Guide

For detailled instructions on how to request the API and on how to process the answers send back from it, see the Fusion SOP API Reference Guide.
Copyright © Escaux SA