retell-sdk 4.43.0 → 4.45.0

package/src/resources/call.ts

@@ -26,11 +26,11 @@ export class Call extends APIResource {
    * const callResponse = await client.call.update(
    *   'call_a4441234567890777c4a4a123e6',
    *   {
+   *     data_storage_setting: 'everything_except_pii',
    *     metadata: {
    *       customer_id: 'cust_123',
    *       notes: 'Follow-up required',
    *     },
-   *     opt_out_sensitive_data_storage: true,
    *   },
    * );
    * ```
@@ -203,6 +203,13 @@ export interface PhoneCallResponse {
    */
   custom_sip_headers?: { [key: string]: string };
 
+  /**
+   * Data storage setting for this call's agent. "everything" stores all data,
+   * "everything_except_pii" excludes PII when possible, "basic_attributes_only"
+   * stores only metadata.
+   */
+  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only' | null;
+
   /**
    * The reason for the disconnection of the call. Read details desciption about
    * reasons listed here at
@@ -283,12 +290,6 @@ export interface PhoneCallResponse {
    */
   opt_in_signed_url?: boolean;
 
-  /**
-   * Whether this call opts out of sensitive data storage like transcript, recording,
-   * logging.
-   */
-  opt_out_sensitive_data_storage?: boolean;
-
   /**
    * Public log of the call, containing details about all the requests and responses
    * received in LLM WebSocket, latency tracking for each turntaking, helpful for
@@ -296,6 +297,12 @@ export interface PhoneCallResponse {
    */
   public_log_url?: string;
 
+  /**
+   * Recording of the call, with each party’s audio stored in a separate channel.
+   * Available after the call ends.
+   */
+  recording_multi_channel_url?: string;
+
   /**
    * Recording of the call. Available after call ends.
    */
@@ -308,6 +315,29 @@ export interface PhoneCallResponse {
    */
   retell_llm_dynamic_variables?: { [key: string]: unknown };
 
+  /**
+   * Recording of the call without PII, with each party’s audio stored in a separate
+   * channel. Available after the call ends.
+   */
+  scrubbed_recording_multi_channel_url?: string;
+
+  /**
+   * Recording of the call without PII. Available after call ends.
+   */
+  scrubbed_recording_url?: string;
+
+  /**
+   * Transcript of the call weaved with tool call invocation and results, without
+   * PII. It precisely captures when (at what utterance, which word) the tool was
+   * invoked and what was the result. Available after call ends.
+   */
+  scrubbed_transcript_with_tool_calls?: Array<
+    | PhoneCallResponse.Utterance
+    | PhoneCallResponse.ToolCallInvocationUtterance
+    | PhoneCallResponse.ToolCallResultUtterance
+    | PhoneCallResponse.DtmfUtterance
+  >;
+
   /**
    * Begin timestamp (milliseconds since epoch) of the call. Available after call
    * starts.
@@ -774,6 +804,98 @@ export namespace PhoneCallResponse {
     values: Array<number>;
   }
 
+  export interface Utterance {
+    /**
+     * Transcript of the utterances.
+     */
+    content: string;
+
+    /**
+     * Documents whether this utterance is spoken by agent or user.
+     */
+    role: 'agent' | 'user' | 'transfer_target';
+
+    /**
+     * Array of words in the utterance with the word timestamp. Useful for
+     * understanding what word was spoken at what time. Note that the word timestamp is
+     * not guaranteed to be accurate, it's more like an approximation.
+     */
+    words: Array<Utterance.Word>;
+  }
+
+  export namespace Utterance {
+    export interface Word {
+      /**
+       * End time of the word in the call in second. This is relative audio time, not
+       * wall time.
+       */
+      end?: number;
+
+      /**
+       * Start time of the word in the call in second. This is relative audio time, not
+       * wall time.
+       */
+      start?: number;
+
+      /**
+       * Word transcript (with punctuation if applicable).
+       */
+      word?: string;
+    }
+  }
+
+  export interface ToolCallInvocationUtterance {
+    /**
+     * Arguments for this tool call, it's a stringified JSON object.
+     */
+    arguments: string;
+
+    /**
+     * Name of the function in this tool call.
+     */
+    name: string;
+
+    /**
+     * This is a tool call invocation.
+     */
+    role: 'tool_call_invocation';
+
+    /**
+     * Tool call id, globally unique.
+     */
+    tool_call_id: string;
+  }
+
+  export interface ToolCallResultUtterance {
+    /**
+     * Result of the tool call, can be a string, a stringified json, etc.
+     */
+    content: string;
+
+    /**
+     * This is result of a tool call.
+     */
+    role: 'tool_call_result';
+
+    /**
+     * Tool call id, globally unique.
+     */
+    tool_call_id: string;
+  }
+
+  export interface DtmfUtterance {
+    /**
+     * The digit pressed by the user. Will be a single digit string like "1", "2", "3",
+     * "\*", "#" etc.
+     */
+    digit: string;
+
+    /**
+     * This is user pressed digit from their phone keypad.
+     */
+    role: 'dtmf';
+  }
+
   /**
    * Telephony identifier of the call, populated when available. Tracking purposes
    * only.
@@ -982,6 +1104,13 @@ export interface WebCallResponse {
    */
   custom_sip_headers?: { [key: string]: string };
 
+  /**
+   * Data storage setting for this call's agent. "everything" stores all data,
+   * "everything_except_pii" excludes PII when possible, "basic_attributes_only"
+   * stores only metadata.
+   */
+  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only' | null;
+
   /**
    * The reason for the disconnection of the call. Read details desciption about
    * reasons listed here at
@@ -1062,12 +1191,6 @@ export interface WebCallResponse {
    */
   opt_in_signed_url?: boolean;
 
-  /**
-   * Whether this call opts out of sensitive data storage like transcript, recording,
-   * logging.
-   */
-  opt_out_sensitive_data_storage?: boolean;
-
   /**
    * Public log of the call, containing details about all the requests and responses
    * received in LLM WebSocket, latency tracking for each turntaking, helpful for
@@ -1075,6 +1198,12 @@ export interface WebCallResponse {
    */
   public_log_url?: string;
 
+  /**
+   * Recording of the call, with each party’s audio stored in a separate channel.
+   * Available after the call ends.
+   */
+  recording_multi_channel_url?: string;
+
   /**
    * Recording of the call. Available after call ends.
    */
@@ -1087,6 +1216,29 @@ export interface WebCallResponse {
    */
   retell_llm_dynamic_variables?: { [key: string]: unknown };
 
+  /**
+   * Recording of the call without PII, with each party’s audio stored in a separate
+   * channel. Available after the call ends.
+   */
+  scrubbed_recording_multi_channel_url?: string;
+
+  /**
+   * Recording of the call without PII. Available after call ends.
+   */
+  scrubbed_recording_url?: string;
+
+  /**
+   * Transcript of the call weaved with tool call invocation and results, without
+   * PII. It precisely captures when (at what utterance, which word) the tool was
+   * invoked and what was the result. Available after call ends.
+   */
+  scrubbed_transcript_with_tool_calls?: Array<
+    | WebCallResponse.Utterance
+    | WebCallResponse.ToolCallInvocationUtterance
+    | WebCallResponse.ToolCallResultUtterance
+    | WebCallResponse.DtmfUtterance
+  >;
+
   /**
    * Begin timestamp (milliseconds since epoch) of the call. Available after call
    * starts.
@@ -1547,6 +1699,98 @@ export namespace WebCallResponse {
     values: Array<number>;
   }
 
+  export interface Utterance {
+    /**
+     * Transcript of the utterances.
+     */
+    content: string;
+
+    /**
+     * Documents whether this utterance is spoken by agent or user.
+     */
+    role: 'agent' | 'user' | 'transfer_target';
+
+    /**
+     * Array of words in the utterance with the word timestamp. Useful for
+     * understanding what word was spoken at what time. Note that the word timestamp is
+     * not guaranteed to be accurate, it's more like an approximation.
+     */
+    words: Array<Utterance.Word>;
+  }
+
+  export namespace Utterance {
+    export interface Word {
+      /**
+       * End time of the word in the call in second. This is relative audio time, not
+       * wall time.
+       */
+      end?: number;
+
+      /**
+       * Start time of the word in the call in second. This is relative audio time, not
+       * wall time.
+       */
+      start?: number;
+
+      /**
+       * Word transcript (with punctuation if applicable).
+       */
+      word?: string;
+    }
+  }
+
+  export interface ToolCallInvocationUtterance {
+    /**
+     * Arguments for this tool call, it's a stringified JSON object.
+     */
+    arguments: string;
+
+    /**
+     * Name of the function in this tool call.
+     */
+    name: string;
+
+    /**
+     * This is a tool call invocation.
+     */
+    role: 'tool_call_invocation';
+
+    /**
+     * Tool call id, globally unique.
+     */
+    tool_call_id: string;
+  }
+
+  export interface ToolCallResultUtterance {
+    /**
+     * Result of the tool call, can be a string, a stringified json, etc.
+     */
+    content: string;
+
+    /**
+     * This is result of a tool call.
+     */
+    role: 'tool_call_result';
+
+    /**
+     * Tool call id, globally unique.
+     */
+    tool_call_id: string;
+  }
+
+  export interface DtmfUtterance {
+    /**
+     * The digit pressed by the user. Will be a single digit string like "1", "2", "3",
+     * "\*", "#" etc.
+     */
+    digit: string;
+
+    /**
+     * This is user pressed digit from their phone keypad.
+     */
+    role: 'dtmf';
+  }
+
   export interface TranscriptObject {
     /**
      * Transcript of the utterances.
@@ -1683,6 +1927,14 @@ export namespace WebCallResponse {
 export type CallListResponse = Array<CallResponse>;
 
 export interface CallUpdateParams {
+  /**
+   * Data storage setting for this call. Overrides the agent's default setting.
+   * "everything" stores all data, "everything_except_pii" excludes PII when
+   * possible, "basic_attributes_only" stores only metadata. Cannot be downgraded
+   * from more restrictive to less restrictive settings.
+   */
+  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
+
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
    * your internal customer id associated with the call. Not used for processing. You
@@ -1691,14 +1943,10 @@ export interface CallUpdateParams {
   metadata?: unknown;
 
   /**
-   * Whether this call opts out of sensitive data storage like transcript, recording,
-   * logging. Can only be changed from false to true.
-   */
-  opt_out_sensitive_data_storage?: boolean;
-
-  /**
-   * Override dynamic varaibles represented as key-value pairs of strings. These are
-   * provided during call-updates and have the highest priorty.
+   * Override dynamic varaibles represented as key-value pairs of strings. Setting
+   * this will override or add the dynamic variables set in the agent during the
+   * call. Only need to set the delta where you want to override, no need to set the
+   * entire dynamic variables object.
    */
   override_dynamic_variables?: { [key: string]: string } | null;
 }
@@ -1740,6 +1988,11 @@ export namespace CallListParams {
      */
     agent_id?: Array<string>;
 
+    /**
+     * Only retrieve calls with specific batch call id(s).
+     */
+    batch_call_id?: Array<string>;
+
     /**
      * Only retrieve calls with specific call status(es).
      */