Changes Log

Release 1.11.2

New APIs:

• Privacy Service and Privacy Service: Privacy service, for End Users and some types of Service Users.

• Can Edit End User Properties: Added an API to check if there are some constraints that prevent to modify some properties of the profile of the End User.

Modified APIs:

• Announcements, Announcements and Tenant Pre Alerting Announcement: added new error code 65 (TOO_LARGE) when the AS rejects the file due to its size. Added a new capability to fallback to older smaller encoding in that case, controlled by new settings AUDIO_TOO_LARGE_FALLBACK_OLD_MODE

Fixes:

• In some APIs when a service was not assigned, the error_code SERVICE_NOT_ASSIGNED (2”) was sometimes wrongly replaced by the more generic code NOT_FOUND_AT_NE (8). The HTTP status remains 404 Not Found.

New features:

• Detection of user deleted while logged: when a OCI error code User Not Found is received it is checked if it reports the same user id as the one of the user currently connected. If it is the case it assumes the user has been deleted and it returns a 401. This new logic can be disabled

Release 1.11.1

Modified APIs:

• Remove Trunks Users from a Trunk Group, Delete an user, Delete a group and Remove a tenant : added _excludedAppIds to allow to keep some End User App Data after delete. Warning: they must afterwards be deleted by the caller!

• Group Trunk Group: fixed the different RerouteTrunkGroup elements to use same naming convention. Allowed to use Null value to remove them. Added the parameter includeEnterpriseTrunkGroups in the GET List operation.

Fixes in documentation:

• List users, List users: search filter on trunk user/hpbx user (insensitiveUserInTrunkGroupEquals) was not documented

• The South Data: added a description of the format of the South Data in Audit Records.

New features:

• Phone Vendors, Call Recording Vendors and Transcribe Vendors interactions are now included in audit records (can be disabled)

• Multi-AS, it is now possible to define the AS System Default Domain by AS (Backend).

Release 1.11.0

New APIs:

• Retrieve the list of tags available for a group device profile: Added Read API to retrieve the list of available tags for a device profile.

Modified APIs:

• Configuration Information for the Password, Configuration Information for the Password, Configuration Information for the Passwords, Configuration Information for the Passwords: Added the notion of minimum password rules when generating/checking password for end users (including hoteling hosts)

• Configuration Information for the Password, Configuration Information for the Password, Configuration Information for the Password: Added the notion of minimum password rules when generating/checking password for the admins.

• Configuration Information for Change Password: Added the notion of minimum password rules when generating/checking password for the end users or any type of admins.

• Add Trunks Users to a Trunk Group: Added the notion of minimum password rules when generating password for the trunk users.

• Configuration Information for the Device Credentials: Added the explanation on how the “hidden” device credentials are generated (from this release)

• Configuration Information for the End User Password Rules, Retrieve password rules of the Group Admins, Retrieve password rules of End Users, Configuration Information for the Tenant Admin Password Rules: Added the notion of minimum password rules when exposing the password rules that will be apllied.

• Login profile attributes: now the full real username is always included in the answer.

• Retrieve Access Device details, Display the Phone of a User: additional attributes defined as hidden are no more returned in the answer

Release 1.10.5

Modified APIs:

• Consume Token: Added the possibility to force a password change in the AS to match the expected password for the SSO login (disabled by default)

• Login, Retrieve user Login Session Info and User Login Info: added the information is_enteprise in the answer when available and relevant.

• Retrieve list of IVRs, Retrieve list instances and Retrieve list instances: added in these APIs the logic linked new settings GROUP_NUMBERS_USE_CC_CLI to control the behavior of part of this API (number format).

Release 1.10.4

New APIs:

• Retrieve a list of route point’s dnis agents, Route Point forced forwarding, Route Point call disposition codes and Route Point call disposition codes settings: additional APIs related to Route Points

• Phone Types Management: Added CRUD APIs to manage the phone type.

• Group Device Type Tags and Group Device Type Properties: New APIs to manage Tags for Device Types at Group level. Either direcltly or using an abstraction layer.

Modified APIs:

• Create an access device, Update an access device, Assign a Phone to a User, Update the Phone of a User, Create an Additional Phone for a User and Update an Additional Phone of a User : added deviceActivationCode in answer.

• Configuration Information for the Additional Phones; “Connect - Tablet” has been added in the default value of the configuration settings DEVICE_TYPES_FOR_INTEGRATED_APPS

• Retrieve group details and Retrieve an user: Added the timeZoneDisplayName in the answer when available. Note that it was already present in Service Users but not document (now it is documented).

• Phone Type Attributes: Added the notion of groupGeneric

New features:

• Cisco Phone Vendor Provisioning is now supported in addition of the ones currently supported (Yealink, Panasonic, Snom, Polycom and Grandstream).

Release 1.10.3

New APIs:

• 2 Levels Applications Data: Added the possibility to manage Application Data with 2 levels of keys (key and subKey).

• Group Device Type Tags: Added APIs to manage (individually) the Tags linked to Device Types at Group level.

• Create instance, Retrieve instance, Retrieve list instances, Update instance, Delete instance and Update Route Points’s active status: added CRUD operations on Route Point instances

• Announcements, Overflow, Distinctive Ringing, Route Points DNIS and Bounced Call: added Overflow, Bounced Call, Distinctive Ringing, DNIS (Config, CRUD, Announcements) and Announcements properties of Route Points.

• Routing Policies - Holiday Service and Routing Policies - Night Service: added Night Service and Holiday Service routing policies of Route Points.

• Modify the Device Type of any Access Device: Added an API to modify the Device Type of any device in the system.

• Feature Access Code: List and update FACs at End User level.

• End User Applications Data: Added the possibility to manage Application data for End Users.

• List Users Application Data, List Users Application Data: Added the possibility to search for End Users Application data at Tenant and Group levels.

Modified APIs:

• Login, User Login session info and User Login Info: added new option field “role” in the “profile” answer from these APIs

• Admin Profile Management, Tenant Admin Profile Management, Reseller Admins and Local Users: added the optional field “role” in POST, PUT and GET operations.

• Profile Management : added the field physicalLocation in the trunkEndpoint

• Listing available numbers and Retrieve list instances : added new settings GROUP_NUMBERS_USE_CC_CLI to control the behavior of part of this API.

• Retrieve an user, Retrieve instance, Display group’s IVR instance, and Retrieve instance: if the AS answer contains a country code indication that country code will be used for the E164 normalization (can be disabled in the Backend object settings) .

• Retrieve main profile data of objects: added the userType route point

• User Main Phone’s Primary line status: fixed the typo in the url definition primay_line_port instead of primary_line_port. But still support the url with the typo for backward compatibility reason.

• Configuration Information for the User Ids in the List answer, Configuration Information for the User Ids in the List answer, Configuration Information for the User Ids in the List answer: new config parameter for the handling of User Ids without domain.

Fixes in documentation:

• Shared Call Appearance: indicated in the APIs what fields are optional.

Release 1.10.2

Modified APIs:

• Create an admin: added new logic to handle different domain in case of admin created without domain

Release 1.10.1

New APIs:

• Retrieve Access Device End Points list: Added the possibility to fetch the list of device end points at Group level

• Call Policies: Added the User Call Policies

Modified APIs:

• Call Processing Policy: added new parameters from AS rel 22 and rel 23.

• Retrieve the status of bulk asynchronous jobs and Retrieve the status of bulk asynchronous jobs: Have been enhanced with a new optional input parameter withResult to include the result_data of each job.

• In list APIs of end users, we have renamed includeServiceUsers into includeHiddenUsers to avoid some confusion on the meaning. Old name is still supported as fallback.

Fixes in documentation:

• List users, Configuration Information for Meet-Me Conferencing Management, Configuration Information for Flexible Seating Management, Configuration Information for IVR Management, Configuration Information for CC Management, Configuration Information for Hunt Group Management: fixed the default auto-gen values

• Voice Messaging Calling Party Info: fixed the O/A for the attributes.

Release 1.10.0

The release 1.10.0 is dedicated to upgrade many embedded third parties libraries to their latest version compatible with Django 3.2.latest and Python 3.6.

It does not bring new API.

Release 1.9.7

New APIs:

• Inventory Report System Configuration and Inventory Report: Added the Inventory Report feature at System and Group level

• Device Profile Authentication Password Rules, Tenant Device Profile Authentication Password Rules: GET and PUT APIs to manage Device Profile Authentication Password Rules at System level and Tenants Levels.

Modified APIs:

• Create an admin: Aligned the behavior on the Tenant level: allow to not provide a password and it will be auto-generated.

• Registrations: Now we support to have registration without expiration date

• Add Trunks Users to a Trunk Group: Adapted the API to do smoother E2E external Trunking integration (such as MS DR)

Release 1.9.6

New APIs:

• Call Processing Policies, Call Processing Policies: GET and PUT APIs to manage Call Processing Policies at System and End User levels.

Modified APIs:

• Voice Mail Main Parameters: breaking change in the way the Transcribe option is working in order to allow several transcribe email addresses (requested by the only customer currently using that feature).

• Access Device Advanced Management, Group Flexible Seating, User Main Phone, User Additional Phones Services, User Flexible Seating: added a new global option (same for all APIs) to use a generic rule for the device name when the specific rule generates a too long value.

• Login: in case of End User, if he has a main phone number, it is returned in the login answer.

• Login: support of the login using Alternate Ids for the Group Admins and Tenant Admins

• User Login Info: support of using Alternate Ids as username for the Group Admins and Tenant Admins

• Update the parameters of one service for multiple users at Tenant level and Update the parameters of one service for multiple users at Group level: added services Update a user’s call forwarding not reachable, Update a user’s calling line id delivery blocking and Update a user’s call forwarding no answer with voice mail

• Add group’s trunk group: Added the possibility to use trunkingMode in the POST API to indicate it is a MS Teams DR TG and the relevant default template has to be sued. Ignored if a templateName is provided in the request.

Fixes in documentation:

• Group Trunk Group: added the description of some parameters that were supported but not documented.

• Call Processing Policies and Call Processing Policy: Completed the doc of the GET and PUT APIs to manage Call Processing Policies at Tenant and Group levels.

Release 1.9.5

Warning: MS Teams related APIs are still under development and could be unstable or subject to signature change until the version is released.

New APIs:

• Feature Access Code: Added PUT and GET for manage the features access codes at Tenant level.

• Teams Status: new APIs to know the teams status at Group level and update it (up to some extend).

• SIP Password rules: Added PUT and GET for manage the security rules that a SIP password should follow.

• Move users list to another tenant’s trunking: Move users list to tenant’s trunking

• Move Trunks Users to a Trunk Group: Move Trunks Users to a Trunk Group

Modified APIs:

• Add Trunks Users to a Trunk Group: support of different logic for linePort generation when the Trunk Group is for MS teams Direct Routing.

• Add Trunks Users to a Trunk Group, Remove Trunks Users from a Trunk Group, Add group’s trunk group, Display group’s trunk group, List group’s trunk groups and Configuration Information for Trunk Group: added a new parameter trunkingMode in the answer to indicate the type of trunk (‘normal’, ‘teamsDR’) and as optional filter on the GET List.

• Display Executive available assistants: added optional filter sameGroupOnly

• Update group’s trunk group: added the support of the value “” for callForwardingAlwaysAction to set ‘no action’.

Release 1.9.4

New APIs:

• Group Flexible Seating: Added CRUD APIs to manage the Flexible Seatings service at Group Level.

• User Flexible Seating: Added CRUD APIs to manage the Flexible Seatings service at User Level.

• User Advanced Flexible Seating: Added advanced CRUD APIs to manage the Flexible Seatings service at User Level.

• Create a digit string in a Group: Create a digit string in a Group

• Modify a digit string in a Group: Modify a digit string in a Group.

• Update the parameters of one service for multiple users and Update the parameters of one service for multiple users: Bulk update of the same service for several end users at Group and Tenant level.

• Retrieve the status of bulk asynchronous jobs and Retrieve the status of bulk asynchronous jobs: Reports on the result of bulk jobs if launched in asynchronous mode.

• Outgoing Digit Plan Services: Added APIs to manage the User’s Outgoing Digit Plan

• Outgoing Digit Plan Services: Added APIs to manage the Group’s Outgoing Digit Plan

Modified APIs:

• Outgoing Calling Plan Services: Added the support of the Digit Plan in the Calling Plan (combined APIs).

• Configuration Information for Trunk Group: Improved the on_cascade, keep_device and keep_numbers behaviour with default settings.

• Outgoing Calling Plan Services: Added the support of the Digit Plan in the Calling Plan (combined APIs).

• Remove a digit string from a Group: Remove a digit string from a Group

Release 1.9.3

New APIs:

• Retrieves tenant’s trunking available trunk user list: retrieves the list of the available users.

• Retrieves tenant’s trunking available trunk group list: retrieves the list of the available trunk groups.

• Advice of Charge Service: Advice of Charge end user service.

• System Configurable Treatment: Added CRUD to manage configurableTreatments.

• PrePaid Services: added APIs at end user level to manage the prepaid service.

Modified APIs:

• Retrieve a tenant’s trunk instance, Create a tenant’s trunk, Update a tenant’s trunk instance: added support to enableCapacityManagement, maxActiveCalls, capacityExceededTrapInitialCalls, capacityExceededTrapOffsetCalls (only from OCI Rel 21).

• Create service packs: auto_auth_services has been added to allow to authorize automatically the services at tenant and Group level if needed.

• Modify an existing key of an application, Modify an existing key of an application and Modify an existing key of an application: auto_create has been added to allow the auto creation of the target application data if it does not exist.

• Retrieve list of possible agents: added sensitiveUserGroupEquals search criteria.

• Configuration Information for Change Password, Configuration Information for Change Password of User, Configuration Information for the Password, Configuration Information for Update an user, Configuration Information for Group Admin Profile Management, Configuration Information for Tenant Admin Profile Management, Configuration Information for Create/Modify a Local User, Configuration Information for Create/Modify a Reseller Admin: added new APIO password validation.

• Tenants Profile Management and Tenant Profile Management: added formal support of external ids and resellerId in all APIs including search criteria on the GET List.

• Remove a tenant: added deletedGroupIds in the answer.

• System Domains: fixed the rights of the GET method: it was restricted to System Admin while it is allowed from End User.

Fixes in documentation:

• Tenant Trunking: added an example of priorityWeightedRouting and fixed the definition of that element.

Release 1.9.2

New APIs:

• Group Pre Alerting Announcement: added APIs at group level to manage the pre alerting announcement service.

• Tenant Pre Alerting Announcement: added APIs at tenant level to manage the pre alerting announcement service.

• User Password Rules: added APIs to retrieve the password rules that applies to a user (self or a managed one)

Modified APIs:

• Create an access device: deviceName can now be auto-generated (no rule defined by default so still mandatory by default)

• Configuration Information for Trunk Group: added on_cascade, keep_device and keep_numbers.

• Add Trunks Users to a Trunk Group: Fixed the fact that auto_create with value false was not handled correctly

• Display user’s phone directory list entries: Added a parameter noContacts to allow to not include Common Phone List in the directory.

New features:

• Grandstream Phone Vendor Provisioning is now supported in addition of the ones currently supported (Yealink, Panasonic, Snom and Polycom).

Release 1.9.1

New APIs:

• SSO Token Login: Possibility to log a user using a token mechanism.

• Communication Barring Digit Pattern: Added CRUD APIs to manage communication barring digit patterns at tenant level.

• Communication Barring Profile: Added CRUD APIs to manage communication barring profiles at tenant level.

• Group Communication Barring Profile: Added APIs to manage communication barring settings at group level.

• Communication Barring for a user: Added APIs to manage communication barring settings at user level.

Modified APIs:

• Phone Type: Phone Definition and Phone Types: added needSerialNumber field, added labelRequired and labelIgnored in the fastkey configuration.

• Assign a Phone to a User, Display the Phone of a User, Create an Additional Phone for a User, Retrieve the Additional Phone of a User, Update an Additional Phone of a User: added serialNumber field

• Create a tenant admin and Create an admin: added the possibility to specify a userprofileType or a loginMode different than the default one.

Fixes in documentation:

• Assign a Phone to a User, Display the Phone of a User, Update the Phone of a User, Delete the Phone of a User, Reset the Credentials of the Phone of a User, Reboot the Phone of a User: added authorization rights.

• Call Center Instance: added internalPreferredAudioCodec field, modified agentUnavailableCode field description.

• Retrieve instance: added agentStateAfterCall field, modified agentUnavailableCode field description.

New features:

• Polycom Phone Vendor Provisioning is not supported in addition of the ones currently supported (Yealink, Panasonic and Snom).

• Part of Cisco CPP phones phone buttons on main phone can now be configured.

Release 1.9.0

New APIs:

• Update password rules: Added PUT API to manage security rules of passwords for the users in a Group.

• Update pincode rules: Added PUT API to manage security rules of pincodes for the users in a Group.

• Update pincode rules: Added PUT API to manage security rules of pincodes for the users in a Tenant.

• Update password rules: Added PUT API to manage security rules of passwords for the users in System.

• Update pincode rules: Added PUT API to manage security rules of pincodes for the users in System.

• Retrieve password rules of the Tenant Admins: Retrieve all the active security rules that a password should follow for the admins of this Tenant.

• Retrieve password rules of End Users: Retrieve all the active security rules that a password should follow for the users in this Tenant.

• Retrieve password rules of the Group Admins: Retrieve all the active security rules that a password should follow for the admins of this Group.

• Retrieve password rules of End Users: Retrieve all the active security rules that a password should follow for the users in this Group.

• Adding Extra Lines to the User’s Phone: Possibility to add extra lines from the target user side.

• Get the list of a group call disposition codes: Get the list of a group call disposition codes.

• Create a new Tenant call disposition code: Create a new Tenant call disposition code.

• Get a Tenant call disposition code instance: Retrieve a Tenant call disposition code instance.

• Modify a Tenant call disposition code: Modify a Tenant call disposition code.

• Remove a Tenant call disposition code: Remove a Tenant call disposition code.

Modified APIs:

• List devices, Retrieve list of groups, List users, Tenants Profile Management, Get the utilization of a single DN, Tenant Profile Management: Added explicit multi-as support (backendName and backendExternalName).

• Retrieve password rules: added support to forcePasswordChangeAfterReset (only from OCI Rel 22).

• Update list of agents of a Call Center: added support to skilledAgents for premium call centers with skill routing type only.

• Delete a group: added Configuration option for the Delete API in order to allow the enabling of a check “do not delete if not empty”.

• Tenant level, Get a call center agent unavailable code instance, Modify the call center agent unavailable code, Remove a call center agent unavailable code: fixed url definition.

• Group level, Get a call center agent unavailable code instance, Modify the call center agent unavailable code, Remove a call center agent unavailable code: fixed url definition.

• Get the list of a call center’s call disposition codes: added the level in the answer.

• Modify the call center dnis instance: enriched the PUT answer with the “name” field.

• Retrieve the User’s Phone Extra Lines: Return, if known, the number of ports still available on the device (1.9.0RC2)

Fixes in documentation:

• Update list of agents of a Call Center: fixed reference to agents.

New documentation section:

• APIO Multi-AS Concepts and Configuration: Describes globally (meaning cross APIs) the multi-as concept

Release 1.8.4

New APIs:

• Reseller Admins: Added CRUD APIs to manage the Reseller Admins in APIO DB in an easier way.

• User Profiles Types; Added a GET API to retrieve the configured User Profile Types.

• Display service user’s basic call logs, Delete all service user’s basic call logs: Retrieve/Delete the logs from the Basic Call Logs service of the service user.

• List service user’s voice mails, Update a service user’s voice mails status: Retrieve/Update the list of voice mails of the service user.

• Retrieve a service user’s voice mail instance, Update a service user’s voice mail instance, Delete a service user’s voice message instance: Retrieve/Update/Delete a voice mail instance of the service user.

Modified APIs:

• Create instance, Create instance and Create a group’s IVR instance: language taken from settings of not provided (aligned on other APIs for consistencies)

• Retrieve instance, Retrieve list instances: Added enrichCcInfo parameter in order to enrich the user call center list with name. Added sensitiveServiceUserIdEquals search criterion in order to filter the user call center list to the requested call center.

• All the End User services with Criteria: Allow to remove the schedule in the PUT.

• Retrieve list of groups, Display Tenant’s phone directory list entries, Display user’s phone directory list entries and Display User’s personal phone list: Added support of paged answer (provided by the AS, not the APIO). It requires of coruse that the AS version supports it.

• Voice Mail Main Parameters: Added the transcribe option.

Fixes in documentation:

• Configuration Information for the User Id: section added to describe the user id auto-generation

• User Profile Attributes: adapted the R/O for the POST based on latest evolutions of the API with indication on how some fielads ae generated if not present.

• Group CRU APIs: added missing parameters descriptions and adapted examples.

• Clarified at several places that the announcement size in in KB.

• User Group Night Forwarding: added the allowed values for the field nightForwarding

Release 1.8.3

New APIs:

• Resellers: Added CRUD APIs to manage the Resellers in APIO DB.

Modified APIs:

• Tenants Profile Management and Tenant Profile Management: Added resellerId

• Groups and Profile Management: Added resellerId

• Phone Types: Added new parameters to the phoneType object. Improved the GET List with the possibility to filter by “main” or “extra” device.

• Update tenant details and Update group details: Added autoCreateDomain

• Retrieve the impacts of defining a full new set of Service Packs (among others for the Integrated Clients): added new parameters related to the main device.

• Time Schedules, Group Time Schedules and User Time Schedules: Improved error reporting when the schedule period is not compatible with the simple mode (62 SCHEDULE_NOT_COMPATIBLE_SIMPLE_MODE)

New template actions:

• tenant_assign_domains for Tenant level, based on PUT method of Tenant Domains.

• group_assign_domains for Group level, based on PUT method of Group Domains and PUT method of Tenant Domains.

New options in template actions:

• Default values: dynamic default values support.

Release 1.8.2

New APIs:

• Holidays Added APIs to retrieve the years and countries for holidays on APIO DB.

• Delete all user’s basic call logs Added the possibility to delete all call logs of an end user.

• List devices in Tenant: Added API to list access devices at Tenant level.

• User Communication Barring Authorization Codes: Added APIs to manage communication barring authorization codes at user level.

Modified APIs:

• Access Device Advanced Management: A new parameter is available in errors to give more details when the issue is linked to phone vendor error (see Sub Error Codes for Phone Vendor)

• User Multiple Mobile Numbers: Adapted the POST API to make more fields optional, fixed the authorization rights (bug: user was not allowed to play commands while he should have been)

• Group Advanced Time Schedules, Group Calendar Schedules, Group Time Schedules, User Time Schedules, User Calendar Schedules, User Advanced Time Schedules: Added new input parameter to include the parent level schedules within the response.

Release 1.8.1

New APIs:

• User Main Phone’s Primary line status Added APIs to manage the Primary Line Port status of the Main Device of an End User.

• Polycom Phone Services for User Main Phone: Added APIs to manage the Polycom Phone Services of the Main Device of an End User.

• System Call Recording: Added APIs to manage the call recording platforms at system level.

• Group Call Recording: Added APIs to manage the call recording platform at group level.

• User Call Recording: Added APIs to manage the call recording settings at user level.

• Call phone number: Added API to do a phone call.

• Retrieve Call List: Added API to retrieve the list of the ongoing phone calls.

• Retrieve Call Details: Added API to read the status of an ongoing phone call.

• Call State Modify: Added API to modify an ongoing phone call.

• Release Call: Added API to release an ongoing phone call.

• Call Retrieve: Added API to support the Call Retrieve.

• IMRN Resource Create: Added API to create an IMRN resource to anchor a mobile call.

• Send Fax: Added API to support file to be faxed.

• Retrieve Fax List: Added API to support retrieve of non-expired statuses of previous fax.

• Retrieve Fax: Added API to support retrieve of non-expired fax.

Modified APIs:

• Create a user’s call forwarding selective criteria: Auto configuration support when adding a new criterium and no default forwarding number defined.

• Create a user’s call forwarding selective criteria: Added new returnGlobalSettings optional request parameter for alternate response when autoconfiguration support is enabled.

• Call Capacity Management: Adapted to allow remove call limitation for outgoing and incoming calls (maxIncomingCalls, maxOutgoingCalls). Do not return these fields in GET and GET List if no set.

• Display user’s custom ring back, Display user’s selective call rejection, Display user’s selective call acceptance, Display user’s pre alerting alerting announcement, Display user’s call notify, Display user’s simultaneous ring personal, Display user’s sequential ring , Display user’s call forwarding selective and Display users’s list of criteria : added timeScheduleObj and holidayScheduleObj in the criteria, removed timeSchedule and holidaySchedule from the criteria when they are not set (instead of a dummy value).

• Retrieve main profile data of objects: For each object (tenant, group, user) added an alias field “id” with same value as “tenantId”, “groupId” or “userId” dependant on the object.

• In object Login profile attributes: added expires_in attribute that will be present when relevant.

Release 1.8.0 (previously named 1.7.4)

New APIs:

• Update the port (order) of the Users connected to an Access Device Added the PUT on an endpoint supporting only the GET

• Delete a user’s announcement and Delete a group’s announcement: Added APIs to delete one announcement; before only the delete of a list was possible.

• User Multiple Mobile Numbers: Added APIs to support multiple mobility identities.

Modified APIs:

• Retrieve List of Users connected to an Access Device: Added new fields in answer to help allow the client to know if a PUT is supported or not.

• Call Forwarding Selective: Removed the field doNortPerformAction as in these APis it is replaced by forwardToNumberSelection.

• Get the utilization of a single DN: Added parameter to get call center type for call centers numbers.

• Default Announcements Catalog: Added parameter includeEmpty (with default False) to prevent by default to list the announcements without content that will not be usable in other APIs.

• Create a user’s announcement and Create a group’s announcement: in case of import of announcement from the catalog if the name is too long it will be cut to 80 chars; therefore it returns the name in the POST answer as it could have been truncated.

• Remove Trunks Users from a Trunk Group: Added an extra check to verify the number that is requested to be deleted is part of this Trunk Group and not an other one; with new error_info “This phone number does not belong to this Trunk Group”.

• Listing available numbers: New settings allow to control the way to Group CLI is reported in this API.

Release 1.7.3

New APIs:

• Session Admission Capacity Control Added APIs to manage session admission capacity control.

• Session Admission Control Group Added APIs to create, update, delete, delete list, read a group’s devices and read available devices of SAC groups.

• User Advanced Time Schedules Added APIs to manage time schedules in advanced mode at user level.

• Group Advanced Time Schedules Added APIs to manage time schedules in advanced mode at group level.

• Tenant Advanced Time Schedules Added APIs to manage time schedules in advanced mode at tenant level.

• Retrieve main profile data of objects Added API to retrieve the profile information of some objects.

• Tenant Immediate Trunking Connectivity Added APIs to manage the Immediate Trunking Connectivity (Route List) at Tenant level.

• Group Immediate Trunking Connectivity Added APIs to manage the Immediate Trunking Connectivity (Route List) at Group level.

• User Immediate Trunking Connectivity Added APIs to manage the Immediate Trunking Connectivity (Route List) at User level.

Modified APIs:

• Executive Assistant: adapted Executive Assistant endpoints to clearly identify selected executive

• Retrieve the AS(s) Hosting a Tenant, Login, Retrieve user Login Session Info and User Login Info : added the backendName and the backendExternalName in the answer.

• Group Trunk Group APIs (PUT, GET, POST) have been updated to expose new parameters limitOutgoingCalls and limitIncomingCalls to overcome some limitations linked to the value 0.

• Get configuration, Update configuration, Get configuration and Update configuration are adapted with new parameters coming from BW rel21.

• Local Users Adapted the APIO to offer the possibility to manage other loginTypes than the pure local ones.

• Update a busy lamp field’s monitored users: added the possibility to auto generate uri

• Display busy lamp field’s available users: added parameters to extend the functionalities

• Retrieve the impacts of defining a full new set of Service Packs (among others for the Integrated Clients) and api_user_new_sp_analysis: the new pearameters excluded have been added and the exlusive logic has been better explained. (in 1.7.3RC3)

Release 1.7.2

New APIs:

• Call Park: added APIs to: manage group call park CRUD operations, get the available users and get the available alternate recall users

• Group Custom Ringback Added APIs to manage group custom ringback settings.

• User Automatic Hold/Retrieve: added APIs to manage user automatic hold/retrieve service

• User Barge-In Exempt: added APIs to manage user barge-in exempt service

• Call center forced forwarding Added APIs to manage the call center forced forwarding.

• Call center comfort message bypass Added APIs to manage call center comfort message bypass.

• User Login session info Added APIs to retrieve and modify profile info of the logged user.

• Enterprise Departments Added APIs to manage tenant (enterprise) departments.

Modified APIs:

• Display group’s trunking capacity: now the Group Admin can use the GET API (before only from Tenant Admin)

• Added the calculated language_code in login APIs, in login_ino APIs, on end user profile, group admin profile, tenant admin profile and local user profile GET APIs.

• Sequential Ring and Simultaneous Ring Personal: Removed the validation that the number is a valid phone number as it can be an extension too.

Fixes in documentation:

• Bounced Call: Fixed documentation for single parameters suitability based on call center type.

• Stranded Call: Fixed documentation for single parameters suitability based on call center type.

• Stranded Call Unavailable: Fixed documentation for single parameters suitability based on call center type.

Release 1.7.1

New APIs:

• List all authorization codes in a Department List all authorization codes in a Department.

• Get an authorization code in a Department Get an authorization code in a Department.

• Create a list of authorization codes in a Department Create a list of authorization codes in a Department.

• Create an authorization code in a Department Create an authorization code in a Department.

• Remove a list of authorization codes from a Department Remove a list of authorization codes from a Department.

• Remove an authorization code from a Department Remove an authorization code from a Department.

• List all authorization codes in the Group List all authorization codes in the Group.

• Get an authorization code in the Group Get an authorization code in the Group.

• Create a list of authorization codes in the Group Create a list of authorization codes in the Group.

• Create an authorization code in the Group Create an authorization code in the Group.

• Remove a list of authorization codes from the Group Remove a list of authorization codes from the Group.

• Remove an authorization code from the Group Remove an authorization code from the Group.

• Group Meet Me Conferencing: Added CRUD APIs to manage conference bridges, greetings, recordings and delegates at group level

• User Meet Me Conferencing conferences: Added APIs to manage conferences at user level

• Retrieve User Call Pickup Group Retrieve the details of the Call Pickup group a user belongs to.

• Group call disposition codes Added APIs to manage call disposition codes at Group Level.

• Call center call disposition codes Added APIs to manage call disposition codes at Call Center Level.

• Call center call disposition codes settings Added APIs to manage call disposition codes settings at Call Center Level.

• Call Center DNIS: added APIs to manage group call center DNIS

• Get call center queue status notification Retrieve the call center queue status notification.

• Modify the call center queue status notification Update the call center queue status notification.

Modified APIs:

• Group Trunk Group APIs: POST, PUT and GET have been updated to support the Call Forwarding Always related parameters

• Call Center APIs: GET available call centers and GET available DNIS have been splitted in separated APIs.

• Update instance: added support for outgoing call DNIS

• Retrieve instance: added support for outgoing call DNIS

• User Calendar Schedules: Added the support of Recurrence.

• Group Calendar Schedules: Added the support of Recurrence.

• Calendar Schedules: Added the support of Recurrence.

• Add Trunks Users to a Trunk Group: Performs now a rollback when the Trunk User creation does not fully succeed (including the commands of the template)

• Assign numbers at Group level: The answer can contains an additional element tenant_status to indicate of the number has been created at Tenant level or if it was already existing.

Fixes in documentation:

• Announcement File Name: The level field was not documented.

• Display group’s list of departments: : More precise description of the O/M/.. status of the different attributes

• Trunk Device Endpoint: The contatcs field was present by copy/pase error, it has been removed.

Release 1.7.0 (previously named 1.6.4)

New APIs:

• Get Group Services: Retrieve the list of authorized Group services with the assignment status.

• Retrieve queue and agent statistics of a call center: Retrieve queue and agent statistics of a call center.

• List service users: Request the list of Service Users of a tenant.

• Retrieve supervised agents list of a call center’s supervisor: added support to read supervised agents for a call center at the level of the User

• Replacement list of supervised agents of a Call Center’s supervisor: added support to modify supervised agents for a call center at the level of the User

• Add a list of supervised agents of a Call Center’s supervisor: added support to add supervised agents for a call center at the level of the User

• Remove a list of supervised agents of a Call Center’s supervisor: added support to remove supervised agents for a call center at the level of the User

• Get a call center queue status: Retrieve a call center queue status

• Group call center agent threshold profile: added APIs to manage group agent threshold profiles

• Get call center agents settings: retrieve the call center agents settings

• Modify the call center agents settings: modify the call center agents settings

• Executive: added support for Executive service

• Executive Assistant: added support for Executive Assistant service

• Retrieve supervised agents list of a call center’s supervisor added support to read supervised agents for a call center at the level of the User

• Replacement list of supervised agents of a Call Center’s supervisor added support to modify supervised agents for a call center at the level of the User

• Add a list of supervised agents of a Call Center’s supervisor added support to add supervised agents for a call center at the level of the User

• Remove a list of supervised agents of a Call Center’s supervisor added support to remove supervised agents for a call center at the level of the User

• Tenant Meet Me Conferencing added support to manage Meet-Me Conferencing at tenant level

• Retrieve the Meet-Me Conferencing allocated ports at group level added support to retrieve Meet-Me Conferencing feature at group level

• Update the Meet-Me Conferencing allocated ports at group level added support to manage Meet-Me Conferencing feature at group level

• Get a call center queue status Retrieve a call center queue status

• Group call center agent threshold profile added APIs to manage group agent threshold profiles

• Retrieve the group call center routing policy and priorities. Retrieve the group call center routing policy and priorities

• Update the group call center routing policy and priorities. Update the group call center routing policy and priorities

• Display Number Activation configuration at system level added support to retrieve system’s Number Activation feature state

• Update Number Activation configuration at system level added support to update system’s Number Activation feature state

• Retrieve the list of activated and deactivated Numbers in a group. added support to retrieve the list of activated and deactivated DNs in a group

• Update the list of activated and deactivated Numbers in a group. added support to update the list of activated and deactivated DNs in a group

Modified APIs:

• Display Tenant’s phone directory list entries and Display user’s phone directory list entries : both API extended with Yahoo ID searching and retrieval

• Create instance and Update instance : Password is now available in the PUT and optional (auto-generated if not present) in the POST.

Release 1.6.3

New APIs:

• Display user’s charge number: Retrieve the settings of the Charge Number service of the user

• Update a user’s charge number: Update the settings of the Charge Number service of the user

• Display push to talk selected users, Update push to talk selected users and Display push to talk available users: added support for Push to Talk service at End User level

Modified APIs:

• Integrated Client Package: new optional parameter not_assigned_raises_404

• Remove Trunks Users from a Trunk Group has been updated for a better result reporting in case of errors.

• Remove numbers at Group level has been updated to also report details of errors in case “auto-delete:false”

• Outgoing Calling Plan Services: new settings parameters to control what categories are exposed and can be updated.

• Outgoing Calling Plan Services: new settings parameters to control what categories are exposed and can be updated.

Release 1.6.2

New APIs:

• In Call Service Activation: added support to In Call Service activation at End User level

• Update list of supervisors of a Call Center: request to modify the supervisor list for a call center.

• Available Supervisor List: get a list of users that can be assigned as supervisors to a Call Center. Searching for users by group only makes sense when the call center is part of an Enterprise.

• Retrieve list of supervisors of a Call Center: get a list of supervisors assigned to a call center.

• Retrieve distinctive ringing configuration of a call center: retrieve distinctive ringing configuration of a call center

• Update distinctive ringing configuration of a call center: update distinctive ringing configuration of a call center

• Retrieve weighted distribution of a call center retrieve weighted distribution of a call center

• Update weighted distribution of an instance: update weighted distribution of an instance

• Group call center unavailable codes: added APIs to manage group call center agents unavailable codes

• Tenant call center unavailable codes: added APIs to manage tenant call center agents unavailable codes

Fixes in documentation:

• Create a single user or a user’s range: doc has been modified to provide same infos as in PUT for the values for the callType and that way to configure a default value at APIO level has been added.

Release 1.6.1

New APIs:

• Calling Plan Digit Strings: added support to add / modify / delete / read incoming calling plan digit strings at group level

• Incoming Calling Plan Services: added support for incoming calling plan at group level

• System Domains: added support for domain management at system level

• Tenant Domains: added support for domain management at tenant level

• Group Domains: added support for domain management at group level

• Create service packs and Delete service packs: added support for POST (add service packs to tenant) and DELETE (delete service packs from tenant) requests.

• User Main Phone APIs have a new config parameter USER_MAIN_DEVICE_NAME_OVERWRITE

• Call Park added support to read and modify basic group call park configuration

• Tenant Applications Data added APIs to manage applications data at the level of the Tenant

• Group Applications Data added APIs to manage applications data at the level of the Group

Modified APIs:

• Incoming Calling Plan Services: now also supports digit pattern permissions at user level

Release 1.6.0 (replacing 1.5.4)

New APIs:

• Routing Policies - Holiday Service and Routing Policies - Night Service: added support for call center premium routing policies - Holiday and Night Services

• Retrieve Music On Hold user configuration and Update Music On Hold user configuration: added support for user music on hold.

• Integrated Client Package: analysis of SP assigned to determine what package to assign.

• Retrieve the impacts on adding Service Packs (among others for the Integrated Clients): analysis of new SP to be assigned from integrated client point of view and to build the list of SP really to be added.

• Retrieve the impacts on deleting Service Packs (among others for the Integrated Clients): analysis of SP to be un-assigned from integrated client point of view and to build the list of SP really to be removed.

• Retrieve the impacts of defining a full new set of Service Packs (among others for the Integrated Clients): analysis of new list of SPs replacing the ones currently assigned from integrated client point of view and to build the list of SP really to be added or removed.

Modified APIs:

• Shared Call Appearance: default values have been added in POST, new urls are exposed inline with usual naming conventions.

• Outgoing Calling Plan Services: updated with new more logic configuration settings (the old ones remain supported but new ones have priority).

• Services Packs: Added the field options

Release 1.5.3

New APIs:

• Virtual Services Packs allow to access to a new configuration object : the Virtual Services Pack.

• User Services allow to access to a new configuration object : the User Service.

• Broadworks External Synchronization adds a new table and access methods to keep track of synchronization data between Broadworks objects and an external directory.

• Call Capacity Management is enhanced with a new API to get list of available users.

• Display APIO SW version allow to retrieve the version of the APIO deployed.

• Services Packs allow to access to the configuration object : Service Pack.

• Create Integrated Clients for a User allow to create integrated clients.

• Delete Integrated Clients of an User allow to delete integrated clients.

• Delete an Integrated Client of a User allow to delete an integrated client.

• Added supported_modes endpoints Display user’s call forwarding always with voice mail supported modes, Display user’s call forwarding busy with voice mail supported modes and Display user’s call forwarding no answer with voice mail supported modes

• Retrieve Number Portability Query allows to retrieve number portability query settings.

• Modify Number Portability Query allows to modify number portability query settings.

• Add Number Portability Query Digit Pattern List allows to add number portability query digit patterns.

• Delete Number Portability Query Digit Pattern List allows to delete number portability query digit patterns.

• Enhanced Call Forwarding Services with Voice Mail Support with supported_modes and 3rd party VM support.

Modified APIs:

• Exposed extra attributes for User Profile in Retrieve an user, Create an user and Update an user.

• Retrieve the Additional Phones of a User updated to also return the “deviceType”.

• List users and Retrieve list of possible agents added the search criteria “sensitiveDepartmentEquals”

• Updated CFx_VM endpoints Display user’s call forwarding always with voice mail, Display user’s call forwarding busy with voice mail, Display user’s call forwarding no answer with voice mail, Update a user’s call forwarding always with voice mail, Update a user’s call forwarding busy with voice mail and Update a user’s call forwarding no answer with voice mail

• Following APIs have been adapted to allow deleting some data in cascade: Delete an user, Delete the Phone of a User and Delete an access device

Release 1.5.2

New Backend:

• LDAP implements a new generic backend to read, create, modify and delete LDAP objects.

New APIs:

• Calendar Schedules and Time Schedules implemented at tenant level.

• Display voice messaging options and Modify voice messaging options allows modification and retrieval of voice messaging at tenant level.

• Retrieve available routing profiles get the list of defined routing profiles at system level.

• Retrieve configuration and Update configuration extend routing profiles to tenant level.

• Retrieve password rules and Update password rules

• Retrieve the Additional Phones of a User, Create an Additional Phone for a User, Retrieve the Additional Phone of a User, Update an Additional Phone of a User and Delete an Additional Phone of a User.

• Retrieve the User’s Phone Extra Lines and Retrieve the details of one User’s Phone Additional Line.

• Display user’s single Alternate Number, Create user’s single Alternate Number, Update a user’s single Alternate Number and Disassign a user’s single Alternate Number

• Custom Ring Back

Modified APIs:

• Phone Type: Generic Attributes the “Password” type has ben added in the type of data managed by the Phone Capabilities.

• Listing available phone types and Listing available access gateway types the APIs have been extended with a new internal parameter to display or not hidden phone types/access gateway types.

• for Create instance, Create a group’s IVR instance and Create instance it has been specified how the service>userid could be generated and the phone number and name have been added to the variables that can used for this id generation.

New template actions:

• tenant_password_rules for Tenant level, based on PUT method of Update password rules.

• tenant_routing_profile for Tenant level, based on the PUT method of Update configuration

Release 1.5.1

New APIs:

• Add public holidays for user’s calendar schedule

• Backends

• Display Tenant’s phone directory list entries

• Display group’s extensions length and Modify group’s extensions length

• List all session admission control group in a Group

• Retrieve a session admission control group in a Group

• Add devices in a session admission control group

• Remove a list of session admission control groups

• Retrieve List of Users connected to an Access Device

Modified APIs:

• Call Center the APIs definition has been updated to use consistent names across the APIs of this service.

• Speed Dial 100 Services the APIs definition has been fixed as the example in the DELETE was not in line with the description and the field prefix was not described in the GET

Fixed APIs description:

• Speed Dial 100 Services the APIs definition has been fixed as the example in the DELETE was not in line with the description and the field prefix was not described in the GET

• Network Classes of Service APIs : a ‘s’ was missing at the end of the end point definition networkclassofservices

• the Access Device Advanced Management and User Main Phone have been clarified with respect to the dynamic definition of the data model

• Create a list of account authorization codes in a Group has been updated to describe the APIO Settings that control the behaviour of the API.

New template actions:

• modify_group_voice_portal for Group level, based on PUT method of Voice Portal. Of course the needed services must have been authorized and assigned before (it can be in the same template as long as these actions are put before this one)

Release 1.5.0 (replacing 1.4.2)

New APIs:

• Priority Alert APIs: Priority Alert

• Retrieve User’s Alternate Id List

• Create a User’s Alternate Id

• Retrieve an User’s Alternate Id

• Update a user’s Alternate User Id

• Delete a user’s Alternate User Id

• Retrieve a list of departments that have a Music On Hold instance

• Add department configuration

• Retrieve department configuration

• Update department configuration

• Delete department configuration

Modified APIs:

• Update available services licenses added auto assign groupServices.

• Display busy lamp field’s available users, Display busy lamp field’s monitored users have been updated to return the department as an object

• Create instance, Update instance have been updated to support the department in the body request

• Retrieve list instances, Available Agent List, Retrieve instance have been updated to return/use the department as an object

• Retrieve instance, Retrieve list instances, Retrieve list of possible agents, Retrieve weighted distribution of an instance, Create instance, Update instance have been updated to return the department as an object

• Retrieve list available users, Retrieve instance have been updated to return the department as an object

• Display user’s phone directory list entries has been updated to return the department as an object

• Retrieve list of IVRs has been updated to return the department as an object

• List group’s trunk groups, Display group’s trunk group have been updated to return the department as an object

• Add group’s trunk group, Update group’s trunk group have been updated to support the department in the body request

• Display user’s hoteling guest available users for assignement has been updated to return the department as an object

• Get users with an account authorization code assigned has been updated to return the department as an object

• Retrieve admin list with details has been updated to return the department as an object

• Listing available numbers has been updated to return the department as an object

• Retrieve admin details, Create an admin and Update admin details have been updated adding emailAddress

• Retrieve tenant admin details, Create a tenant admin and Update tenant admin details have been updated adding emailAddress and have been fixed definitions of Tenant Admin Details, Tenant Admin List Item Details, Admin Detail Attributes and Admin Detail List Item Attributes

• Create an user, Add Trunks Users to a Trunk Group, Update an user, Assign a Phone to a User and Update the Phone of a User have been updated with more advanced line port auto-generation capabilities

• The documentation of all user services with criteria has been fixed to describe the doNotPerformAction parameter

• Call Forwarding Services with Voice Mail Support have been updated the remove the mode from the GET API when the service is inactive to avoid any misinterpretation of the data provided.

• Assign a Phone to a User and Update the Phone of a User have been updated to support the conditional portNumber based on the settings of the PhoneType object.

• Display the Phone of a User has been updated to support request to return the list of the available ports for the user phone.

• Retrieve Access Devices list has been updated to support requests to offer the possibility to return the available ports for a single access device and the list of the available ports of the access devices.

Release 1.4.1

New APIs:

• Display system time zones

• Retrieve weighted distribution of an instance

• Update weighted distribution of an instance

• Retrieve a user’s account configuration

• List feature access codes

Modified APIs:

• List users, List users and List users have been updated to return the department as an object

• Update a user’s account configuration has been updated to return data after the modify operation

• List services licenses available has been updated on include the parameter “noInstance”

Release 1.4.0 (replacing 1.3.3)

New APIs:

• Display system’s licensing

• Display user’s SIP authentication parameters

• Update user’s SIP authentication password and/or username

• Create a list of authorization codes in a Group

• Create an authorization code in a Group

• List all authorization codes in a Group

• Get an authorization code in a Group

• Remove a list of authorization codes from a Group

• Remove an authorization code from a Group

• Remove an authorization code from a Group

• Create a list of account authorization codes in a Group

• Create an account authorization code in a Group

• List all account authorization codes in a Group

• Get an account authorization code in a Group

• Remove a list of account authorization codes from a Group

• Remove an account authorization code from a Group

• Get account authorization codes settings

• Modify account authorization codes settings

• Get users with an account authorization code assigned

• Modify users with an account authorization code assigned

• Display group’s outgoing calling plan properties

• List all virtual users in a Group

• Create a single user or a user’s range

• Display a user in a group

• Modify a user in a group

• Remove a user from a Group

• List all virtual users in an Enterprise

• Display system’s call types

Modified APIs:

• Display group’s external outgoing calling plan redirecting

• Update a group’s external outgoing calling plan redirecting

• Display group’s external outgoing calling plan originating

• Update a group’s external outgoing calling plan originating

• Add numbers: have been extended to report a detailed result report such as the one at Group level done in version 1.3.0

Release 1.3.2

New APIs:

• List Network Classes Of Service in the system

• Get informations of a single network class of service

• List Network Classes Of Service assigned to a Tenant

• List Network Classes Of Service assigned to a Group

• Get configuration

• Get a Network Class Of Service assigned to a Group

• Modify the default Network Class Of Service assigned to a Group

• Assign a list of Network Classes Of Service to a Group

• Remove a Network Class Of Service from a Group

• Remove a list of Network Classes Of Service from a Group

• Get a Network Class Of Service assigned to a Tenant

• Modify the default Network Class Of Service assigned to a Tenant

• Assign a list of Network Classes Of Service to a Tenant

• Remove a Network Class Of Service from a Tenant

• Remove a list of Network Classes Of Service from a Tenant

• Display user’s instant messaging & presence

• Update a user’s instant messaging & presence

• Generate a new user’s instant messaging & presence password

• Get configuration

• Update configuration

• Display group’s instant messaging & presence

• Update a group’s instant messaging & presence

• Display tenant’s instant messaging & presence

• Update a tenant’s instant messaging & presence

• Display system’s instant messaging & presence

• Update system’s instant messaging & presence

• Add a group’s department

• Display group’s list of departments

• Get informations of a single department

• Remove a department

• Modify the default Network Class Of Service assigned to a Group

• Display a list of a department available parents

Release 1.3.0

Modified APIs:

• Remove numbers at Group level and Remove numbers at Group level have been extended to support auto-creation and auto-deletion at Tenant level

• Create Update Delete User’s personal phone list entries with batch and Create Update Delete Group’s common phone list entries with batch have been modified in order to improve the report in case of errors or partial success.

  • Full success is returned with status code 200,

  • Partial success is returned with status code 207,

  • Full error is returned with status code 400.

• Group Trunk Group : fixed some errors in documentation (missing fields)

New APIs:

• List devices

• Registrations

• Retrieve a group device profile file

• Retrieve a list of device files

• List numbers in the system

• List numbers usages in the system

• Get the utilization of a single DN

• Reboot an access device