Skip to main content

Need Help Using Spok Knowledge?

Internet Explorer is not supported. Please reload in Chrome, Edge, Firefox, or Safari.
Spok

Spok Messenger Gateways: Cisco

Cisco Gateways are used to send and receive messages from systems using the Cisco protocol.

After a gateway has been added, it can be edited or deleted as needed.

Adding a Cisco Gateway

  1. Choose Interfaces > Cisco. The Cisco Gateways screen displays.
  2. Click New.
  3. Enter information into the fields as described below.

Gateway Name

The name that appears in the gateway list.

Service Name

The name of the Spok messaging service that appears in the service title on the recipient devices.

Service Address

The service address the phones download their messages from when alerted. This is typically the same host name or IP address of the Spok Messenger server.

Service Port

The server port the IP phones should go to for downloading their messages when alerted. This needs to be an available web server port that is different than the standard web server on Spok Messenger.

Enable Gateway

Choose this option to activate the gateway and allow messaging and CUCM integration.

Enable Extension Mobility Messaging

Choose this option to enable messaging through the Cisco Extension Mobility service.

Use CUCM for IP Phone Addresses

Enable the Use CUCM for IP Phone Addresses field when you would like to use the Cisco Unified Call Manager (CUCM) to access the IP address for the Cisco device being used. When the Use CUCM for IP Phone Addresses field is enabled, the fields in the CUCM section of the Cisco Gateways dialog become editable.

 

Disable the Use CUCM for IP Phone Addresses option when using DNS. When this option is disabled, Spok Messenger uses DNS to access the IP address of the device being used instead of using the Cisco Unified Call Manager (CUCM).

CUCM Server Address

The host name or IP address of the Cisco Unified Call Manager.

CUCM Server Port

The port on the Cisco Unified Call Manager that the gateway should connect to for access to the AXL Serviceability API (example: RisPort service).

Use Alert Prompts

Choose to display a standard New Message dialog when an alert is sent to a phone. The user has to click Open to view the message.

Enable Accept Option

Choose to enable the accept function that allows a user to acknowledge the message and stop any escalation paths associated with the message.

Enable Clear Option

Choose to enable the clear function that allows a user to clear any events associated with the message.

Enable Allow Callback to Accept

Choose to enable the allow callback to accept option when a callback button press should send an accept response to the server.

CUCM Auth User

The username that should be used to authenticate with the CUCM’s AXL Serviceability API (example: RisPort service).

CUCM Auth Password

The password that should be used to authenticate with the CUCM’s AXL Serviceability API (example: RisPort service).

Alert Policy

Determines what policy the IP phones are going to use to alert the user. These settings are based on the available options in the Cisco XSI service.

CUCM Version

The version of the CUCM that is used for the integration. This affects how the gateway connects to the CUCM and what features are available.

Alert Retries

The number of times an alert notification is sent to a phone until the user reads or responds to the message.

RisPort Updates (mins)

How often the device requests real time updates for recipient devices. This field can be set to zero for optimized integration to the CUCM’s RisPort service.

Alert Timeout (secs)

The number of seconds between alert notifications.

IP Phone Auth User

The username that should be used to authenticate with IP phones.       

Message Timeout (secs)

The number of seconds until the messages expires and no longer accepts responses.

IP Phone Auth Password

The password that should be used to authenticate with IP phones.

Authentication ID

The application ID that should be used to authenticate with the extension mobility service on the CUCM. If this field is left blank, the entry in the Auth User field is used.

Authentication Password

The password that should be used to authenticate with the extension mobility service on the CUCM. If this field is left blank, the password entry in the Auth Password field is used.

Service URI

The URI that should be used to connect to the extension mobility service on the CUCM.

Service Port

The service port that should be used to connect to the extension mobility service on the CUCM.

Configure Alert Profile

Opens the alert dialog used to configure alert tones and vibrate functionality for each alert profile.

  1. Click Save. The new gateway is saved.

 

Configuring Alert Profiles

Assigns specific ring tones and vibration settings to a corresponding alert profile.

  1. Click the Configure Alert Profile button.  The Cisco Alert Profile dialog displays.

  1. Enter information into the fields as described below:

Ring Tone

Determines the tone played when the handset receives an alert. This ring tone file must be present in the Cisco CUCM.  Leave blank to send no alert tone.

Vibrate

When selected, this enables vibration when an alert is received and the vibration settings become available. To enable vibration with a ring tone, choose this option when a ring tone is entered.  To use vibration only, choose the Vibrate field and leave the Ring Tone field blank.

Vibration Duration(s)

The desired time in seconds that the handset vibrates between pauses. 

Silence Duration(s)

The time in seconds that the handset pauses between vibrations.

Number of Vibration(s)

The total number of vibrations the handset produces after receiving an alert.

  1. Click Save, the Alert Profile settings are saved.
  2. Click Save in the Cisco Gateways dialog.  The Cisco gateway is saved.

 

Editing a Cisco Gateway

Existing Cisco Gateways can be edited.

  1. Choose Interfaces > Cisco. The Cisco Gateways dialog displays.
  2. Select the gateway to be edited from the list on the left.
  3. Change the desired information.
  4. Click Save. The changes to the gateway are saved.

Deleting a Cisco Gateway

An existing Cisco Gateway can be deleted.

  1. Choose Interfaces > Cisco. The Cisco Gateways dialog displays.
  2. Select the gateway to be deleted from the list.
  3. Click Delete or press the delete key on the keyboard. The gateway is deleted.