Twilio AI Assistant (AIA) Adapters is an open-source quick-start sample middleware for integrating Twilio AI Assistant with various communication channels. It provides a flexible and extensible way to connect AI-powered conversational experiences to Twilio Voice, SMS, WhatsApp, and Flex Webchat 3.0.

• Quick-Start: Simplifies AI Assistant deployment with sample ready-to-go configurations
• Performant: Optimizes the number of required API calls to ensure low overhead latency
• Multi-Channel Support: Integrates AI Assistant with Twilio Voice and Conversations (SMS, WhatsApp, and Flex Webchat 3.x)
• Extensible Middleware: Easily customize and extend adapter functionality.
• Enhanced Twilio Flex Handover: Ensures that all attributes from Tools input are passed as task attributes within Twilio Flex

Supported languages with preset configurations:

• default
• en-US
• en-AU
• es-ES
• hi-IN
• ja-JP
• ko-KR
• pt-BR
• th-TH
• vi-VN
• zh-CN
• zh-HK

To use a different language, specify the supported language within the language parameter.

Example: https://twilio-aia-adapters-XXXX-dev.twil.io/voice/incoming?aiAssistantSid=aia_xxxxx&language=zh-CN

Language configurations can be easily added or modified by updating the assets/voice-languages-config.private.json file.

All attributes provided in the Twilio AI Assistant's Tool - Input Schema will be transferred as task attributes in Twilio Flex.

Redirect voice call from AI Assistant to a user-input phone number

A lightweight Twilio Flex Plugin that showcases the Twilio AI Assistant's summary and sentiment, utilizing the task attributes conversationSummary and conversationSentiment passed from the AI Assistant's Tool execution during the Twilio Flex handover.

1. Twilio Flex Account (Guide)
2. Twilio AI Assistant configured (Guide)
3. Node.js v18.x.x only (Guide)
4. Twilio CLI v5.22.9 or above (Guide)
5. Twilio CLI Serverless Toolkit v3.2.0 or above (Guide)
6. Twilio CLI Flex Plugin v7.1.0 or above (Guide)

# Clone project
git clone https://github.com/leroychan/twilio-aia-adapters.git

# Change to working directory
cd twili-aia-adapters/serverless-functions

# Install NPM packages
npm install

# Build project as the source code is built using TypeScript
npm run build

# Verify Twilio account is selected correctly on Twilio CLI
twilio profiles:list

# Deploy to Twilio account
twilio serverless:deploy

# Take note of the webhook URL that is dislayed within the CLI

1. Navigate to Twilio Console > Phone Numbers > Manage > Active Numbers
2. Select your DESIRED VOICE-CAPABLE NUMBER
3. Go to Configure > Voice Configuration > A Call Comes In
4. Set the webhook URL to: https://twilio-aia-adapters-XXXX-dev.twil.io/voice/incoming?aiAssistantSid=aia_xxxxx with HTTP POST
5. Click Save configuration

1. Navigate to Twilio Console > Conversations > Addresses > Configure addresses
2. Under your DESIRED MESSAGING CHANNEL, click on the Pencil Icon
3. Under Step 1: Autocreate Conversations for new messages?, Enable Autocreate a conversation
4. Under Step 2: Which Conversations Service should the Conversation be created in?, select Flex Chat Service
5. Under Step 3: Want to set up an integration?, select Webhook

• Webhook URL for incoming messages: https://twilio-aia-adapters-XXXX-dev.twil.io/conversations/messageAdded?aiAssistantSid=aia_xxxxx
• Webhook method: POST
• Webhook Filters: onMessageAdded only

6. Click Update

1. Ensure you have Twilio Flex Webchat 3.x configured (Guide)

2. Navigate to Twilio Console > Flex > Manage > Messaging

3. Under Filter by Address type, select Chat

4. Under your DESIRED FLEX WEBCHAT ADDRESS, click on the Pencil Icon

5. Under Flex Integration

   • Integration Type: Webhook
   • Webhook URL: https://twilio-aia-adapters-XXXX-dev.twil.io/conversations/messageAdded?aiAssistantSid=aia_xxxxx

6. Click Update Address

1. Navigate to Twilio Console > TaskRouter > Workspaces to obtain both workspaceSid (i.e. WSxxxxx) and workflowSid (WWxxxx). workflowSid can be retrieved after clicking into the default workspace named Flex Task Assignment and then Workflows.
2. Once done, navigate to Twilio Console > AI Assistant > My Assistants
3. Select your DESIRED AI ASSISTANT
4. Go to **Tools* and click **Add Tool* button
   • Name: Twilio Flex Handover
   • Description: When the user requests to talk to a live agent or an actual human. This is meant to transfer call to a contact center
   • Select HTTP Method: POST
   • Webhook URL: https://twilio-aia-adapters-XXXX-dev.twil.io/tools/flex-handover?workfspaceSid=WSxxxxx&workflowSid=WWxxxxxx
   • Input Schema:

     export type Data = {
       conversationSummary: string,
       conversationSentiment: "positive" | "neutral" | "negative",
     };

   • Authorization Provider: None
5. Click Save Changes button

# Change to working directory
cd ..
cd plugin-aia-summary

# Install Dependencies
npm install

# Optional - Modify Environment Variables. You can also pass it via query parameters.
cp .env.example .env

# Optional - Local Development
twilio flex:plugins:start

# Verify Twilio account is selected correctly on Twilio CLI
twilio profiles:list

# Deploy to Twilio Flex Instance
twilio flex:plugins:deploy --changelog "Deploy AI Assistant Summary Plugin"

twilio flex:plugins:release --plugin plugin-aia-summary@0.0.1 --name "Deploy AIA Plugin" --description "Displays AI Assistant's Conversation Summary and Conversation Sentiment"