Skip to main content

AI Connector User Guide

Selçuk Gönen avatar
Written by Selçuk Gönen
Updated over a week ago

Alotech SIP AI Connector User Manual

1. Introduction/Overview

This document explains how to add the AI Connector step to your Interactive Voice Response (IVR) flows in the Alotech system, and how to create the connection profiles required for this step to work. This feature allows you to route incoming calls to external artificial intelligence (AI)-based voice response systems (e.g., Voicebots), enabling you to offer your customers a more dynamic and intelligent voice greeting experience.

This feature is designed for Alotech system administrators and users who have the authority to edit IVR flows.

2. Prerequisites

  • To configure and use this feature, you must have the System Administrator role or access permissions to the relevant menus in your Alotech account.

  • To use the AI Connector step in an IVR flow, an AI Connector Profile must first be created.

  • You must have the technical connection information for the external artificial intelligence service you will connect to, such as its SIP URI address.

3. Step-by-Step Instructions

Using the feature consists of two main stages: creating the AI Connector profile and adding this profile to an IVR flow.

Part A: Creating the AI Connector Profile

First, you need to create a profile that contains the connection settings for the artificial intelligence service you will use in the IVR.

  1. From the Alotech main menu, navigate to System Administrator > AI Navigator > AI Connector.

  2. Click the Add or New Profile button to create a new profile.

  3. In the profile configuration screen that opens, fill in the following fields:

    • Profile Name: Give your profile a name for easy identification (e.g., "Customer Greeting Voicebot"). This field is mandatory.

    • Flow Mode: Select the SIP AI Connector option from the dropdown menu. When you make this selection, only the fields required for this flow type will remain on the screen. This field is mandatory.

    • Connection Protocol: Choose the protocol to communicate with your external AI service. The options are tcp, udp, or tls. This field is mandatory.

    • URI: Enter the SIP URI address of the artificial intelligence application to connect to (Example: sip:+11111111111@sip.rtc.acme.com:5060). This field is mandatory.

    • Caller ID: Select the caller ID to be displayed when calling the external AI service from the numbers defined in your platform. This field is mandatory.

  4. Set the profile status to Active.

  5. Click the Save button to create the profile.

Part B: Adding the AI Connector Step to the IVR Flow

After creating the AI Connector profile, you can add it to any desired IVR flow.

  1. Go to the menu where you want to edit your IVR flow.

  2. Add a new step in the flow and select AI Connector from the Step Type field.

  3. In the step configuration screen that opens, fill in the following fields:

    • Description: Enter a short text describing the step (e.g., "AI Greeting Step").

    • AI Connector selection: From this dropdown menu, select the relevant AI Connector Profile you created in Part A. The call will be routed according to the settings of the profile you select in this step.

    • Sip Header: You can use this section if you want to send custom SIP header information to the external AI service. You can add a maximum of 3 key-value pairs. To add a new header, click the Add button and fill in the relevant fields.

    • Ringing Music for Caller: Select the on-hold music that the caller will hear until the AI service answers the call.

    • Announcement for Caller: Select an announcement file to be played to the caller.

    • Waiting Duration: Enter the maximum time in seconds to wait for the call to be answered.

  4. Configure the Next Step for the continuation of the flow and the Next step on callee hangup for the step to take if the caller hangs up.

  5. Apply the changes by clicking the Save button for the IVR step and then for the entire IVR flow.

4. Tips and Best Practices

  • Descriptive Naming: If you work with multiple AI services, giving your AI Connector profiles descriptive names (Profile Name) that are easily distinguishable will make it easier to select the correct profile when configuring IVR steps.

  • Using SIP Headers: SIP headers are used to send additional information (metadata) about the call to the AI service. For example, you can transmit information such as the caller's customer ID or the IVR menu they reached through this field.

  • Test Flow: After adding a new AI Connector step or updating an existing one, always make a test call to verify that the flow and the external AI service connection are working correctly before deploying the system to a live environment.

Did this answer your question?