PingID Administration Guide

Configuring a Syniverse account for PingID SDK

About this task

By default, PingID SDK uses Twilio for voice and SMS. By enabling your own Syniverse account, you are taking responsibility for despatching SMS and voice messages.

Ensure that you have available your Syniverse account Access Token. You can copy it as required from the Syniverse dashboard. You should also have set up one or more origination phone numbers. The following procedure will guide you in configuring PingID SDK to use your Syniverse account.

To configure PingID SDK for a Syniverse account:

Steps

  1. Log in to the admin console.

  2. Go to Setup → PingID SDK.

  3. Under SMS/Voice Sender, choose Custom.

    The custom configuration settings appear.

    gzf1598337206054

  4. In the SMS/Voice Sender dropdown, select Syniverse.

    A custom Syniverse account applies across all PingID SDK applications of the organization.

  5. To configure your Syniverse account to work with PingID SDK:

    1. Copy the URL from the Address field.

    2. In your Syniverse account:

      1. In the Delivery Configuration, paste the URL that you copied from the PingID SDK Address field.

      2. Create 2 subscriptions: SCG-Message and SCG-Voice-Calls.

        See the Syniverse article How to setup a Webhook for Receiving Messages and Notifications for more information.

        These Syniverse configurations are required in order that Ping Identity’s dashboards and reports will reflect complete and accurate data. Ping Identity will not be able to troubleshoot SMS or voice events related to Syniverse if these configurations are incomplete.

  6. Copy/paste your Syniverse Access Token to the indicated field.

    The system uses your access token to connect to your Syniverse account.

    Recommended: In your account in the Syniverse portal, define an application that is dedicated to PingID SDK traffic. Use this application for analyzing PingID SDK traffic throughput, and troubleshooting SMS or Voice message despatch cases.

  7. Click the Verify Account button. That validates the account to PingID SDK and populates the Origination Numbers list from your Syniverse account.

    • If the Access Token is incorrect, you will be shown this error message: ofh1597820713553

    • If your Syniverse account is not fully configured a yellow exclamation mark appears next to the Access Token field. If you click on it, this message appears: eul1597825300926

    • If there are no originating phone numbers in the Syniverse account, it will not be validated to PingID SDK.

    If the account was successfully verified, the display will change to show a list of originating numbers from Syniverse:

    itu1597828167369

  8. Select at least one originating telephone number to use.

    • Syniverse allows you to define phone numbers for use with either voice or SMS.

    • Syniverse allows the use of sender IDs (in place of telephone numbers) for commercial use or to comply with regulations requiring SMSs to be sent as transactional and not promotional. When using the Ping Identity account, all originating numbers are defined as transactional with a senderID in Syniverse. To achieve the same functionality in a custom Syniverse account, you must configure it directly in Syniverse.

    • Sender IDs are displayed according to the Sender IDs sent in the API requests.

    • Short codes are supported only for the United States, and only for SMS messages. If only short codes are chosen, but the number is not a US number:

      • If the admin configures FALLBACK SMS/VOICE SENDER as Ping Identity or Twilio, the selected fallback account’s phone numbers are used.

      • If the admin Disables the FALLBACK SMS/VOICE SENDER option, the SMS will not be sent.

  9. Enable FALLBACK SMS/VOICE SENDER as Ping Identity or Twilio to fall back to one of these alternatives if Syniverse becomes unavailable for reasons explained in the following Note.

    Under fallback:

    If PingID SDK receives an error during the message despatch process that the used number is invalid, it will retry using another configured Syniverse number. After attempting to despatch the message and receiving an error for all configured numbers, the fallback flow is triggered.

    • If there was no way originating the SMS or voice event with the tenant’s own Syniverse account and admin defined a fallback, the event will be originated from the configured fallback account

    • The following errors will cause fallback:

      • All API errors (but not SMS delivery errors)

      • No origination number was found on the Syniverse account

    • If a transaction was charged to a specific account (Ping or custom), it does not imply that subsequent transactions will be charged to the same account. The account charged for each transaction is determined on an individual basis. Preference is always given to the custom account.

    • If you configured FALLBACK SMS/VOICE SENDER as Ping Identity, you will be billed at Ping Identity’s rates and not at any preferential rates you have directly from Syniverse. In addition, Ping Identity originating numbers and setup parameters will be in force.

    • Ping Identity:

      Use Ping Identity’s SMS/Voice sender account in cases of fallback.

    • Twilio:

      mzs1598337933242

    Enter the Twilio Account SID, Auth Token and select at least one Origination Number:

    1. Copy/paste the Twilio account SID to the indicated field.

      If the SID is shorter than 34 characters, you will be shown this error message:dbq1564020510020

    2. Copy/paste the Twilio Auth Token to the indicated field.

    3. Click the Verify Account button. That validates the account to PingID SDK and populates the Origination Numbers list from your Twilio account.

      • If the AUTH TOKEN is incorrect, you will be shown this error message:zig1564020510564

      • If there are no originating phone numbers in the Twilio account, it will not be validated to PingID SDK.

      If the account was successfully verified, the display will change to show a list of originating numbers from Twilio:

      duo1598338758424

    4. Select at least one originating telephone number to use.

  10. To save your settings, click Save at the bottom of the Setup window.

  11. To complete the setup process, enter your legal consent:

    cei1597831478688

    You will only be asked for legal consent when entering a new Access Token.