VOSS Automate in a MS Teams environment supports the integration of numbers used by AudioCodes devices into the Number Inventory. Once such devices are configured in VOSS Automate and data is synced, the Number Inventory displays these numbers as Status is Used, with the Vendor field set as AudioCodes. These numbers are therefore then not available to assign to subscribers during number management.

Workflows and data syncs are in place to ensure these numbers in the Number Inventory remain aligned with any changes in these devices.

Administrators with the required permissions to the relation/AudioCodesConnection and data/AudioCodes models can add entries to menu layouts to expose these models and allow for the configuration of the device.

Connection Details

If the relation/AudioCodesConnection model is available from the menu, the Connection Details input form allows for the configuration of the AudioCodes device in VOSS Automate.

Add a descriptive Name for the connection.
Add connection details and credentials:
- Audio Codes Routing Manager: IP address or a hostname
- Username and Password: credentials for the routing manager host
- Authentication Method: select the type of authentication to use with the host
Select AudioCodes Connection sync on Create/Update if an immediate data sync from the device is required.

Data Syncs and Schedules

When the connection details for the device is added, two default Data Sync instances and a Schedule also become available to be modified and enabled as required:

SyncAudioCodes__<connection-name>
PurgeAudioCodes__<connection-name>
ScheduleAudioCodes__<connection-name>

The data sync workflows would then update internal number inventory entries for the Vendor field set as AudioCodes in accordance with updates to changes (add, delete, update) to AudioCodes RegisteredUsers (device/audiocodes/RegisteredUsers).

AudioCodes and Number Cooling

In the case of the removal (or delete) of a AudioCodes RegisteredUsers instance, the internal number is placed into a configurable cooling period, with Status as Cooling.

Important

For AudioCodes internal numbers, the cooling period (days) is configured by means of a named macro called: audiocodes_cooling_duration (default setting is 2 days) and not by the Number Inventory Cooling Duration (Days) value in Global Settings (Global Settings).

A high level administrator with access to the named macro instances can carry out this configuration if needed.

The reason for the alternative cooling setting is that AudioCodes devices can become offline but are not deleted. The default maximum offline duration is here set to 2 days.

In addition, if the device does then come back online within the days set in the macro, the internal number will be set back to:

Status: Used
Usage: Device
Vendor: AudioCodes

When the line is in Cooling, the following internal number inventory fields are set:

Tag: an information message of the number of days when the INI will reach the release date:

Registered user is either offline or deleted,
release date {{ fn.now_in_utc %Y-%m-%d }}
+ {{ macro.audiocodes_cooling_duration }} days

Release Date

See: Number Inventory List View.

When the Release Date has been reached, the INI is put back into the Available pool of INI's, as with standard cooling - see: Number Cooling.

AudioCodes and Audit Number Inventory

When the Audit Number Inventory is run, the Status and Usage of internal number inventory items that have the Vendor field set as AudioCodes are checked and verified to be:

Status: Used
Usage: Device

See:

Audit Process in Microsoft Environments
Run the Directory Number Inventory Audit Tool

This relation implements the workflows to manage Microsoft Operator Connect connection parameters and enabled services.

Model Details: relation/AudioCodesConnection

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title			Description	Details
Name *			AudioCodes Connection defined name, can be an IP address or a host name and can have a max length of 255 charactors	Field Name: name Type: String MaxLength: 255
Description			AudioCodes Connection defined description.	Field Name: description Type: String MaxLength: 255
Audio Codes Routing Manager *			AudioCodes Connection host, can be an IP address or a host name.	Field Name: host Type: String MaxLength: 255
Username *			AudioCodes Connection service account.	Field Name: username Type: String MaxLength: 255
Password *			AudioCodes Connection password of the above service account.	Field Name: password Type: String Is Password: True Store Encrypted: True MaxLength: 255
Authentication Method			Type of authentication to use when interfacing to the external service.	Field Name: auth_method Type: String Choices: ["HTTP Basic Authentication", "OAuth(OApen Authorization)", "Session Based Authentication"]
AudioCodes Connection sync on Create/Update			Sync AudioCodes Connection on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the AudioCodes Connection.	Field Name: syncAudioCodesConnection Type: Boolean
Version *			Version Default: v1.0	Field Name: version Type: String Default: v1.0
	Shadow			Field Name: shadow.[n] Type: Array Cardinality: [0..1]
		Name *		Field Name: shadow.[n].name Type: String MaxLength: 1024

Model: relation/AudioCodesConnection

AudioCodes Device Number Integration

Connection Details

Model Details: relation/AudioCodesConnection