Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Add_workflow_for_techpubs
AUTH1UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'}
JIRAIDAUTHSYM-27811
REV5UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'}
REV6UserResourceIdentifier{userKey=8a00a0c85b2726c2015b58aa779d0003, userName='null'}
REV3UserResourceIdentifier{userKey=8a00a0c86c120d6f016c429a5bea0025, userName='null'}
REV4UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26c99e02c0, userName='null'}
REV1UserResourceIdentifier{userKey=8a00a0c86a61778d016a7d0876df0017, userName='null'}

The Notification Manager table stores all of the Service Provider (Kandy SB) credentials to support Emergency Call Notification API. When an SBC SWe Lite an 

Spacevars
0product
receives an E911 call, it sends the SMS text message to the mobile numbers configured in the Notification Manager Table.  Through the Notification Manager Table, you configure the items such as the Service Provider, monitoring interval, recipient, and message.

Info

For details on creating and registering a Kandy account, refer to: https://apimarket.att.com/pricing/self-service-apis/messaging.

Prerequisites

Before creating an entry in the Notification Manager Table, ensure the following prerequisites are completed.

Caption
0Table
1Notification Manager Prerequisites


RequirementDefinition
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
    0product
    ).
  • Private Project Key (used as Client ID  in
SBC SWe Lite
  • Spacevars
    0product
    )
  • Private Project Secret (used as Secret in
SBC SWe Lite
  • Spacevars
    0product
    )
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

Spacevars
0product
to detect emergency calls with the following:


Create an Entry in a Notification Manager Table

  1. In the WebUI, click the Settings tab.

  2. In the left navigation pane, Emergency Services > Notification Manager Table.

  3. Click on the desired entry.

  4. Click the Create ( ) icon.

  5. Configure the options. See Field Definitions.


    Caption
    0Figure
    1Create or Modify a Notification Manager Table

    Anchor
    FieldDefinitions
    FieldDefinitions
    Notification Manager Table - Field Definitions

    Caption
    0Table
    1Notification Manager Table - Field Definitions


    Field

    Definition

    Description

    Description for the service provider profile.

    Admin State

    Enables/disables the E911 message. Valid entry: Enabled or Disabled.

    Service Provider

    Name for the service Provider. Default entry:  Kandy. Select Kandy from the drop down box.

    For Release 9.0, Kandy is the supported Service Provider.

    Required field.

    CallerID

    Caller ID added to Kandy Project.

    Required field.

    Client ID

    Client ID used in Kandy. Client ID maps to private project key in Kandy.

    Required field.

    Secret

    Secret used in Kandy. The Secret field maps to private project secret in Kandy.

    Required field.

    Monitoring Interval

    Time interval for the connectivity test in hours. Default entry: 8 hours.

    Events

    Event on which the notification / SMS to be triggered. Default entry: E911.  Select E911 from the drop down list.

    E911 Recipients List

    Contact Number for the recipients receiving the E911 text. The maximum number of entries in the E911 Recipients List is 6.

    E911 Message

    Text message sent in the notification to the recipients receiving the E911 text.



Modify an Entry in the Notification Manager Table

  1. In the left navigation pane, go to Emergency Services > Notification Manager Table.

  2. Select the desired Notification Manager entry.

  3. Click the expand ( ) icon next to the entry you wish to modify.

  4. Edit the entry properties as required. See Field Definitions.

Enable an Entry in the Notification Manager Table

  1. Select the check box next to the entry you wish to enable.

  2. Click the Enable () icon at the top of the table.

Disable an Entry in the Notification Manager Table

  1. Select the check box next to the entry you wish to disable.

  2. Click the Disable icon () at the top of the table.

Delete an Entry in the Notification Manager Table

  1. Select the check box next to the entry you wish to disable.

  2. Click the Delete icon () at the top of the table.

Test a Notification Manager Table Entry

between SBC SWe Lite

between 
Spacevars
0product
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 entry you wish to test.

  3. Click the Test Event Message at the top of the table. The test message is sent.

    Caption
    0Figure
    1Test 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.