Skip to main content
Click here if you are having trouble viewing this site
Older versions of Internet Explorer will not support certain site features. Chrome, Safari, Firefox, and Edge will provide the best experience.
Resources
Spok

Integrating Spok Messenger with Spok Go

  1. Last updated
  2. Save as PDF
This article describes how integrate to Spok Messenger with Spok Go. This includes configuring the on-premises gateway and Spok Messenger to communicate with each other and to pass data to the cloud.

Configuring Spok Messenger and Spok Go

Before You Begin

  • Ensure you have Spok Messenger version 5.17 or higher installed.
  • Ensure the locations within your hospital, including the units, rooms, and beds, have been set up within Spok Go. Also, verify the names of the units, rooms, and beds match the names used in the nurse call system. If they do not match, alerts will not be correctly sent to Spok Go. See Locations.
  • Ensure your staff assignments have been configured for the correct room and bed. See Staff Assignment Admin Guide.
  • If your site is using iOS devices, ensure you selected the call protocol/SIP dialer for the call-back functionality. The SIP dialer needs to be configured at the site. See Organization Settings.
  • Ensure the appropriate users that will be setting up and maintaining workflows have the Workflow Administrator or higher security role. 

Overview

You can integrate Spok Messenger with Spok Go to enable alerts, such as nurse call alerts, to be sent through Spok Go. This allows nurses to receive alerts on their Spok Go devices.  The article below describes the steps to integrate an existing Spok Messenger system.

Before you Begin

Before integrating Spok Messenger, do the following:

  • Ensure you have Spok Messenger version 5.17 or higher.
  • Ensure you configured the Spok Go gateway in Spok Messenger.
  • Ensure you have the URL of the load balancer for the on-premises gateway. Spok Messenger needs to communicate with the load balancer.

Step 1: Build and Deploy the Gateway

Ensure the on-premises gateway is installed and configured. For more information see, Installing and Configuring the On-Premises Gateway.

Step 2: Install the Gateway's SSL Certificate on a Messenger System

  1. Log in to Windows on the Messenger system’s host server.
  2. Copy the public key *.CER file that was previously created when generating the PKCS12 (PFX) X509 SSL certificate for your Gateway to the Windows desktop of your Messenger system.
    If your public key is a *.PEM file, simply copy the file to the Windows desktop of your Messenger system, rename the file, and change the *.PEM extension to *.CER.
  3. Double click on the *.CER file and click Install Certificate.
  4. Select Local Machine.
  5. Select Place all certificates in the following store, place the certificate in the Trusted Root Certification Authorities store, and click OK.
  6. Click Finish.
  7. If Messenger needs to receive WCTP read/receipts and multiple choice responses (MCRs) from Spok Go, please follow the steps in Extracting Certificate and Private Key for use in Messenger Web.

Step 3: Create the Spok Messenger Integration

  1. In Spok Go, click Administration > Integrations and click the Connectors tab.
  2. Click +Connector to add the Messenger connector.
  3. Select the Gateway where the integration will be created.
  4. Click Save to save the connector. The connector is automatically enabled.

Next, select whether to create a TAP or WCTP connection and follow the steps for that integration.

Create a WCTP Connection

To create a WCTP connection for Messenger, perform the following steps.

  1. Click the Messenger connector in the list and click the Enabled Services tab.
  2. Enable the WCTP Service by sliding the toggle.
  3. Click +Instance and enter the following info for the connector:
    Client Address

    Enter the Return Address for the Messenger server. This is usually a combination of the Messenger server's name and the domain of the certificate that is installed on the server.

    Example: MessengerServerName.CertName.com

    This Client Address should exactly match the Return Address in Messenger.

    Also ensure that "Return Address" is selected for the Sender ID Format in Messenger.
    Security Code Enter the password of the Paging Vendor.
  4. If you need to edit or delete the WCTP instance, click the vertical ellipses button and select Edit or Delete.
  5. Under Priority mapping from WCTP to Spok Go, select a Spok Go Notification Priority for each WCTP Priority.
  6. After all changes are made, click Save.
  7. For more information on Integrating Messenger with Spok Go Using WCTP, see Integrating Messenger with Spok Go Using WCTP.

For more information on protocol support for WCTP, see Spok Go WCTP Protocol Support.

Create a TAP Connection

To create a TAP connection for Messenger, perform the following steps.

  1. Click the Messenger connector in the list and click the Enabled Services tab.
  2. Enable the TAP connection by sliding the toggle.
  3. Enter the configuration info for the connector.  See Connection Fields below for more information about the fields in the pane and recommended configuration options for this integration.
  4. After all changes are made, click Save.
  5. For more information on Integrating Messenger with Spok Go Using TAP, see Integrating Messenger with Spok Go using TAP Protocol.

Connection Fields

This section provides details about each field on the Nurse Call Connector.

Field Name Description

Name

 (Required) Provide a name for the Nurse Call integration. This name must be unique.

Nurse Profile

(Required) Sets the profile that identifies which nurse call message format is used in messages sent to the port. This setting identifies and extracts nurse call entities from TAP messages.

 

See Nurse Call Profiles for more information.

Callback

Defines how callback strings are composed for nurse call events sent through the port. 

 

See Callback Strings for more information.

Use TLS

Enables TLS 1.2 encryption on the port. Clients will need to authenticate with TLS 1.2 to establish a connection when checked.

Enforce Checksum

(Recommended) Enforces checksum validation on all inbound message packets.

Use Detailed Response Codes

(Recommended) Enables Detailed Response Codes in all responses to clients.

Stay Connected

Sets the connector to remain connected to the client via IP after clients send a TAP protocol layer disconnect sequence. 

 

Typically enabled when placing a Serial to IP converter between the client and the TAP port.
Port

Assigns a port number to the integration. This port number must be between 18101 and 18120.

If this field is left blank, a port number is automatically assigned to the integration after the configuration is submitted.

Location

Assigns a location to the TAP port. 

Typically used when the client system provides partial or ambiguous location information. For example, a nurse call system provides room and bed name, but no facility name.  

Location information provided by a client system will override any location attributes assigned by this TAP connector configuration.

See TAP Port Location Assignments for more information.

 

Disable the Connector

If you need to disable the connector perform the following.

  1. Click the connector in the list.
  2. Click the slider to disable the connector.

Delete the Connector

If you need to delete the connector perform the following.

  1. Click the connector in the list.
  2. Click Delete this connector permanently. This will permanently delete the connector so be sure only to select this if the connector is not needed.

Summary

After you complete the steps above, Spok Messenger is able to send alerts to communicate with the on-premises gateway. Next, ensure your nurse call events are set up and configured within Spok Messenger and Spok Go. For more information on TAP and Nurse Call, see Integrating Nurse Call with Spok Go.