Grandstream Unified Communications

The Grandstream Unified Communications integrated system enables IPFusion to communicate with mobile devices, applications, services, and systems.

Setup

See the Data Servers page for information on configuring driver communication.

Compatibility

The Grandstream Unified Communications integrated system is compatible with a UCM6XXX device using the Asterisk Management Interface (AMI).

Prerequisites

Software Minimum Version
.NET Framework 4.7.2
IPFusion — Grandstream Unified Communications 1.0

When completing your setup, be sure to have the Grandstream Unified Communications documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Dataserver 9689 Yes
Debug Tools 9690 No

Add IP Addresses for Dataservers to the PBX

  1. Log in using the PBX login.
  2. Click +ADD button on the top left of the page.
  3. Enter the desired username, password, privileges.
  4. Add IPs that are allowed to use this AMI user.
  5. In the navigation, go to Other Features → AMI.
  6. Under the Options column, select the edit icon next to the user you will use to log in to PBX.
  7. Under Permitted IPs click Add IP Address and enter in the IP address and subnet mask for each dataserver.
  8. Click Save.
    Warning: This operation will restart the PBX device.

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required.

Address The host name or IP address of the PBX.
Port The port which must be open in your network firewall for the integration to work.
Username The username for logging into the PBX.
Password The password for logging into the PBX.

Assets

System Asset

This asset represents the connection state of the Grandstream Unified Communications system.

Supported States

Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
New Note Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Workflow Trigger Allows users to trigger Workflows to create custom commands.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Call Phone

The Call Phone command is used to initiate a call from one phone to another.

Table 1. Parameters
Source Extension Extension of the phone/device the call will come from.
Destination Extension Extension of the phone/device the call will go to.
Line 1 Text Custom text to include in the first line of the caller ID.
Line 2 Text Custom text to include in the second line of the caller ID
Note: All parameters must be entered for this command to function.
Barge

The Barge command forcefully redirects a destination phone call into another call with a new source phone.

Table 2. Parameters
Source Extension Extension of the phone/device the call will come from.
Destination Extension Extension of the phone/device the call will go to.

System Events

System events are events used to trigger Workflow actions at the system level. For more information about Workflows, see the Workflows section.

Call Status Event

The Call Status event is triggered when a call is accepted or rejected by the user.

Table 3. Properties
Extension Extension of the phone/device that answered or declined the call.
Status Whether the call is accepted or declined.
Note: For the Call Status event, only Accepted events are received for calls. Only Declined events for calls are initiated using IPFusion.

IVR Response Event

The IVR Response event is triggered when a digit has been entered while on a call with the IVR.

Table 4. Properties
Extension Extension of the phone/device that answered or declined the call.
Digit Response The digit entered by the user while connected to the IVR.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.