Creating an Omni SDK integration

Last Updated : Oct 23, 2024 |

About this task

You can use Omni SDK to integrate Chat and Messaging and WebRTC Voice services on customer applications. You can create a single integration with both services or include only one, depending on your requirements.

You can view the Chat and Messaging and WebRTC Voice integration options if Avaya Support enabled these options for your account. If you cannot view these integration options, you can contact your Avaya account manager to enable these options for your account.

Before you begin

Log in to Application Center Administration as an account administrator.

Procedure

  1. In the navigation tree, click Omni SDK > Integrations.
  2. On the Integrations page, click Create Integration.
  3. In the Name field, type a name for the integration.
  4. Do one of the following:

    • Select the Messaging and WebRTC Voice check boxes to include both services in the integration.

    • Select either the Messaging or the WebRTC Voice check box to include only one of the services.

  5. From the Typing Indicator list, select one of the following options:

    • Disabled: The typing notifications are not displayed.

    • Both Ways: The typing notifications are displayed when the agent or the customer is typing.

    • Customer to Agent: The typing notifications are displayed only to the agent when the customer is typing.

    • Agent to Customer: The typing notifications are displayed only to the customer when the agent is typing.

    By default, Disabled is selected.

    Note:

    If the typing notification status changes while a session (or interaction) is ongoing, the change is not applicable to the active session. The change applies to the next session.

  6. Click Save.

    The integrations list displays the newly created integration and its integration ID. You can use the integration ID for subsequent communication with Avaya Experience Platform™ Public Cloud.

    You can create up to 10 Avaya integrations.

  7. Optional To copy the integration ID, do the following:
    1. From the list of created integrations, click the integration name.
    2. Click the Copy icon.
  8. To configure the routing settings, click the Three Dots icon from the column next to the integration ID and select Configure routing settings.
  9. Optional To delete the integration, click the Three Dots icon from the column next to the integration ID and select Delete.
  10. Optional To edit the integration, click the Three Dots icon from the column next to the integration ID and select Edit.

    You can edit the integration name.

Next Steps

For additional information about downloading and using the SDK, see the Omni SDK section on Developers Portal.

Related information
Routing Configuration Settings page field descriptions