Configuring a third-party push notification provider on Avaya Aura Session Manager

Last Updated : Oct 19, 2021 |

About this task

To use push notifications on third-party applications, you require a third-party push notification provider. An Avaya Breeze Client SDK application developer can implement a third-party push notification provider. Use this procedure to set up or update a third-party push notification provider on Avaya Aura® Session Manager

Before you begin

  • A third-party Avaya Breeze Client SDK application developer must implement the third-party push notification provider. For more information about push notification provider requirements, see Third-party push notification provider requirements.

  • Ensure that all core Session Manager instances are on software release 8.1.3 or later.

Procedure

  1. On the System Manager web console, click Elements > Session Manager > Network Configuration > Push Notification > Notification Provider.
  2. Do one of the following:
    • To add a new provider configuration, click New.

    • To edit an existing provider, click the check box corresponding to the required provider, and click Edit.

  3. In the Provider Name field, enter a name for the provider.

    For example: MyPushNotificationProvider.

    This name is used in the Session Manager administration portal for display only.

  4. In the Description field, provide a short description of the notification provider.
  5. In the Provider Address field, enter the FQDN where your push notification provider is deployed.

    For example: mypushnotifications.mycompany.com

  6. In the Provider Port field, enter the port number of the push notification provider.

    The default port is 443.

  7. In Company Domain, enter the domain where your Session Manager is deployed.
  8. Optional Select the Use Forward Proxy option to use the forward proxy configuration for push notifications.
  9. Click Generate Keys.

    The Session Manager generates a public and private key pair and an identifier. This data is required to authorize Avaya Aura® Session Manager on the push notification provider. The Session Manager also updates the following values:

    • System Id: A unique identifier for your system.

    • Public Key: A public key.

    • Key to Export: Authorization key in JSON format.

    Important:
    • Do not close the Provider Settings page on the System Manager administration portal when you export authorization data to your push notification provider.

    • Do not save the data you provision on the Provider Settings page of the System Manager administration portal until you export authorization data to your push notification portal. Otherwise, the push notification service might not work as expected.

  10. Copy the system ID and public key data and provide it to your push notification provider.
    For example:
    "systemId": "9bf8f4ab-99b1-452b-9b7f-e75aacf31d19.mycompany.com"
    "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE9rtz4fuYhGm2JlvnI6lZmate8eEX\na4wvmklSdHGYZHos7y8xNBNCEj9wc3klayOKHYIVIeL0ryVFgM16Ud5FDQ==\n-----END PUBLIC KEY-----"
    The steps you must perform to provide authorization data are provider-specific. For more information, contact your third-party push notification provider vendor.
  11. Return to the Provider Settings page on the System Manager administration portal.
  12. Select the Session Manager from the Select Session Manager to Verify Settings list, to test the notification provider connection.
  13. Click Verify Settings to verify that Session Manager can connect and authenticate with the push notification provider.
  14. To save the settings, do one of the following:
    • If the verification is successful, click Commit.

    • If the verification fails, fix the issue as described in Session Manager cannot connect to a push notification provider section of Troubleshooting Avaya Aura® Session Manager and re-run the connectivity test.

      If the problem persists, contact Avaya support personnel.