phonic 0.16.3 → 0.18.0

package/README.md

@@ -10,8 +10,11 @@ Node.js library for the Phonic API.
   - [Get conversation by id](#get-conversation-by-id)
   - [Get conversation by external id](#get-conversation-by-external-id)
   - [List conversations](#list-conversations)
-  - [Speech-to-speech via WebSocket](#speech-to-speech-via-websocket)
+  - [STS outbound call](#sts-outbound-call)
+  - [STS outbound call using own Twilio account](#sts-outbound-call-using-own-twilio-account)
+  - [STS via WebSocket](#sts-via-websocket)
     - [Messages that Phonic sends back to you](#messages-that-phonic-sends-back-to-you)
+  
 
 ## Installation
 
@@ -45,7 +48,7 @@ if (error === null) {
 ### Get voice by id
 
 ```ts
-const { data, error } = await phonic.voices.get("meredith");
+const { data, error } = await phonic.voices.get("greta");
 
 if (error === null) {
   console.log(data.voice);
@@ -91,7 +94,52 @@ if (error === null) {
 }
 ```
 
-### Speech-to-speech via WebSocket
+### STS outbound call
+
+```ts
+const { data, error } = await phonic.sts.outboundCall("+19189396241", {
+  welcome_message: "Hello, how can I help you?",
+
+  // Optional fields
+  project: "main",
+  system_prompt: "You are a helpful assistant.",
+  voice_id: "greta",
+  enable_silent_audio_fallback: true,
+  vad_prebuffer_duration_ms: 1800,
+  vad_min_speech_duration_ms: 40,
+  vad_min_silence_duration_ms: 550,
+  vad_threshold: 0.6,
+});
+```
+
+### STS outbound call using own Twilio account
+
+```ts
+const { data, error } = await phonic.sts.twilio.outboundCall(
+  {
+		account_sid: "AC...",
+		api_key_sid: "SK...",
+		api_key_secret: "...",
+		from_phone_number: "+19189372905",
+		to_phone_number: "+19189396241",
+	}, 
+  {
+    welcome_message: "Hello, how can I help you?",
+
+    // Optional fields
+    project: "main",
+    system_prompt: "You are a helpful assistant.",
+    voice_id: "greta",
+    enable_silent_audio_fallback: true,
+    vad_prebuffer_duration_ms: 1800,
+    vad_min_speech_duration_ms: 40,
+    vad_min_silence_duration_ms: 550,
+    vad_threshold: 0.6,
+  }
+);
+```
+
+### STS via WebSocket
 
 To start a conversation, open a WebSocket connection:
 
@@ -103,8 +151,13 @@ const phonicWebSocket = phonic.sts.websocket({
   project: "main",
   system_prompt: "You are a helpful assistant.",
   welcome_message: "Hello, how can I help you?",
-  voice_id: "meredith",
-  output_format: "mulaw_8000"
+  voice_id: "greta",
+  output_format: "mulaw_8000",
+  enable_silent_audio_fallback: true,
+  vad_prebuffer_duration_ms: 1800,
+  vad_min_speech_duration_ms: 40,
+  vad_min_silence_duration_ms: 550,
+  vad_threshold: 0.6,
 });
 ```
 

package/dist/index.d.mts

@@ -7,17 +7,21 @@ type PhonicConfig = {
 };
 type FetchOptions = {
     method: "GET";
-};
-type ErrorResponse = {
-    message: string;
-    code?: string;
+    headers?: Record<string, string>;
+} | {
+    method: "POST";
+    headers?: Record<string, string>;
+    body: string;
 };
 type DataOrError<T> = Promise<{
     data: T;
     error: null;
 } | {
     data: null;
-    error: ErrorResponse;
+    error: {
+        message: string;
+        code?: string;
+    };
 }>;
 type ISODate = `${string}-${string}-${string}`;
 type ISODateTime$1 = `${string}Z`;
@@ -121,6 +125,31 @@ type PhonicSTSWebSocketResponseMessage = {
 type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
 type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
 type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
+type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format"> & {
+    welcome_message: string;
+};
+type OutboundCallSuccessResponse = {
+    success: true;
+};
+
+type PhonicSTSTwilioOutboundCallParams = {
+    account_sid: string;
+    api_key_sid: string;
+    api_key_secret: string;
+    from_phone_number: string;
+    to_phone_number: string;
+};
+type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallSuccessResponse = {
+    success: true;
+    callSid: string;
+};
+
+declare class Twilio {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
 
 declare class PhonicSTSWebSocket {
     private readonly ws;
@@ -148,8 +177,10 @@ declare class PhonicSTSWebSocket {
 
 declare class SpeechToSpeech {
     private readonly phonic;
+    readonly twilio: Twilio;
     constructor(phonic: Phonic);
     websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
+    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 type Voice = {
@@ -184,7 +215,20 @@ declare class Phonic {
     fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
     get<T>(path: string): Promise<{
         data: null;
-        error: ErrorResponse;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+    post<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
     } | {
         data: T;
         error: null;

package/dist/index.d.ts

@@ -7,17 +7,21 @@ type PhonicConfig = {
 };
 type FetchOptions = {
     method: "GET";
-};
-type ErrorResponse = {
-    message: string;
-    code?: string;
+    headers?: Record<string, string>;
+} | {
+    method: "POST";
+    headers?: Record<string, string>;
+    body: string;
 };
 type DataOrError<T> = Promise<{
     data: T;
     error: null;
 } | {
     data: null;
-    error: ErrorResponse;
+    error: {
+        message: string;
+        code?: string;
+    };
 }>;
 type ISODate = `${string}-${string}-${string}`;
 type ISODateTime$1 = `${string}Z`;
@@ -121,6 +125,31 @@ type PhonicSTSWebSocketResponseMessage = {
 type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
 type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
 type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
+type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format"> & {
+    welcome_message: string;
+};
+type OutboundCallSuccessResponse = {
+    success: true;
+};
+
+type PhonicSTSTwilioOutboundCallParams = {
+    account_sid: string;
+    api_key_sid: string;
+    api_key_secret: string;
+    from_phone_number: string;
+    to_phone_number: string;
+};
+type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallSuccessResponse = {
+    success: true;
+    callSid: string;
+};
+
+declare class Twilio {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
 
 declare class PhonicSTSWebSocket {
     private readonly ws;
@@ -148,8 +177,10 @@ declare class PhonicSTSWebSocket {
 
 declare class SpeechToSpeech {
     private readonly phonic;
+    readonly twilio: Twilio;
     constructor(phonic: Phonic);
     websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
+    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 type Voice = {
@@ -184,7 +215,20 @@ declare class Phonic {
     fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
     get<T>(path: string): Promise<{
         data: null;
-        error: ErrorResponse;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+    post<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
     } | {
         data: T;
         error: null;

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.16.3";
+var version = "0.18.0";
 
 // src/conversations/index.ts
 var Conversations = class {
@@ -85,6 +85,29 @@ var Conversations = class {
 // src/sts/index.ts
 var import_ws = __toESM(require("ws"));
 
+// src/sts/twilio/index.ts
+var Twilio = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async outboundCall(params, config) {
+    const response = await this.phonic.post(
+      "/sts/twilio/outbound_call",
+      {
+        from_phone_number: params.from_phone_number,
+        to_phone_number: params.to_phone_number,
+        config
+      },
+      {
+        "X-Twilio-Account-Sid": params.account_sid,
+        "X-Twilio-Api-Key-Sid": params.api_key_sid,
+        "X-Twilio-Api-Key-Secret": params.api_key_secret
+      }
+    );
+    return response;
+  }
+};
+
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
   constructor(ws, config) {
@@ -188,7 +211,9 @@ var PhonicSTSWebSocket = class {
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
+    this.twilio = new Twilio(phonic);
   }
+  twilio;
   websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
@@ -202,6 +227,16 @@ var SpeechToSpeech = class {
     });
     return new PhonicSTSWebSocket(ws, config);
   }
+  async outboundCall(toPhoneNumber, config) {
+    const response = await this.phonic.post(
+      "/sts/outbound_call",
+      {
+        to_phone_number: toPhoneNumber,
+        config
+      }
+    );
+    return response;
+  }
 };
 
 // src/voices/index.ts
@@ -256,9 +291,13 @@ var Phonic = class {
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {
     try {
+      const { headers, ...restOptions } = options;
       const response = await fetch(`${this.baseUrl}/v1${path}`, {
-        headers: this.headers,
-        ...options
+        headers: {
+          ...this.headers,
+          ...headers
+        },
+        ...restOptions
       });
       if (response.ok) {
         const data = await response.json();
@@ -294,6 +333,13 @@ var Phonic = class {
   async get(path) {
     return this.fetchRequest(path, { method: "GET" });
   }
+  async post(path, body, headers) {
+    return this.fetchRequest(path, {
+      method: "POST",
+      body: JSON.stringify(body),
+      headers
+    });
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.16.3";
+var version = "0.18.0";
 
 // src/conversations/index.ts
 var Conversations = class {
@@ -49,6 +49,29 @@ var Conversations = class {
 // src/sts/index.ts
 import WebSocket from "ws";
 
+// src/sts/twilio/index.ts
+var Twilio = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async outboundCall(params, config) {
+    const response = await this.phonic.post(
+      "/sts/twilio/outbound_call",
+      {
+        from_phone_number: params.from_phone_number,
+        to_phone_number: params.to_phone_number,
+        config
+      },
+      {
+        "X-Twilio-Account-Sid": params.account_sid,
+        "X-Twilio-Api-Key-Sid": params.api_key_sid,
+        "X-Twilio-Api-Key-Secret": params.api_key_secret
+      }
+    );
+    return response;
+  }
+};
+
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
   constructor(ws, config) {
@@ -152,7 +175,9 @@ var PhonicSTSWebSocket = class {
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
+    this.twilio = new Twilio(phonic);
   }
+  twilio;
   websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
@@ -166,6 +191,16 @@ var SpeechToSpeech = class {
     });
     return new PhonicSTSWebSocket(ws, config);
   }
+  async outboundCall(toPhoneNumber, config) {
+    const response = await this.phonic.post(
+      "/sts/outbound_call",
+      {
+        to_phone_number: toPhoneNumber,
+        config
+      }
+    );
+    return response;
+  }
 };
 
 // src/voices/index.ts
@@ -220,9 +255,13 @@ var Phonic = class {
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {
     try {
+      const { headers, ...restOptions } = options;
       const response = await fetch(`${this.baseUrl}/v1${path}`, {
-        headers: this.headers,
-        ...options
+        headers: {
+          ...this.headers,
+          ...headers
+        },
+        ...restOptions
       });
       if (response.ok) {
         const data = await response.json();
@@ -258,6 +297,13 @@ var Phonic = class {
   async get(path) {
     return this.fetchRequest(path, { method: "GET" });
   }
+  async post(path, body, headers) {
+    return this.fetchRequest(path, {
+      method: "POST",
+      body: JSON.stringify(body),
+      headers
+    });
+  }
 };
 export {
   Phonic

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phonic",
-  "version": "0.16.3",
+  "version": "0.18.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",
@@ -33,16 +33,17 @@
     "url": "https://github.com/Phonic-Co/phonic-node/issues"
   },
   "dependencies": {
-    "ws": "8.18.1"
+    "ws": "8.18.2"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@changesets/changelog-github": "0.5.1",
-    "@changesets/cli": "2.28.1",
-    "@types/bun": "1.2.8",
+    "@changesets/cli": "2.29.2",
+    "@types/bun": "1.2.12",
+    "@types/ws": "8.18.1",
     "tsup": "8.4.0",
     "typescript": "5.8.3",
-    "zod": "3.24.2"
+    "zod": "3.24.4"
   },
   "files": ["dist/**"],
   "author": {