retell-sdk 0.1.0-alpha.1

package/src/resources/call.ts

@@ -0,0 +1,542 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
+import * as CallAPI from "./call";
+
+export class Call extends APIResource {
+  /**
+   * Create a new phone call
+   */
+  create(body: CallCreateParams, options?: Core.RequestOptions): Core.APIPromise<CallCreateResponse> {
+    return this._client.post('/create-phone-call', { body, ...options });
+  }
+
+  /**
+   * Retrieve details of a specific call
+   */
+  retrieve(callId: string, options?: Core.RequestOptions): Core.APIPromise<CallDetailResponse> {
+    return this._client.get(`/get-call/${callId}`, options);
+  }
+
+  /**
+   * Retrieve call details
+   */
+  list(query?: CallListParams, options?: Core.RequestOptions): Core.APIPromise<CallListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<CallListResponse>;
+  list(
+    query: CallListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CallListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/list-calls', { query, ...options });
+  }
+
+  /**
+   * Register Call To Get CallId To Establish Connection
+   */
+  register(body: CallRegisterParams, options?: Core.RequestOptions): Core.APIPromise<CallRegisterResponse> {
+    return this._client.post('/register-call', { body, ...options });
+  }
+}
+
+export interface CallDetailResponse {
+  /**
+   * Corresponding agent id of this call.
+   */
+  agent_id: string;
+
+  /**
+   * The audio encoding of the call. The following formats are supported:
+   *
+   * - `s16le` 16 bit linear PCM audio, the native format for web audio capture and
+   *   playback.
+   *
+   * - `mulaw` non-linear audio encoding technique used in telephony. Commonly used
+   *   by Twilio.
+   */
+  audio_encoding: 's16le' | 'mulaw';
+
+  /**
+   * Where the audio websocket would connect from would determine the format /
+   * protocol of websocket messages, and would determine how our server read audio
+   * bytes and send audio bytes.:
+   *
+   * - `web`: The protocol defined by Retell, commonly used for connecting from web
+   *   frontend. Also useful for those who want to manipulate audio bytes directly.
+   *
+   * - `twilio`: The
+   *   [websocket protocol](https://www.twilio.com/docs/voice/twiml/stream#message-media)
+   *   defined by Twilio, used when your system uses Twilio, and supplies Retell
+   *   audio websocket url to Twilio.
+   */
+  audio_websocket_protocol: 'web' | 'twilio';
+
+  /**
+   * Unique id of the call. Used to identify in LLM websocket and used to
+   * authenticate in audio websocket.
+   */
+  call_id: string;
+
+  /**
+   * Status of call.
+   *
+   * - `registered`: Call id issued, ready to make a call using this id.
+   *
+   * - `ongoing`: Call connected and ongoing.
+   *
+   * - `ended`: The underlying websocket has ended for the call. Either user or agent
+   *   hanged up, or call transferred.
+   *
+   * - `error`: Call encountered error.
+   */
+  call_status: 'registered' | 'ongoing' | 'ended' | 'error';
+
+  /**
+   * Sample rate of the conversation, the input and output audio bytes will all
+   * conform to this rate. Check the audio source, audio format, and voice used for
+   * the agent to select one that works. supports value ranging from [8000, 48000].
+   * Note for Twilio `mulaw` encoding, the sample rate has to be 8000.
+   *
+   * - `s16le` sample rate recommendation (natively supported, lowest latency):
+   *
+   *   - elevenlabs voices: 16000, 22050, 24000, 44100.
+   *   - openai voices: 24000.
+   *
+   *   - deepgram voices: 8000, 16000, 24000, 32000, 48000.
+   */
+  sample_rate: number;
+
+  /**
+   * Begin timestamp (milliseconds since epoch) of the call.
+   */
+  start_timestamp: number;
+
+  /**
+   * If users stay silent for a period, end the call. By default, it is set to
+   * 600,000 ms (10 min). The minimum value allowed is 10,000 ms (10 s).
+   */
+  end_call_after_silence_ms?: number;
+
+  /**
+   * The caller number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  from_number?: string;
+
+  /**
+   * An abtriary object for storage purpose only. You can put anything here like your
+   * own id for the call, twilio SID, internal customer id. Not used for processing,
+   * when we connect to your LLM websocket server, you can then get it from the call
+   * object.
+   */
+  metadata?: unknown;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Retell LLM prompt and tool description. Only applicable for Retell LLM.
+   */
+  retell_llm_dynamic_variables?: Record<string, unknown>;
+
+  /**
+   * The callee number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  to_number?: string;
+}
+
+export interface CallCreateResponse {
+  /**
+   * Corresponding agent id of this call.
+   */
+  agent_id: string;
+
+  /**
+   * The audio encoding of the call. The following formats are supported:
+   *
+   * - `s16le` 16 bit linear PCM audio, the native format for web audio capture and
+   *   playback.
+   *
+   * - `mulaw` non-linear audio encoding technique used in telephony. Commonly used
+   *   by Twilio.
+   */
+  audio_encoding: 's16le' | 'mulaw';
+
+  /**
+   * Where the audio websocket would connect from would determine the format /
+   * protocol of websocket messages, and would determine how our server read audio
+   * bytes and send audio bytes.:
+   *
+   * - `web`: The protocol defined by Retell, commonly used for connecting from web
+   *   frontend. Also useful for those who want to manipulate audio bytes directly.
+   *
+   * - `twilio`: The
+   *   [websocket protocol](https://www.twilio.com/docs/voice/twiml/stream#message-media)
+   *   defined by Twilio, used when your system uses Twilio, and supplies Retell
+   *   audio websocket url to Twilio.
+   */
+  audio_websocket_protocol: 'web' | 'twilio';
+
+  /**
+   * Unique id of the call. Used to identify in LLM websocket and used to
+   * authenticate in audio websocket.
+   */
+  call_id: string;
+
+  /**
+   * Status of call.
+   *
+   * - `registered`: Call id issued, ready to make a call using this id.
+   *
+   * - `ongoing`: Call connected and ongoing.
+   *
+   * - `ended`: The underlying websocket has ended for the call. Either user or agent
+   *   hanged up, or call transferred.
+   *
+   * - `error`: Call encountered error.
+   */
+  call_status: 'registered' | 'ongoing' | 'ended' | 'error';
+
+  /**
+   * Sample rate of the conversation, the input and output audio bytes will all
+   * conform to this rate. Check the audio source, audio format, and voice used for
+   * the agent to select one that works. supports value ranging from [8000, 48000].
+   * Note for Twilio `mulaw` encoding, the sample rate has to be 8000.
+   *
+   * - `s16le` sample rate recommendation (natively supported, lowest latency):
+   *
+   *   - elevenlabs voices: 16000, 22050, 24000, 44100.
+   *   - openai voices: 24000.
+   *
+   *   - deepgram voices: 8000, 16000, 24000, 32000, 48000.
+   */
+  sample_rate: number;
+
+  /**
+   * Begin timestamp (milliseconds since epoch) of the call.
+   */
+  start_timestamp: number;
+
+  /**
+   * If users stay silent for a period, end the call. By default, it is set to
+   * 600,000 ms (10 min). The minimum value allowed is 10,000 ms (10 s).
+   */
+  end_call_after_silence_ms?: number;
+
+  /**
+   * The caller number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  from_number?: string;
+
+  /**
+   * An abtriary object for storage purpose only. You can put anything here like your
+   * own id for the call, twilio SID, internal customer id. Not used for processing,
+   * when we connect to your LLM websocket server, you can then get it from the call
+   * object.
+   */
+  metadata?: unknown;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Retell LLM prompt and tool description. Only applicable for Retell LLM.
+   */
+  retell_llm_dynamic_variables?: Record<string, unknown>;
+
+  /**
+   * The callee number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  to_number?: string;
+}
+
+export type CallListResponse = Array<CallDetailResponse>;
+
+export interface CallRegisterResponse {
+  /**
+   * Corresponding agent id of this call.
+   */
+  agent_id: string;
+
+  /**
+   * The audio encoding of the call. The following formats are supported:
+   *
+   * - `s16le` 16 bit linear PCM audio, the native format for web audio capture and
+   *   playback.
+   *
+   * - `mulaw` non-linear audio encoding technique used in telephony. Commonly used
+   *   by Twilio.
+   */
+  audio_encoding: 's16le' | 'mulaw';
+
+  /**
+   * Where the audio websocket would connect from would determine the format /
+   * protocol of websocket messages, and would determine how our server read audio
+   * bytes and send audio bytes.:
+   *
+   * - `web`: The protocol defined by Retell, commonly used for connecting from web
+   *   frontend. Also useful for those who want to manipulate audio bytes directly.
+   *
+   * - `twilio`: The
+   *   [websocket protocol](https://www.twilio.com/docs/voice/twiml/stream#message-media)
+   *   defined by Twilio, used when your system uses Twilio, and supplies Retell
+   *   audio websocket url to Twilio.
+   */
+  audio_websocket_protocol: 'web' | 'twilio';
+
+  /**
+   * Unique id of the call. Used to identify in LLM websocket and used to
+   * authenticate in audio websocket.
+   */
+  call_id: string;
+
+  /**
+   * Status of call.
+   *
+   * - `registered`: Call id issued, ready to make a call using this id.
+   *
+   * - `ongoing`: Call connected and ongoing.
+   *
+   * - `ended`: The underlying websocket has ended for the call. Either user or agent
+   *   hanged up, or call transferred.
+   *
+   * - `error`: Call encountered error.
+   */
+  call_status: 'registered' | 'ongoing' | 'ended' | 'error';
+
+  /**
+   * Sample rate of the conversation, the input and output audio bytes will all
+   * conform to this rate. Check the audio source, audio format, and voice used for
+   * the agent to select one that works. supports value ranging from [8000, 48000].
+   * Note for Twilio `mulaw` encoding, the sample rate has to be 8000.
+   *
+   * - `s16le` sample rate recommendation (natively supported, lowest latency):
+   *
+   *   - elevenlabs voices: 16000, 22050, 24000, 44100.
+   *   - openai voices: 24000.
+   *
+   *   - deepgram voices: 8000, 16000, 24000, 32000, 48000.
+   */
+  sample_rate: number;
+
+  /**
+   * Begin timestamp (milliseconds since epoch) of the call.
+   */
+  start_timestamp: number;
+
+  /**
+   * If users stay silent for a period, end the call. By default, it is set to
+   * 600,000 ms (10 min). The minimum value allowed is 10,000 ms (10 s).
+   */
+  end_call_after_silence_ms?: number;
+
+  /**
+   * The caller number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  from_number?: string;
+
+  /**
+   * An abtriary object for storage purpose only. You can put anything here like your
+   * own id for the call, twilio SID, internal customer id. Not used for processing,
+   * when we connect to your LLM websocket server, you can then get it from the call
+   * object.
+   */
+  metadata?: unknown;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Retell LLM prompt and tool description. Only applicable for Retell LLM.
+   */
+  retell_llm_dynamic_variables?: Record<string, unknown>;
+
+  /**
+   * The callee number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  to_number?: string;
+}
+
+export interface CallCreateParams {
+  phone_number: CallCreateParams.PhoneNumber;
+
+  /**
+   * For this particular call, override the agent used with this agent id. This does
+   * not bind the agent to this number, this is for one time override.
+   */
+  override_agent_id?: string;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Retell LLM prompt and tool description. Only applicable for Retell LLM.
+   */
+  retell_llm_dynamic_variables?: Record<string, unknown>;
+}
+
+export namespace CallCreateParams {
+  export interface PhoneNumber {
+    /**
+     * The number you own in BCP 47 format.
+     */
+    from: string;
+
+    /**
+     * The number you want to call, in BCP 47 format.
+     */
+    to: string;
+  }
+}
+
+export interface CallListParams {
+  filter_criteria?: CallListParams.FilterCriteria;
+
+  /**
+   * Limit the number of calls returned.
+   */
+  limit?: number;
+
+  /**
+   * The calls will be sorted by `start_timestamp`, whether to return the calls in
+   * ascending or descending order.
+   */
+  sort_order?: 'ascending' | 'descending';
+}
+
+export namespace CallListParams {
+  export interface FilterCriteria {
+    /**
+     * Inclusive. Filter calls that end on or after this timestamp.
+     */
+    after_end_timestamp?: number;
+
+    /**
+     * Inclusive. Filter calls that start on or after this timestamp.
+     */
+    after_start_timestamp?: number;
+
+    /**
+     * Only retrieve calls that are made with specific agent(s).
+     */
+    agent_id?: Array<string>;
+
+    /**
+     * Exclusive. Filter calls that end before this timestamp.
+     */
+    before_end_timestamp?: number;
+
+    /**
+     * Exclusive. Filter calls that start before this timestamp.
+     */
+    before_start_timestamp?: number;
+  }
+}
+
+export interface CallRegisterParams {
+  /**
+   * Unique id of agent used for the call. Your agent would contain the LLM Websocket
+   * url used for this call.
+   */
+  agent_id: string;
+
+  /**
+   * The audio encoding of the call. The following formats are supported:
+   *
+   * - `s16le` 16 bit linear PCM audio, the native format for web audio capture and
+   *   playback.
+   *
+   * - `mulaw` non-linear audio encoding technique used in telephony. Commonly used
+   *   by Twilio.
+   */
+  audio_encoding: 's16le' | 'mulaw';
+
+  /**
+   * Where the audio websocket would connect from would determine the format /
+   * protocol of websocket messages, and would determine how our server read audio
+   * bytes and send audio bytes.:
+   *
+   * - `web`: The protocol defined by Retell, commonly used for connecting from web
+   *   frontend. Also useful for those who want to manipulate audio bytes directly.
+   *
+   * - `twilio`: The
+   *   [websocket protocol](https://www.twilio.com/docs/voice/twiml/stream#message-media)
+   *   defined by Twilio, used when your system uses Twilio, and supplies Retell
+   *   audio websocket url to Twilio.
+   */
+  audio_websocket_protocol: 'web' | 'twilio';
+
+  /**
+   * Sample rate of the conversation, the input and output audio bytes will all
+   * conform to this rate. Check the audio source, audio format, and voice used for
+   * the agent to select one that works. supports value ranging from [8000, 48000].
+   * Note for Twilio `mulaw` encoding, the sample rate has to be 8000.
+   *
+   * - `s16le` sample rate recommendation (natively supported, lowest latency):
+   *
+   *   - elevenlabs voices: 16000, 22050, 24000, 44100.
+   *   - openai voices: 24000.
+   *
+   *   - deepgram voices: 8000, 16000, 24000, 32000, 48000.
+   */
+  sample_rate: number;
+
+  /**
+   * If users stay silent for a period, end the call. By default, it is set to
+   * 600,000 ms (10 min). The minimum value allowed is 10,000 ms (10 s).
+   */
+  end_call_after_silence_ms?: number;
+
+  /**
+   * The caller number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  from_number?: string;
+
+  /**
+   * An abtriary object for storage purpose only. You can put anything here like your
+   * own id for the call, twilio SID, internal customer id. Not used for processing,
+   * when we connect to your LLM websocket server, you can then get it from the call
+   * object.
+   */
+  metadata?: unknown;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Retell LLM prompt and tool description. Only applicable for Retell LLM.
+   */
+  retell_llm_dynamic_variables?: Record<string, unknown>;
+
+  /**
+   * The callee number. This field is storage purpose only, set this if you want the
+   * call object to contain it so that it's easier to reference it. Not used for
+   * processing, when we connect to your LLM websocket server, you can then get it
+   * from the call object.
+   */
+  to_number?: string;
+}
+
+export namespace Call {
+  export import CallDetailResponse = CallAPI.CallDetailResponse;
+  export import CallCreateResponse = CallAPI.CallCreateResponse;
+  export import CallListResponse = CallAPI.CallListResponse;
+  export import CallRegisterResponse = CallAPI.CallRegisterResponse;
+  export import CallCreateParams = CallAPI.CallCreateParams;
+  export import CallListParams = CallAPI.CallListParams;
+  export import CallRegisterParams = CallAPI.CallRegisterParams;
+}

package/src/resources/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { AgentResponse, AgentListResponse, AgentCreateParams, AgentUpdateParams, Agent } from './agent';
+export {
+  CallDetailResponse,
+  CallCreateResponse,
+  CallListResponse,
+  CallRegisterResponse,
+  CallCreateParams,
+  CallListParams,
+  CallRegisterParams,
+  Call,
+} from './call';
+export { LlmResponse, LlmListResponse, LlmCreateParams, LlmUpdateParams, Llm } from './llm';
+export {
+  PhoneNumberResponse,
+  PhoneNumberListResponse,
+  PhoneNumberCreateParams,
+  PhoneNumberUpdateParams,
+  PhoneNumber,
+} from './phone-number';