retell-sdk 4.9.0 → 4.11.0

package/src/resources/call.ts

@@ -137,32 +137,16 @@ export interface PhoneCallResponse {
     | 'error_user_not_joined'
     | 'registered_call_timeout';
 
-  /**
-   * End to end latency (from user stops talking to agent start talking) tracking of
-   * the call, available after call ends. This latency does not account for the
-   * network trip time from Retell server to user frontend. The latency is tracked
-   * every time turn change between user and agent.
-   */
-  e2e_latency?: PhoneCallResponse.E2ELatency;
-
   /**
    * End timestamp (milliseconds since epoch) of the call. Available after call ends.
    */
   end_timestamp?: number;
 
   /**
-   * LLM latency (from issue of LLM call to first token received) tracking of the
-   * call, available after call ends. When using custom LLM. this latency includes
-   * LLM websocket roundtrip time between user server and Retell server.
-   */
-  llm_latency?: PhoneCallResponse.LlmLatency;
-
-  /**
-   * LLM websocket roundtrip latency (between user server and Retell server) tracking
-   * of the call, available after call ends. Only populated for calls using custom
-   * LLM.
+   * Latency tracking of the call, available after call ends. Not all fields here
+   * will be available, as it depends on the type of call and feature used.
    */
-  llm_websocket_network_rtt_latency?: PhoneCallResponse.LlmWebsocketNetworkRttLatency;
+  latency?: PhoneCallResponse.Latency;
 
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
@@ -260,130 +244,333 @@ export namespace PhoneCallResponse {
   }
 
   /**
-   * End to end latency (from user stops talking to agent start talking) tracking of
-   * the call, available after call ends. This latency does not account for the
-   * network trip time from Retell server to user frontend. The latency is tracked
-   * every time turn change between user and agent.
+   * Latency tracking of the call, available after call ends. Not all fields here
+   * will be available, as it depends on the type of call and feature used.
    */
-  export interface E2ELatency {
+  export interface Latency {
     /**
-     * Maximum latency in the call, measured in milliseconds.
+     * End to end latency (from user stops talking to agent start talking) tracking of
+     * the call. This latency does not account for the network trip time from Retell
+     * server to user frontend. The latency is tracked every time turn change between
+     * user and agent.
      */
-    max?: number;
+    e2e?: Latency.E2E;
 
     /**
-     * Minimum latency in the call, measured in milliseconds.
+     * Knowledge base latency (from the triggering of knowledge base retrival to all
+     * relevant context received) tracking of the call. Only populated when using
+     * knowledge base feature for the agent of the call.
      */
-    min?: number;
+    knowledge_base?: Latency.KnowledgeBase;
 
     /**
-     * Number of data points (number of times latency is tracked).
+     * LLM latency (from issue of LLM call to first speakable chunk received) tracking
+     * of the call. When using custom LLM. this latency includes LLM websocket
+     * roundtrip time between user server and Retell server.
      */
-    num?: number;
+    llm?: Latency.Llm;
 
     /**
-     * 50 percentile of latency, measured in milliseconds.
+     * LLM websocket roundtrip latency (between user server and Retell server) tracking
+     * of the call. Only populated for calls using custom LLM.
      */
-    p50?: number;
+    llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
 
     /**
-     * 90 percentile of latency, measured in milliseconds.
+     * Speech-to-speech latency (from requesting responses of a S2S model to first byte
+     * received) tracking of the call. Only populated for calls that uses S2S model
+     * like Realtime API.
      */
-    p90?: number;
+    s2s?: Latency.S2s;
 
     /**
-     * 95 percentile of latency, measured in milliseconds.
+     * Text-to-speech latency (from the triggering of TTS to first byte received)
+     * tracking of the call.
      */
-    p95?: number;
-
-    /**
-     * 99 percentile of latency, measured in milliseconds.
-     */
-    p99?: number;
+    tts?: Latency.Tts;
   }
 
-  /**
-   * LLM latency (from issue of LLM call to first token received) tracking of the
-   * call, available after call ends. When using custom LLM. this latency includes
-   * LLM websocket roundtrip time between user server and Retell server.
-   */
-  export interface LlmLatency {
+  export namespace Latency {
     /**
-     * Maximum latency in the call, measured in milliseconds.
+     * End to end latency (from user stops talking to agent start talking) tracking of
+     * the call. This latency does not account for the network trip time from Retell
+     * server to user frontend. The latency is tracked every time turn change between
+     * user and agent.
      */
-    max?: number;
+    export interface E2E {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
 
-    /**
-     * Minimum latency in the call, measured in milliseconds.
-     */
-    min?: number;
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
 
-    /**
-     * Number of data points (number of times latency is tracked).
-     */
-    num?: number;
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
 
-    /**
-     * 50 percentile of latency, measured in milliseconds.
-     */
-    p50?: number;
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
 
-    /**
-     * 90 percentile of latency, measured in milliseconds.
-     */
-    p90?: number;
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
 
-    /**
-     * 95 percentile of latency, measured in milliseconds.
-     */
-    p95?: number;
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
 
-    /**
-     * 99 percentile of latency, measured in milliseconds.
-     */
-    p99?: number;
-  }
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
 
-  /**
-   * LLM websocket roundtrip latency (between user server and Retell server) tracking
-   * of the call, available after call ends. Only populated for calls using custom
-   * LLM.
-   */
-  export interface LlmWebsocketNetworkRttLatency {
-    /**
-     * Maximum latency in the call, measured in milliseconds.
-     */
-    max?: number;
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * Minimum latency in the call, measured in milliseconds.
+     * Knowledge base latency (from the triggering of knowledge base retrival to all
+     * relevant context received) tracking of the call. Only populated when using
+     * knowledge base feature for the agent of the call.
      */
-    min?: number;
+    export interface KnowledgeBase {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
 
-    /**
-     * Number of data points (number of times latency is tracked).
-     */
-    num?: number;
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 50 percentile of latency, measured in milliseconds.
+     * LLM latency (from issue of LLM call to first speakable chunk received) tracking
+     * of the call. When using custom LLM. this latency includes LLM websocket
+     * roundtrip time between user server and Retell server.
      */
-    p50?: number;
+    export interface Llm {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 90 percentile of latency, measured in milliseconds.
+     * LLM websocket roundtrip latency (between user server and Retell server) tracking
+     * of the call. Only populated for calls using custom LLM.
      */
-    p90?: number;
+    export interface LlmWebsocketNetworkRtt {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 95 percentile of latency, measured in milliseconds.
+     * Speech-to-speech latency (from requesting responses of a S2S model to first byte
+     * received) tracking of the call. Only populated for calls that uses S2S model
+     * like Realtime API.
      */
-    p95?: number;
+    export interface S2s {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 99 percentile of latency, measured in milliseconds.
+     * Text-to-speech latency (from the triggering of TTS to first byte received)
+     * tracking of the call.
      */
-    p99?: number;
+    export interface Tts {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
   }
 
   export interface TranscriptObject {
@@ -583,32 +770,16 @@ export interface WebCallResponse {
     | 'error_user_not_joined'
     | 'registered_call_timeout';
 
-  /**
-   * End to end latency (from user stops talking to agent start talking) tracking of
-   * the call, available after call ends. This latency does not account for the
-   * network trip time from Retell server to user frontend. The latency is tracked
-   * every time turn change between user and agent.
-   */
-  e2e_latency?: WebCallResponse.E2ELatency;
-
   /**
    * End timestamp (milliseconds since epoch) of the call. Available after call ends.
    */
   end_timestamp?: number;
 
   /**
-   * LLM latency (from issue of LLM call to first token received) tracking of the
-   * call, available after call ends. When using custom LLM. this latency includes
-   * LLM websocket roundtrip time between user server and Retell server.
-   */
-  llm_latency?: WebCallResponse.LlmLatency;
-
-  /**
-   * LLM websocket roundtrip latency (between user server and Retell server) tracking
-   * of the call, available after call ends. Only populated for calls using custom
-   * LLM.
+   * Latency tracking of the call, available after call ends. Not all fields here
+   * will be available, as it depends on the type of call and feature used.
    */
-  llm_websocket_network_rtt_latency?: WebCallResponse.LlmWebsocketNetworkRttLatency;
+  latency?: WebCallResponse.Latency;
 
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
@@ -706,130 +877,333 @@ export namespace WebCallResponse {
   }
 
   /**
-   * End to end latency (from user stops talking to agent start talking) tracking of
-   * the call, available after call ends. This latency does not account for the
-   * network trip time from Retell server to user frontend. The latency is tracked
-   * every time turn change between user and agent.
+   * Latency tracking of the call, available after call ends. Not all fields here
+   * will be available, as it depends on the type of call and feature used.
    */
-  export interface E2ELatency {
+  export interface Latency {
     /**
-     * Maximum latency in the call, measured in milliseconds.
+     * End to end latency (from user stops talking to agent start talking) tracking of
+     * the call. This latency does not account for the network trip time from Retell
+     * server to user frontend. The latency is tracked every time turn change between
+     * user and agent.
      */
-    max?: number;
+    e2e?: Latency.E2E;
 
     /**
-     * Minimum latency in the call, measured in milliseconds.
+     * Knowledge base latency (from the triggering of knowledge base retrival to all
+     * relevant context received) tracking of the call. Only populated when using
+     * knowledge base feature for the agent of the call.
      */
-    min?: number;
+    knowledge_base?: Latency.KnowledgeBase;
 
     /**
-     * Number of data points (number of times latency is tracked).
+     * LLM latency (from issue of LLM call to first speakable chunk received) tracking
+     * of the call. When using custom LLM. this latency includes LLM websocket
+     * roundtrip time between user server and Retell server.
      */
-    num?: number;
+    llm?: Latency.Llm;
 
     /**
-     * 50 percentile of latency, measured in milliseconds.
+     * LLM websocket roundtrip latency (between user server and Retell server) tracking
+     * of the call. Only populated for calls using custom LLM.
      */
-    p50?: number;
+    llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
 
     /**
-     * 90 percentile of latency, measured in milliseconds.
+     * Speech-to-speech latency (from requesting responses of a S2S model to first byte
+     * received) tracking of the call. Only populated for calls that uses S2S model
+     * like Realtime API.
      */
-    p90?: number;
+    s2s?: Latency.S2s;
 
     /**
-     * 95 percentile of latency, measured in milliseconds.
+     * Text-to-speech latency (from the triggering of TTS to first byte received)
+     * tracking of the call.
      */
-    p95?: number;
-
-    /**
-     * 99 percentile of latency, measured in milliseconds.
-     */
-    p99?: number;
+    tts?: Latency.Tts;
   }
 
-  /**
-   * LLM latency (from issue of LLM call to first token received) tracking of the
-   * call, available after call ends. When using custom LLM. this latency includes
-   * LLM websocket roundtrip time between user server and Retell server.
-   */
-  export interface LlmLatency {
+  export namespace Latency {
     /**
-     * Maximum latency in the call, measured in milliseconds.
+     * End to end latency (from user stops talking to agent start talking) tracking of
+     * the call. This latency does not account for the network trip time from Retell
+     * server to user frontend. The latency is tracked every time turn change between
+     * user and agent.
      */
-    max?: number;
+    export interface E2E {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
 
-    /**
-     * Minimum latency in the call, measured in milliseconds.
-     */
-    min?: number;
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
 
-    /**
-     * Number of data points (number of times latency is tracked).
-     */
-    num?: number;
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
 
-    /**
-     * 50 percentile of latency, measured in milliseconds.
-     */
-    p50?: number;
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
 
-    /**
-     * 90 percentile of latency, measured in milliseconds.
-     */
-    p90?: number;
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
 
-    /**
-     * 95 percentile of latency, measured in milliseconds.
-     */
-    p95?: number;
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
 
-    /**
-     * 99 percentile of latency, measured in milliseconds.
-     */
-    p99?: number;
-  }
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
 
-  /**
-   * LLM websocket roundtrip latency (between user server and Retell server) tracking
-   * of the call, available after call ends. Only populated for calls using custom
-   * LLM.
-   */
-  export interface LlmWebsocketNetworkRttLatency {
-    /**
-     * Maximum latency in the call, measured in milliseconds.
-     */
-    max?: number;
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * Minimum latency in the call, measured in milliseconds.
+     * Knowledge base latency (from the triggering of knowledge base retrival to all
+     * relevant context received) tracking of the call. Only populated when using
+     * knowledge base feature for the agent of the call.
      */
-    min?: number;
+    export interface KnowledgeBase {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
 
-    /**
-     * Number of data points (number of times latency is tracked).
-     */
-    num?: number;
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 50 percentile of latency, measured in milliseconds.
+     * LLM latency (from issue of LLM call to first speakable chunk received) tracking
+     * of the call. When using custom LLM. this latency includes LLM websocket
+     * roundtrip time between user server and Retell server.
      */
-    p50?: number;
+    export interface Llm {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 90 percentile of latency, measured in milliseconds.
+     * LLM websocket roundtrip latency (between user server and Retell server) tracking
+     * of the call. Only populated for calls using custom LLM.
      */
-    p90?: number;
+    export interface LlmWebsocketNetworkRtt {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 95 percentile of latency, measured in milliseconds.
+     * Speech-to-speech latency (from requesting responses of a S2S model to first byte
+     * received) tracking of the call. Only populated for calls that uses S2S model
+     * like Realtime API.
      */
-    p95?: number;
+    export interface S2s {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
 
     /**
-     * 99 percentile of latency, measured in milliseconds.
+     * Text-to-speech latency (from the triggering of TTS to first byte received)
+     * tracking of the call.
      */
-    p99?: number;
+    export interface Tts {
+      /**
+       * Maximum latency in the call, measured in milliseconds.
+       */
+      max?: number;
+
+      /**
+       * Minimum latency in the call, measured in milliseconds.
+       */
+      min?: number;
+
+      /**
+       * Number of data points (number of times latency is tracked).
+       */
+      num?: number;
+
+      /**
+       * 50 percentile of latency, measured in milliseconds.
+       */
+      p50?: number;
+
+      /**
+       * 90 percentile of latency, measured in milliseconds.
+       */
+      p90?: number;
+
+      /**
+       * 95 percentile of latency, measured in milliseconds.
+       */
+      p95?: number;
+
+      /**
+       * 99 percentile of latency, measured in milliseconds.
+       */
+      p99?: number;
+
+      /**
+       * All the latency data points in the call, measured in milliseconds.
+       */
+      values?: Array<number>;
+    }
   }
 
   export interface TranscriptObject {
@@ -980,29 +1354,111 @@ export interface CallListParams {
 export namespace CallListParams {
   export interface FilterCriteria {
     /**
-     * Inclusive. Filter calls that end on or after this timestamp.
+     * Only retrieve calls that are made with specific agent(s).
      */
-    after_end_timestamp?: number;
+    agent_id?: Array<string>;
 
     /**
-     * Inclusive. Filter calls that start on or after this timestamp.
+     * Only retrieve calls with specific call status(es).
      */
-    after_start_timestamp?: number;
+    call_status?: Array<'registered' | 'ongoing' | 'ended' | 'error'>;
 
     /**
-     * Only retrieve calls that are made with specific agent(s).
+     * Only retrieve calls with specific call successful(s).
      */
-    agent_id?: Array<string>;
+    call_successful?: Array<boolean>;
+
+    /**
+     * Only retrieve calls with specific call type(s).
+     */
+    call_type?: Array<'web_call' | 'phone_call'>;
+
+    /**
+     * Only retrieve calls with specific direction(s).
+     */
+    direction?: Array<'inbound' | 'outbound'>;
+
+    /**
+     * Only retrieve calls with specific disconnection reason(s).
+     */
+    disconnection_reason?: Array<
+      | 'user_hangup'
+      | 'agent_hangup'
+      | 'call_transfer'
+      | 'voicemail_reached'
+      | 'inactivity'
+      | 'machine_detected'
+      | 'max_duration_reached'
+      | 'concurrency_limit_reached'
+      | 'no_valid_payment'
+      | 'scam_detected'
+      | 'error_inbound_webhook'
+      | 'dial_busy'
+      | 'dial_failed'
+      | 'dial_no_answer'
+      | 'error_llm_websocket_open'
+      | 'error_llm_websocket_lost_connection'
+      | 'error_llm_websocket_runtime'
+      | 'error_llm_websocket_corrupt_payload'
+      | 'error_frontend_corrupted_payload'
+      | 'error_twilio'
+      | 'error_no_audio_received'
+      | 'error_asr'
+      | 'error_retell'
+      | 'error_unknown'
+      | 'error_user_not_joined'
+      | 'registered_call_timeout'
+    >;
 
     /**
-     * Exclusive. Filter calls that end before this timestamp.
+     * Only retrieve calls with specific range of duration(s).
      */
-    before_end_timestamp?: number;
+    duration_ms?: FilterCriteria.DurationMs;
 
     /**
-     * Exclusive. Filter calls that start before this timestamp.
+     * Only retrieve calls with specific from number(s).
      */
-    before_start_timestamp?: number;
+    from_number?: Array<string>;
+
+    /**
+     * Only retrieve calls that are in voicemail or not in voicemail.
+     */
+    in_voicemail?: Array<boolean>;
+
+    /**
+     * Only retrieve calls with specific range of start timestamp(s).
+     */
+    start_timestamp?: FilterCriteria.StartTimestamp;
+
+    /**
+     * Only retrieve calls with specific to number(s).
+     */
+    to_number?: Array<string>;
+
+    /**
+     * Only retrieve calls with specific user sentiment(s).
+     */
+    user_sentiment?: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
+  }
+
+  export namespace FilterCriteria {
+    /**
+     * Only retrieve calls with specific range of duration(s).
+     */
+    export interface DurationMs {
+      lower_threshold?: number;
+
+      upper_threshold?: number;
+    }
+
+    /**
+     * Only retrieve calls with specific range of start timestamp(s).
+     */
+    export interface StartTimestamp {
+      lower_threshold?: number;
+
+      upper_threshold?: number;
+    }
   }
 }