ixHello
ixHello Customer
ixHello Customer
  • About iX Hello
  • General
    • iX Hello: Create Account
    • iX Hello: Basic Mode
      • Webchat Assistant
        • Direct Chat Link
        • Embedded Chat Assistant
      • Digital Assistant
        • Digital Avatar
        • Kiosk Mode
      • Call/SMS Assistant
      • Administrative Purpose
    • iX Hello: Studio Mode
      • Prerequisites
      • Steps
        • App Creation
        • Data Source Configuration
        • AI Content Setup
        • Method Setup
        • Intent Setup
        • Slot Setup
        • Utterance Setup
        • Input Setup
        • Input Parameter Setup
        • Publish Setup
        • Test
        • Enable Call /SMS
    • Enterprise Connections
      • Generative AI
      • Internal Content
      • Microsoft Office 365
    • AI Contents
      • Add AI Content
    • Use cases
      • Contact Finder with Salesforce
        • Pre-requisites
          • An active Salesforce account
          • Lex Developer Account
          • Integrate Salesforce with iX Hello
        • Build Custom App
      • Contact Finder with REST API
        • Prerequisites
          • Integrate API Service with iX Hello
          • Lex Developer Account
        • Build Custom App
  • Apps
    • App Templates
    • NLP Custom App
    • Custom App Series - Step 1 - Building a Custom App
    • Custom App Series - Step 2 - Creating a Connection
    • Custom App Series - Step 3 - Publishing to a Channel
    • Lex Auto Publishing Setup
    • Office 365 SharePoint - Custom App
    • Office365 Exchange - Custom App
    • SalesForce Custom App
    • App Template Export & Import
    • IntentFeature BeforeAfterMethod
    • iX Hello Supported Periods Date Range
    • Shared App
    • ExecuteJS
  • Connections
    • Amazon Web Services
      • Amazon Kendra
      • Amazon Lambda
        • Amazon Lambda: Create Lambda Function
          • Amazon Lambda: iX Hello Integration
      • DynamoDB
    • Login with Amazon Setup
    • SalesForce
      • SalesForce: Create an account
      • SalesForce: Connect to iX Hello
    • Microsoft Office365 Integration Guide
    • Microsoft Office365 AAD
    • MS SQL Server
    • Twilio
  • Blueprints
    • Create App Using App Blueprints
    • Lex Bot using Appointment Blueprint
    • Domain App using Internal Data
    • Domain App S3 Data Source Setup
  • Channels
    • Amazon Alexa
      • Create Amazon Developer Account
      • Registering Alexa User Account
      • Alexa Account Linking to iX Hello
    • Amazon Lex
    • Amazon Lex Integration
    • Amazon Connect and Lex Bot Integration
  • JSON Methods
    • Internal Data JSON Methods
  • Solutions
  • AWS IAM users
  • Finding AWS Region
  • Glossary
Powered by GitBook
On this page
  • What is Twilio?
  • Prerequisites
  • Setup Integration Configuration in iX Hello
  • Create App in iX Hello
  • Create Data Source
  • Create Methods
  • Send Text SMS
  • Send SMS With Media
  • Create Intents
  • SendTextSMSIntent
  • SensSMSWithMediaIntent
  • Create Slots
  • SendTextSMSIntent
  • SensSMSWithMediaIntent
  • Create Utterances
  • Create Input
  • Create Publish Profile

Was this helpful?

  1. Connections

Twilio

Managed Connection: Twilio

PreviousMS SQL ServerNextCreate App Using App Blueprints

Last updated 7 days ago

Was this helpful?

What is Twilio?

Twilio allows us to send and receive text messages globally using applications like iX Hello platform.

The iX Hello platform allows for the rapid integration of Twilio Text message service to various voice channels such as, Alexa, Lex, Google Assistant, and more.

Prerequisites

  • You need to have an active Twilio account

  • Enough balance so you can send messages.

  • Configuration

    • Account SID

    • Auth Token

    • Phone Number

Twilio uses two credentials to determine which project an API request is coming from: The Account SID, which acts as a username, and the Auth Token which acts as a password.

To get the required information, Log into your . If you do not already have a Twilio account, click on Sign Up for free and fill the details as shown below to get a trial account.

You’ll get a confirmation message on your mail, confirm the account and you shall be directed to the Twilio dashboard

Save the following details from the Twilio dashboard:

  1. Account SID

  2. Auth Token

The next step is to get a trial number from Twilio so that we can proceed our tests with Twilio SMS and MMS. By default, the trial account has a trial balance which can be used to get the trial numbers.

Click on Get a Trial Number, you’ll be provided an option, select on Choose this number and you’ll receive the confirmation message as shown below:

To manage the Phone numbers, click on Phone numbers menu in the left navigation and select options to manage active numbers, released numbers, buying a new number, etc.

If you do not have any Active Number, you can purchase one by clicking on “Buy a Number” option available in the same screen in left menu.

Setup Integration Configuration in iX Hello

Keep record of your Account SID, Auth Token, and Twilio phone number. Go to Connect System on Integration Menu. Click on Add New Connection.

Select following:

Integration Category: Custom

Choose Connection: Twilio

Fill in the details from above steps and click on Validate and Save Settings.

Configuration
Info

Account Sid

A unique number that is available on your Twilio account’s Dashboard. This behaves like a username.

Auth Token

A long string that is also available on your Twilio account’s Dashboard. This behaves like a password.

Twilio Number

One of the 10-digit phone number (without +1 and without -) that you have purchased on Twilio and is available at Manage Numbers > Active Numbers section on your Twilio account.

You can now use the integration to build apps in iX Hello that can use Twilio to send SMS and MMS.

Create App in iX Hello

On Manage Apps menu under Custom Apps menu in the left navigation, click on New Custom App.

Fill up following details to create app.

Name: Twilio Demo

Custom App Type: Search

Category: Default

Click on Save.

Create Data Source

Next step is to create a data source that communicates with the integration created in Step 2.

Create Methods

After the data source has been created, we now have to create methods. iX Hello supports

  1. SendTextSMS

  2. SendSMSWithMedia

Send Text SMS

Parameter
Sample Value
Info

ToNumber

{{ToNumber}}

A phone number which is going to receive the message.

Body

{{Message}}

Actual Message Content.

Note: {{}} represents that the value for these parameters are going to be read from the user as input.

Fill the following details:

Parameter
Info

Method Name

SendTextSMS

Request Type

SendTextSMS

This is the method that you are using

Parameters

As explained in table above

Result Type

Record

It indicates that the method can return a single record.

Record JsonPath

Each method returns data in JSON format and to pick any specific information from the JSON, we need to specify the Record JsonPath so the iX Hello platform will pick that data in consideration while displaying results.

Example: $.[*]

This selects all the records that is returned.

Empty Result Template

I'm sorry, there was problem delivering your message to {{Input.ToNumber}}. Please try again, How else can I help you?

Note:

Anything written in between {{ }} is represented as a JSON field and it’s case-sensitive. Input.* refers that you are taking that value from the inputs provided above.

Result Template

Your message has been delivered to {{Input.ToNumber}}. How else can I help you?

You can now test the method. On the actions menu, click on Test, provide the parameter value and

Click on Method Test . You can observe the return from method in Object tab and the result displayed to user in Result Tab.

Send SMS With Media

Parametet
Sample Value
Info

ToNumber

{{ToNumber}}

e.g. 6787014967

A phone number which is going to receive the message.

Body

{{Message}}

e.g. Hello there

Actual Message Content

MediaURL

{{MediaUrl}}

Public URL for the media content.

Fill the following details:

Parameter
Info

Method Name

SendSMSWithMedia

Request Type

SendSMSWithMedia

This is the method that you are using

Parameters

As explained in table above

Result Type

Record

It indicates that the method can return a single record.

Record JsonPath

Each method returns data in JSON format and to pick any specific information from the JSON, we need to specify the Record JsonPath so the iX Hello platform will pick that data in consideration while displaying results.

Example: $.[*]

This selects all the records that is returned.

Empty Result Template

I'm sorry, there was problem delivering your message to {{Input.ToNumber}}. Please try again, how else can I help you?

Note:

Anything written in between {{ }} is represented as a Json field and its case sensitive.

Result Template

Your message has been delivered to {{Input.ToNumber}}. How else can I help you?

You can repeat the same method to test the method. Following screen shows a sample response.

Create Intents

Create Intents corresponding to the methods.

SendTextSMSIntent

Details

Name: SendTextSMSIntent

Intent Type: Search

Intent Action: Execute Method

DataSource : Twilio DS

Data Source Method: SendTextSMS

SensSMSWithMediaIntent

Details

Name: SendSMSWithMediaIntent

Intent Type: Search

Intent Action: Execute Method

DataSource : Twilio DS

Data Source Method: SendSMSWithMediaI

Create Slots

Slots represent the parameters for the intents. You shall create slots of the exact same name as the parameters used in the method. Slots map to the parameters of the method.

SendTextSMSIntent

Details:
  1. Name: ToNumber

Slot Order: 0 or 1

Reprompt message: what’s the phone number

Type: Number

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

  1. Name: Message

Slot Order: 3

Reprompt message: what’s your message

Type: Full Name

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

SensSMSWithMediaIntent

Details:

Name: ToNumber

Slot Order: 0 or 1

Reprompt message: what’s the phone number

Type: Number

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

Name: MediaUrl

Slot Order: 2

Reprompt message: please provide the media url

Type: Text

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

Name: Message

Slot Order: 3

Reprompt message: what’s your message

Type: Full Name

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

Note: If you have slot with same name in different intents of the same app, e,g. Message slot in above example, make sure that their type is also same , other wise you might encounter error in further steps.

Create Utterances

Utterances are the short texts that invoke the intent. You have to define a unique utterance for each method.

  1. SendTextSMS

Details

Value: send text message

Custom App: Twilio Demo

Intent: SendTextSMSIntent

  1. SendSMSWithMedia

Details

Value: send multi media message

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

Create Input

The next step is to create input for the intents. Create Inputs corresponding to every intent. You need to create and manage parameters corresponding to the slots for each intent. For example for SendTextSMSIntent, you had two slots: “ToNumber” and “Message”, hence for SendTextSMSInput , you need to create two parameters: “ToNumber” and “Message”. Let’s look into the process in the following screens:

  1. SendTextSMSInput

Click on Manage parameters on the action menu.

Click on Input Parameters and provide the details as shown below in the resulting pop up: Make sure to map the Input parameter to the same parameter. Also be careful of the data type used. It should be similar/ compatible with the data type of the slot.

Let’s Add another parameter “Message”.

  1. Send SMSWithMediaInput

Repeat the same process for SMSWithMediaIntent. Create Input “SMSWithMediaInput” and create parameters.

Parameter Details:

Details:

  1. Name: ToNumber

Slot Order: 0 or 1

Reprompt message: what’s the phone number

Type: Number

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

  1. Name: MediaUrl

Slot Order: 2

Reprompt message: please provide the media url

Type: Text

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

  1. Name: Message

Slot Order: 3

Reprompt message: what’s your message

Type: Text

Custom App: Twilio Demo

Intent: SendSMSWithMediaIntent

Create Publish Profile

Once you’ve completed all of the above steps, your app is now ready to be publish to iX Hello supported channels. Let’s set up a publish profile.

Details:

External App Name: Twilio Name

App Type: Search

Channel: Lex

Skill Invocation: Twilio messaging

Messaging: all of the messages shall be auto populated. You would want to double check and confirm all of the messages are provided.

Click on Save and you shall see the publish profile in iX Hello portal. Click on the actions menu and then on Publish to Lex.

Select the appropriate LWA account and click on publish.

On the resulting screen, ensure that a success message shows for the publishing steps before clicking “Test Lex”. If success message not shown, click “Go Back to App Publishing” to fix any issue shown in publishing result.

Once clicked on "Test Lex Bot", you will be redirected to App Publishing screen, and the Test Bot will appear at the right corner showing the App name along with the welcome message:

Query the bot with the Utterance " Send Text Message " and then Bot will ask you to provide " To-Number " to whom you would like to send the Text Message, Provide the contact number, for ex: type 9988664455. Bot will ask you to provide Text Message, enter text message and click send. The text message will be sent to the recipient.

e.g[]

https://www.ixhello.com/assets/Ix_ProductLogo_Hello_White.png
Twilio Account