Configuring SMS Gateway

Last Updated : May 15, 2025 |

About this task

This gateway ties accounts to a snap-in. The snap-in also uses this gateway when querying for account details.

Procedure

  1. Start Omnichannel Administration Utility.
  2. In the navigation pane, click SMS/Social.
  3. Click SMS Configuration.
  4. Click Create.
  5. On the Account tab, perform the following steps:
    1. In the Create Snapin section, in the Name field, enter the same name that you configured for SMS in the Messaging Snapin Key attribute of MessagingService or Snap-in Key attribute of the OceanaConfiguration service.
    2. Click Create.
    3. In the Snapin field, select the snap-in that you created.
    4. Enter appropriate values in the remaining fields.

      The following table provides a description of each field:

      Field

      Description

      Name

      An account name - Sent back to third-party snap-in when they request their gateways.

      API ID

      An API ID - Sent back to third-party snap-in when they request their gateways.

      API URL

      An API URL - Sent back to third-party snap-in when they request their gateways.

      API Password

      An API Password - Sent back to third-party snap-in when they request their gateways.

      Extra1

      An extra field - Sent back to third-party snap-in when they request their gateways.

      Extra2

      An extra field - Sent back to third-party snap-in when they request their gateways.

      Snapin

      The name of the third-party snap-in you want to link it to. Enter the name created in earlier steps.

  6. Click Save.
  7. Select the Details tab.
  8. Create an entry for the gateway that you just added.
  9. Enter appropriate values in the remaining fields.

    The following table provides a description of each field:

    Field

    Description

    Phone Number

    A unique telephone number - Sent back to third-party snap-in when they request their gateways. The phone number is used later when sending a SMS through the sample vendor application.

    Tag

    A TAG to send messages with - Currently not used - One Off SMS Scenario.

    Workflow

    An Engagement Designer workflow - If none is supplied, the default flow is used. Used for routing SMS chats. Keep this field blank.

    To meet your specific requirements, you can configure a specific Engagement Designer workflow through the Event Catalog tab in the Engagement Designer Admin Console, and specify the name of the workflow in this field.

    If you configure a specific workflow by defining the workflow type and creating suitable Engagement Designer rules, you must also create a default rule to handle all cases that do not meet the criteria.

    Description

    A description of what to use the number for - Currently not used - One Off SMS Scenario.

    Extra1

    An extra field - Sent back to third-party snap-in when they request their gateways.

    Gateway Account

    The gateway account to link the telephone to.

    Routepoint

    Select a Route Point that you configured using Avaya Control Manager. Route Points are used to route SMS chats.

    Important:

    You must select a Route Point when configuring the SMS Gateway.

    Priority

    The priority from 1 to 100.

    Attributes

    Routing attributes of the telephone number. Used for routing SMS chats.

  10. Review your configuration details.
  11. In the Edit Attributes section, select the attributes which you want the incoming SMS messages to be routed.

    For example, select Language.English.

  12. Click Save.