Page History

Add_workflow_for_techpubs

AUTH1 UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'} JIRAIDAUTH SYM-27811 REV5 UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'} REV6 UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'} REV3 UserResourceIdentifier{userKey=8a00a0c86c120d6f016c429a5bea0025, userName='null'} REV4 UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26c99e02c0, userName='null'} REV1 UserResourceIdentifier{userKey=8a00a0c86a61778d016a7d0876df0017, userName='null'}

Overview - How does Emergency Call Notification API Work?

United States law requires multi-line telephone systems (MLTS) systems to provide direct dial access to 911 to report emergencies. It prohibits having to dial a prefix to reach an outside line. In addition, when a 911 call is placed on an MLTS system, the system must be configured to notify a central location on-site or off-site where someone is likely to see or hear the notification. Examples of notification can include on-screen messages using a soft client phone application, text messages for smartphones, and email for administrators.

Ribbon’s Emergency Call Notification API provides a notification framework within the Ribbon SBC

Spacevars
0 product

to recognize that an outbound 911 has been placed and to actuate an SMS notification sequence (send a text messages) to the configured directory numbers/recipients via a supported SMS Service Provider. For Release 9.0, the only provider supported is Kandy.

Step 1: Review Prerequisites

The following are required to provide SMS messaging:

Caption
0 Table 1 Notification Manager Prerequisites
Requirement Definition Registered Account/Subscription to Kandy KBS Registered account/subscription in Kandy KBS including: Sending SMS functionality One (minimum) registered number (used as Caller ID in SBC SWe Lite Spacevars 0 product ) Private Project Key (used as Client ID  in SBC SWe Lite Spacevars 0 product ) Private Project Secret (used as Secret in SBC SWe Lite Spacevars 0 product ) DNS The DNS configured on the node must be able resolve the Kandy public URLS. Refer to Configuring Host Information and DNS. DNS should be able to resolve oauth-cpaas.att.com. Emergency Call Detection You must configure the SBC SWe the  Spacevars 0 product to detect emergency calls with the following: Transformation Table to support E911 calls. Call Route for E911 calls (i.e., Emergency Calls) that includes Number/Name Transformation Table (E911 specifications) above. For details, refer to Creating and Modifying Entries to Call Routing Tables. Creating and Modifying Entries to Transformation Tables.

Step 2: Install

SBC SWe Lite

Spacevars
0 product

These instructions assume the SBC SWe Lite

Spacevars
0 product

is installed and running. If the product is not installed, refer to the links below.

Caption
0 Table 1 Installation Requirements
Product Installation SBC SWe Lite On KVM: Installing SBC SWe Lite on KVM Hypervisor On VMware ESXi: Installing SBC SWe Lite on VMware ESXi On Hyper-V: Installing SBC SWe Lite on Microsoft Hyper-V On Azure: Deploying an SBC SWe Lite with Quick Launch for Azure On AWS: Deploying an SBC SWe Lite via Amazon Web Services - AWS SBC 1000 Prepare for Installation Installing the SBC 1000 Hardware SBC 2000 Prepare for Installation Installing the SBC 2000 Hardware

Step 3: Create account with Kandy Business Services (KBS)

Spacevars
0 product

SBC SWe Lite uses Kandy Business Services (KBS) as the Service Provider for the SMS Notification feature. You must have an account subscription with KBS in order to send SMS notifications to end users.

1. Ensure you have a valid subscription to KBS; this service is required to send text 911 notifications to the end user. Refer to: https://apimarket.att.com/pricing/self-service-apis/messaging.
2. Create a project within Kandy that contains the following:
   1. Private Project Key (used as Client ID  in SBC SWe Lite

      Spacevars
      0 product

      )
   2. Private Project Secret (used as Secret in SBC SWe Lite

      Spacevars
      0 product

      )
   3. Caller ID
3. Register one number (Caller ID).

Step 4: Configure SMS Notification in

SBC SWe Lite

Spacevars
0 product

You must configure E911 service

1. In the WebUI, click the Settings tab.
2. In the left navigation page, accessEmergency Services > Notification Manager.
   

3. Click the Create  () icon.

   Caption
   0 Figure 1 Configuration SMS Notification Service

   
   

   Note
   title Configuration Notes
   The maximum number of entries in the E911 Recipients List is 6. There is no limit on the number of Notification Manager profiles, but there can only be one active profile. To disable the notification table, select Disable from Admin State.

   
   

4. Configure the options. For field definitions, refer to Creating and Modifying entries in Notification Manager.  Return to this page after configuration.
5. Click Apply.

Step 5: Configure E911 Emergency Call Route in

SBC SWe Lite 

Spacevars
0 product

1. In the WebUI, click the Settings tab.
2. Access Settings > Transformation.
3. Create a call Transformation Table to support E911 calls. Refer to Creating and Modifying Entries to Transformation Tables.
4. Access Settings > Call Routing Table.
5. Create a Call Route for E911 calls (i.e., Emergency Calls). For details, refer to Creating and Modifying Entries to Call Routing Tables.
6. Select the Number/Name Transformation Table that includes E911 specifications (created above).

Step 6: Test SMS

between SBC SWe Lite

between 

Spacevars
0 product

and Service Provider (KBS)

The Test Event Message option enables you to send a test SMS to the configured directory number/recipients.

Test an SMS notification as follows:

1. In the left navigation pane, go to Emergency Services > Notification Manager Table.
2. Select the check box next to the profile you wish to test.

3. Click the Test Event Message at the top of the table. The test message is sent.
   
   The following possible messages are displayed in the form of alerts on the WebUI: 

   
   

   Caption
   0 Figure 1 Test Message Alerts
   Message Details Authentication Failure The system failed to connect with the Kandy server (this might be due to invalid Client ID/Secret or the subscription has expired. Message Could Not be Delivered to all Recipients Authentication was successful but delivery to all configured recipients failed. Message Delivered to all Recipients Authentication succeeded and message sent successfully to all recipients.

   
   

Step 7: Send SMS when E911 is Dialed

Send an SMS as follows:

1. Access PBX (or device connected to the Service Provider).
2. Dial 911 to sent the notification message to configured recipients.

3. Access the Alarms Manager to verify the notification has been sent to the Service Provider. The outgoing message will include details of the caller, such as calling number, extension, Caller IP address. 

   Code Block
   title Outgoing Message
   AT&T API Marketplace Free Account - Emergency Number dialled calling number:sipp; Calling Extension:;callingIPAddress:10.54.81.86 AttemptTime:05-26-2020 12:50:49.245715