ConversationRelay Onboarding Guide

Complete these prerequisite steps before starting the integration process:

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

Set up a WebSocket server to handle communication with ConversationRelay.

You can set up a WebSocket server using various frameworks and programming languages, such as Node.js with Fastify, Python with FastAPI, or others that support WebSocket protocols.

Note: Ensure your WebSocket server is accessible via a wss:// URL.

ConversationRelay includes an X-Twilio-Signature header in the initial WebSocket handshake request. This signature allows you to validate that requests are genuinely coming from Twilio, following the same verification mechanism used for standard Twilio webhooks.

To validate this signature:

1. Extract the X-Twilio-Signature header from the incoming WebSocket connection request.
2. Use your Twilio auth token and the request URL to validate this signature.
3. Only accept connections with valid signatures to prevent spoofed requests.

For detailed implementation guidance, refer to Twilio's webhook security documentation.

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

1. Log in to your Twilio Console.
2. Navigate to the Voice section, select General under Settings, and turn on the Predictive and Generative AI/ML Features Addendum in order to use ConversationRelay.
3. Navigate to the Voice section and select TwiML Apps under Manage.
4. Create a new TwiML App or select an existing one.
5. 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.
6. Save your changes.

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>

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

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

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

For optimal speech quality, apply proper text normalization techniques (such as writing out numbers as words or spelling out abbreviations). See the ConversationRelay documentation for detailed text normalization best practices.

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

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