@telnyx/ai-agent-lib 0.1.4 → 0.1.6

package/README.md

@@ -46,7 +46,7 @@ createRoot(document.getElementById('root')!).render(
 ### 2. Use hooks in your components
 
 ```tsx
-import React, { useEffect, useRef } from 'react';
+import React, { useEffect, useRef, useState } from 'react';
 import {
   useClient,
   useTranscript,
@@ -62,6 +62,7 @@ function VoiceChat() {
   const conversation = useConversation();
   const agentState = useAgentState();
   const audioRef = useRef<HTMLAudioElement>(null);
+  const [messageInput, setMessageInput] = useState('');
 
   // Setup audio playback
   useEffect(() => {
@@ -70,6 +71,15 @@ function VoiceChat() {
     }
   }, [conversation]);
 
+  const handleSendMessage = () => {
+    if (messageInput.trim()) {
+      client.sendConversationMessage(messageInput);
+      setMessageInput('');
+    }
+  };
+
+  const isCallActive = conversation?.call?.state === 'active';
+
   return (
     <div>
       <h2>Connection: {connectionState}</h2>
@@ -86,6 +96,26 @@ function VoiceChat() {
         End Conversation
       </button>
 
+      {/* Text message input - only available during active call */}
+      {isCallActive && (
+        <div style={{ margin: '20px 0' }}>
+          <h4>Send Text Message</h4>
+          <input
+            type="text"
+            value={messageInput}
+            onChange={(e) => setMessageInput(e.target.value)}
+            placeholder="Type a message..."
+            onKeyPress={(e) => e.key === 'Enter' && handleSendMessage()}
+          />
+          <button 
+            onClick={handleSendMessage}
+            disabled={!messageInput.trim()}
+          >
+            Send Message
+          </button>
+        </div>
+      )}
+
       <audio ref={audioRef} autoPlay playsInline controls />
 
       <div>
@@ -100,6 +130,7 @@ function VoiceChat() {
     </div>
   );
 }
+}
 ```
 
 ## API Reference
@@ -122,6 +153,7 @@ Returns the `TelnyxAIAgent` instance for direct API access.
 - `disconnect()` - Disconnect and cleanup
 - `startConversation()` - Start a new conversation
 - `endConversation()` - End the current conversation
+- `sendConversationMessage(message: string)` - Send a text message during an active conversation
 - `transcript` - Get current transcript array
 
 **Events:**
@@ -183,9 +215,24 @@ agent.on('conversation.agent.state', (state) => {
   console.log(`Agent is now: ${state}`);
 });
 
+agent.on('conversation.update', (notification) => {
+  if (notification.call?.state === 'active') {
+    console.log('Call is now active - you can send messages');
+    
+    // Send a text message during the conversation
+    agent.sendConversationMessage('Hello, I have a question about your services.');
+  }
+});
+
 // Start a conversation
 await agent.startConversation();
 
+// Send messages during an active conversation
+// Note: This will only work when there's an active call
+setTimeout(() => {
+  agent.sendConversationMessage('Can you help me with my account?');
+}, 5000);
+
 // Access transcript
 console.log(agent.transcript);
 
@@ -195,6 +242,57 @@ await agent.disconnect();
 
 ## Advanced Usage
 
+### Sending Text Messages During Conversations
+
+You can send text messages to the AI agent during an active conversation using the `sendConversationMessage` method. This is useful for providing context, asking questions, or sending information that might be easier to type than speak.
+
+```tsx
+// React example
+function ChatInterface() {
+  const client = useClient();
+  const conversation = useConversation();
+  const [message, setMessage] = useState('');
+
+  const handleSendMessage = () => {
+    if (conversation?.call?.state === 'active' && message.trim()) {
+      client.sendConversationMessage(message);
+      setMessage('');
+    }
+  };
+
+  return (
+    <div>
+      {conversation?.call?.state === 'active' && (
+        <div>
+          <input
+            value={message}
+            onChange={(e) => setMessage(e.target.value)}
+            placeholder="Type a message to the agent..."
+            onKeyPress={(e) => e.key === 'Enter' && handleSendMessage()}
+          />
+          <button onClick={handleSendMessage}>Send</button>
+        </div>
+      )}
+    </div>
+  );
+}
+```
+
+```typescript
+// Direct usage example
+agent.on('conversation.update', (notification) => {
+  if (notification.call?.state === 'active') {
+    // Now you can send text messages
+    agent.sendConversationMessage('I need help with order #12345');
+  }
+});
+```
+
+**Important Notes:**
+- Messages can only be sent during an active conversation (when `call.state === 'active'`)
+- The agent will receive and process text messages just like spoken input
+- Text messages may appear in the transcript depending on the agent configuration
+
 ### Custom Audio Handling
 
 The library automatically handles audio stream monitoring and agent state detection based on audio levels. The audio stream is available through the conversation object:

package/dist/client.d.ts

@@ -16,6 +16,7 @@ export declare class TelnyxAIAgent extends EventEmitter<AIAgentEvents> {
     constructor(params: TelnyxAIAgentConstructorParams);
     connect(): Promise<void>;
     disconnect(): Promise<void>;
+    sendConversationMessage(message: string): void;
     get transcript(): TranscriptItem[];
     startConversation(): Promise<void>;
     endConversation(): void | undefined;