On this page

ConversationRelay Onboarding Guide

Twilio's ConversationRelay enhances voice interactions by integrating real-time speech recognition and synthesis into your applications. This service is ideal for enterprises looking to create dynamic and responsive conversational experiences.

This guide walks you through the process of integrating your Twilio application with the ConversationRelay service.

Prerequisites

Complete these prerequisite steps before starting the integration process:

Set up your Twilio Account

Ensure you have a Twilio account set up and log into the Twilio Console.

Configure WebSocket Server

Set up a WebSocket server to handle communication with ConversationRelay. Ensure it's' accessible via a wss:// URL.

Integrate Twilio with ConversationRelay

Once you've completed the prerequisites, follow these steps to integrate your Twilio application with ConversationRelay.

Configuration Steps in the Twilio Console

Log in to your Twilio Console.
Navigate to the Voice section, select General under Settings, and enable the Predictive and Generative AI/ML Features Addendum in order to use ConversationRelay.
Navigate to the Voice section and select TwiML Apps under Manage.
Create a new TwiML App or select an existing one.
In the TwiML App settings, configure the Voice URL to point to your application's endpoint (for example, https://yourserver.com/voice) where Twilio can retrieve the TwiML containing the <ConversationRelay> instructions.
Save your changes.

Configure ConversationRelay in your application

(warning)

Warning

Ensure your WebSocket server is properly configured to handle incoming messages from ConversationRelay. If not, you may encounter connection errors.

After configuring your TwiML App, update your application to handle ConversationRelay interactions:

Use the <Connect><ConversationRelay> TwiML noun to route calls to the ConversationRelay service.
Specify the WebSocket URL and any additional attributes needed for your use case.

Example TwiML:

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect action="https://myhttpserver.com/connect_action">
4    <ConversationRelay url="wss://mywebsocketserver.com/websocket" welcomeGreeting="Hi! Ask me anything!" />
5  </Connect>
6</Response>

Develop your application with ConversationRelay

Once you've integrated ConversationRelay, you can enhance your application with advanced voice capabilities. Consider the following features:

Real-Time speech recognition

Leverage ConversationRelay's real-time speech recognition to process caller input and respond dynamically.

Text-to-Speech synthesis

Use ConversationRelay to convert text responses into natural-sounding speech, providing a seamless conversational experience.

Custom parameters

Pass custom parameters to ConversationRelay to tailor interactions based on specific use cases.

Feedback

We value your feedback! Reach out to your Twilio Account Manager or contact our Sales Team with your thoughts on:

Developer experience
Integration ease
Feature configurability
Use case applicability