feat: conversation-relay

Author: kpchoy

README.md

@@ -20,6 +20,10 @@ The reference components demonstrate several common Twilio Voice use cases. Thes
   - Quality metrics
   - Warnings
   - Errors
+- Conversation Relay
+  - Make outgoing call to connect with an agent
+  - Websocket server
+  - Basic OpenAI integration
 
 ## Installation
 
@@ -63,10 +67,15 @@ CALLER_ID=+11234567890
 
 # If developing locally and running the Reference Components locally, consider using a tool like ngrok to proxy the server endpoints. Once proxied, change CALLBACK_BASE_URL to the ngrok URL endpoints.
 # See more info about ngrok by visiting https://ngrok.com.
-CALLBACK_BASE_URL=https://foo.ngrok.dev
+# Note: do not include "https://" or "wss://" in the URL.
+CALLBACK_BASE_URL=foo.ngrok.dev
 
 # Default identity to use
 DEFAULT_IDENTITY=alice
+
+# twilio-voice-conversation-relay
+# See https://platform.openai.com/settings/organization/api-keys
+OPENAI_API_KEY="sk-proj......."
 ```
 
 ## Run the project locally

example.env

@@ -25,7 +25,12 @@ CALLER_ID=+11234567890
 
 # If developing locally and running the Reference Components locally, consider using a tool like ngrok to proxy the server endpoints. Once proxied, change CALLBACK_BASE_URL to the ngrok URL endpoints.
 # See more info about ngrok by visiting https://ngrok.com.
-CALLBACK_BASE_URL=https://foo.ngrok.dev
+# Note: do not include "https://" or "wss://" in the URL.
+CALLBACK_BASE_URL=foo.ngrok.dev
 
 # Default identity to use
 DEFAULT_IDENTITY=alice
+
+# twilio-voice-conversation-relay
+# See https://platform.openai.com/settings/organization/api-keys
+OPENAI_API_KEY="sk-proj......."