telnyx 2.1.1 → 3.0.0-alpha

package/resources/webhooks.d.mts

@@ -0,0 +1,4183 @@
+import { APIResource } from "../core/resource.mjs";
+import * as NumberBlockOrdersAPI from "./number-block-orders.mjs";
+import * as CallsAPI from "./calls/calls.mjs";
+import * as MessagesAPI from "./messages/messages.mjs";
+export declare class Webhooks extends APIResource {
+    unwrap(body: string): UnwrapWebhookEvent;
+}
+export interface CallAIGatherEndedWebhookEvent {
+    data?: CallAIGatherEndedWebhookEvent.Data;
+}
+export declare namespace CallAIGatherEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.ai_gather.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Telnyx connection ID used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * The history of the messages exchanged during the AI gather
+             */
+            message_history?: Array<Payload.MessageHistory>;
+            /**
+             * The result of the AI gather, its type depends of the `parameters` provided in
+             * the command
+             */
+            result?: unknown;
+            /**
+             * Reflects how command ended.
+             */
+            status?: 'valid' | 'invalid';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+        namespace Payload {
+            interface MessageHistory {
+                /**
+                 * The content of the message
+                 */
+                content?: string;
+                /**
+                 * The role of the message sender
+                 */
+                role?: 'assistant' | 'user';
+            }
+        }
+    }
+}
+export interface CallAIGatherMessageHistoryUpdatedWebhookEvent {
+    data?: CallAIGatherMessageHistoryUpdatedWebhookEvent.Data;
+}
+export declare namespace CallAIGatherMessageHistoryUpdatedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.ai_gather.message_history_updated';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Telnyx connection ID used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * The history of the messages exchanged during the AI gather
+             */
+            message_history?: Array<Payload.MessageHistory>;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+        namespace Payload {
+            interface MessageHistory {
+                /**
+                 * The content of the message
+                 */
+                content?: string;
+                /**
+                 * The role of the message sender
+                 */
+                role?: 'assistant' | 'user';
+            }
+        }
+    }
+}
+export interface CallAIGatherPartialResultsWebhookEvent {
+    data?: CallAIGatherPartialResultsWebhookEvent.Data;
+}
+export declare namespace CallAIGatherPartialResultsWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.ai_gather.partial_results';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Telnyx connection ID used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * The history of the messages exchanged during the AI gather
+             */
+            message_history?: Array<Payload.MessageHistory>;
+            /**
+             * The partial result of the AI gather, its type depends of the `parameters`
+             * provided in the command
+             */
+            partial_results?: unknown;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+        namespace Payload {
+            interface MessageHistory {
+                /**
+                 * The content of the message
+                 */
+                content?: string;
+                /**
+                 * The role of the message sender
+                 */
+                role?: 'assistant' | 'user';
+            }
+        }
+    }
+}
+export interface CustomerServiceRecordStatusChangedWebhookEvent {
+    data?: CustomerServiceRecordStatusChangedWebhookEvent.Data;
+    meta?: CustomerServiceRecordStatusChangedWebhookEvent.Meta;
+}
+export declare namespace CustomerServiceRecordStatusChangedWebhookEvent {
+    interface Data {
+        /**
+         * Uniquely identifies the callback event.
+         */
+        id?: string;
+        /**
+         * The type of the callback event.
+         */
+        event_type?: 'customer_service_record.status_changed';
+        /**
+         * ISO 8601 formatted date indicating when the callback event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Uniquely identifies the customer service record.
+             */
+            id?: string;
+            /**
+             * The phone number of the customer service record.
+             */
+            phone_number?: string;
+            /**
+             * The status of the customer service record
+             */
+            status?: 'pending' | 'completed' | 'failed';
+            /**
+             * ISO 8601 formatted date indicating the last time where the resource was updated.
+             */
+            updated_at?: string;
+        }
+    }
+    interface Meta {
+        /**
+         * The number of times the callback webhook has been attempted.
+         */
+        attempt?: number;
+        /**
+         * The URL that the callback webhook was delivered to.
+         */
+        delivered_to?: string;
+    }
+}
+export interface CallAnsweredWebhookEvent {
+    data?: CallAnsweredWebhookEvent.Data;
+}
+export declare namespace CallAnsweredWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.answered';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Custom headers set on answer command
+             */
+            custom_headers?: Array<CallsAPI.CustomSipHeader>;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * User-to-User and Diversion headers from sip invite.
+             */
+            sip_headers?: Array<CallsAPI.SipHeader>;
+            /**
+             * ISO 8601 datetime of when the call started.
+             */
+            start_time?: string;
+            /**
+             * State received from a command.
+             */
+            state?: 'answered';
+            /**
+             * Array of tags associated to number.
+             */
+            tags?: Array<string>;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallBridgedWebhookEvent {
+    data?: CallBridgedWebhookEvent.Data;
+}
+export declare namespace CallBridgedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.bridged';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallConversationEndedWebhookEvent {
+    data?: CallConversationEndedWebhookEvent.Data;
+}
+export declare namespace CallConversationEndedWebhookEvent {
+    interface Data {
+        /**
+         * Unique identifier for the event.
+         */
+        id?: string;
+        /**
+         * Timestamp when the event was created in the system.
+         */
+        created_at?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.conversation.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique identifier of the assistant involved in the call.
+             */
+            assistant_id?: string;
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call leg.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session (group of related call legs).
+             */
+            call_session_id?: string;
+            /**
+             * The type of calling party connection.
+             */
+            calling_party_type?: 'pstn' | 'sip';
+            /**
+             * Base64-encoded state received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID unique to the conversation or insight group generated for the call.
+             */
+            conversation_id?: string;
+            /**
+             * Duration of the conversation in seconds.
+             */
+            duration_sec?: number;
+            /**
+             * The caller's number or identifier.
+             */
+            from?: string;
+            /**
+             * The large language model used during the conversation.
+             */
+            llm_model?: string;
+            /**
+             * The speech-to-text model used in the conversation.
+             */
+            stt_model?: string;
+            /**
+             * The callee's number or SIP address.
+             */
+            to?: string;
+            /**
+             * The model ID used for text-to-speech synthesis.
+             */
+            tts_model_id?: string;
+            /**
+             * The text-to-speech provider used in the call.
+             */
+            tts_provider?: string;
+            /**
+             * Voice ID used for TTS.
+             */
+            tts_voice_id?: string;
+        }
+    }
+}
+export interface CallConversationInsightsGeneratedWebhookEvent {
+    data?: CallConversationInsightsGeneratedWebhookEvent.Data;
+}
+export declare namespace CallConversationInsightsGeneratedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.conversation_insights.generated';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * The type of calling party connection.
+             */
+            calling_party_type?: 'pstn' | 'sip';
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the insight group being generated for the call.
+             */
+            insight_group_id?: string;
+            /**
+             * Array of insight results being generated for the call.
+             */
+            results?: Array<Payload.Result>;
+        }
+        namespace Payload {
+            interface Result {
+                /**
+                 * ID that is unique to the insight result being generated for the call.
+                 */
+                insight_id?: string;
+                /**
+                 * The result of the insight.
+                 */
+                result?: unknown | string;
+            }
+        }
+    }
+}
+export interface CallDtmfReceivedWebhookEvent {
+    data?: CallDtmfReceivedWebhookEvent.Data;
+}
+export declare namespace CallDtmfReceivedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.dtmf.received';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Identifies the type of resource.
+             */
+            connection_id?: string;
+            /**
+             * The received DTMF digit or symbol.
+             */
+            digit?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallEnqueuedWebhookEvent {
+    data?: CallEnqueuedWebhookEvent.Data;
+}
+export declare namespace CallEnqueuedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.enqueued';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Current position of the call in the queue.
+             */
+            current_position?: number;
+            /**
+             * The name of the queue
+             */
+            queue?: string;
+            /**
+             * Average time call spends in the queue in seconds.
+             */
+            queue_avg_wait_time_secs?: number;
+        }
+    }
+}
+export interface CallForkStartedWebhookEvent {
+    data?: CallForkStartedWebhookEvent.Data;
+}
+export declare namespace CallForkStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.fork.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique ID for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Type of media streamed. It can be either 'raw' or 'decrypted'.
+             */
+            stream_type?: 'decrypted';
+        }
+    }
+}
+export interface CallForkStoppedWebhookEvent {
+    data?: CallForkStoppedWebhookEvent.Data;
+}
+export declare namespace CallForkStoppedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.fork.stopped';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique ID for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Type of media streamed. It can be either 'raw' or 'decrypted'.
+             */
+            stream_type?: 'decrypted';
+        }
+    }
+}
+export interface CallGatherEndedWebhookEvent {
+    data?: CallGatherEndedWebhookEvent.Data;
+}
+export declare namespace CallGatherEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.gather.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * The received DTMF digit or symbol.
+             */
+            digits?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Reflects how command ended.
+             */
+            status?: 'valid' | 'invalid' | 'call_hangup' | 'cancelled' | 'cancelled_amd' | 'timeout';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallHangupWebhookEvent {
+    data?: CallHangupWebhookEvent.Data;
+}
+export declare namespace CallHangupWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.hangup';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * Call quality statistics aggregated from the CHANNEL_HANGUP_COMPLETE event. Only
+             * includes metrics that are available (filters out nil values). Returns nil if no
+             * metrics are available.
+             */
+            call_quality_stats?: Payload.CallQualityStats | null;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Custom headers set on answer command
+             */
+            custom_headers?: Array<CallsAPI.CustomSipHeader>;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * The reason the call was ended (`call_rejected`, `normal_clearing`,
+             * `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or
+             * `unspecified`).
+             */
+            hangup_cause?: 'call_rejected' | 'normal_clearing' | 'originator_cancel' | 'timeout' | 'time_limit' | 'user_busy' | 'not_found' | 'unspecified';
+            /**
+             * The party who ended the call (`callee`, `caller`, `unknown`).
+             */
+            hangup_source?: 'caller' | 'callee' | 'unknown';
+            /**
+             * The reason the call was ended (SIP response code). If the SIP response is
+             * unavailable (in inbound calls for example) this is set to `unspecified`.
+             */
+            sip_hangup_cause?: string;
+            /**
+             * User-to-User and Diversion headers from sip invite.
+             */
+            sip_headers?: Array<CallsAPI.SipHeader>;
+            /**
+             * ISO 8601 datetime of when the call started.
+             */
+            start_time?: string;
+            /**
+             * State received from a command.
+             */
+            state?: 'hangup';
+            /**
+             * Array of tags associated to number.
+             */
+            tags?: Array<string>;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+        namespace Payload {
+            /**
+             * Call quality statistics aggregated from the CHANNEL_HANGUP_COMPLETE event. Only
+             * includes metrics that are available (filters out nil values). Returns nil if no
+             * metrics are available.
+             */
+            interface CallQualityStats {
+                /**
+                 * Inbound call quality statistics.
+                 */
+                inbound?: CallQualityStats.Inbound;
+                /**
+                 * Outbound call quality statistics.
+                 */
+                outbound?: CallQualityStats.Outbound;
+            }
+            namespace CallQualityStats {
+                /**
+                 * Inbound call quality statistics.
+                 */
+                interface Inbound {
+                    /**
+                     * Maximum jitter variance for inbound audio.
+                     */
+                    jitter_max_variance?: string;
+                    /**
+                     * Number of packets used for jitter calculation on inbound audio.
+                     */
+                    jitter_packet_count?: string;
+                    /**
+                     * Mean Opinion Score (MOS) for inbound audio quality.
+                     */
+                    mos?: string;
+                    /**
+                     * Total number of inbound audio packets.
+                     */
+                    packet_count?: string;
+                    /**
+                     * Number of skipped inbound packets (packet loss).
+                     */
+                    skip_packet_count?: string;
+                }
+                /**
+                 * Outbound call quality statistics.
+                 */
+                interface Outbound {
+                    /**
+                     * Total number of outbound audio packets.
+                     */
+                    packet_count?: string;
+                    /**
+                     * Number of skipped outbound packets (packet loss).
+                     */
+                    skip_packet_count?: string;
+                }
+            }
+        }
+    }
+}
+export interface CallInitiatedWebhookEvent {
+    data?: CallInitiatedWebhookEvent.Data;
+}
+export declare namespace CallInitiatedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.initiated';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * Call screening result.
+             */
+            call_screening_result?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * Caller id.
+             */
+            caller_id_name?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * The list of comma-separated codecs enabled for the connection.
+             */
+            connection_codecs?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Custom headers from sip invite
+             */
+            custom_headers?: Array<CallsAPI.CustomSipHeader>;
+            /**
+             * Whether the call is `incoming` or `outgoing`.
+             */
+            direction?: 'incoming' | 'outgoing';
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * The list of comma-separated codecs offered by caller.
+             */
+            offered_codecs?: string;
+            /**
+             * SHAKEN/STIR attestation level.
+             */
+            shaken_stir_attestation?: string;
+            /**
+             * Whether attestation was successfully validated or not.
+             */
+            shaken_stir_validated?: boolean;
+            /**
+             * User-to-User and Diversion headers from sip invite.
+             */
+            sip_headers?: Array<CallsAPI.SipHeader>;
+            /**
+             * ISO 8601 datetime of when the call started.
+             */
+            start_time?: string;
+            /**
+             * State received from a command.
+             */
+            state?: 'parked' | 'bridging';
+            /**
+             * Array of tags associated to number.
+             */
+            tags?: Array<string>;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallLeftQueueWebhookEvent {
+    data?: CallLeftQueueWebhookEvent.Data;
+}
+export declare namespace CallLeftQueueWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.dequeued';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * The name of the queue
+             */
+            queue?: string;
+            /**
+             * Last position of the call in the queue.
+             */
+            queue_position?: number;
+            /**
+             * The reason for leaving the queue
+             */
+            reason?: 'bridged' | 'bridging-in-process' | 'hangup' | 'leave' | 'timeout';
+            /**
+             * Time call spent in the queue in seconds.
+             */
+            wait_time_secs?: number;
+        }
+    }
+}
+export interface CallMachineDetectionEndedWebhookEvent {
+    data?: CallMachineDetectionEndedWebhookEvent.Data;
+}
+export declare namespace CallMachineDetectionEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.machine.detection.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Answering machine detection result.
+             */
+            result?: 'human' | 'machine' | 'not_sure';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallMachineGreetingEndedWebhookEvent {
+    data?: CallMachineGreetingEndedWebhookEvent.Data;
+}
+export declare namespace CallMachineGreetingEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.machine.greeting.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Answering machine greeting ended result.
+             */
+            result?: 'beep_detected' | 'ended' | 'not_sure';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallMachinePremiumDetectionEndedWebhookEvent {
+    data?: CallMachinePremiumDetectionEndedWebhookEvent.Data;
+}
+export declare namespace CallMachinePremiumDetectionEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.machine.premium.detection.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Premium Answering Machine Detection result.
+             */
+            result?: 'human_residence' | 'human_business' | 'machine' | 'silence' | 'fax_detected' | 'not_sure';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallMachinePremiumGreetingEndedWebhookEvent {
+    data?: CallMachinePremiumGreetingEndedWebhookEvent.Data;
+}
+export declare namespace CallMachinePremiumGreetingEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.machine.premium.greeting.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * Premium Answering Machine Greeting Ended result.
+             */
+            result?: 'beep_detected' | 'no_beep_detected';
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallPlaybackEndedWebhookEvent {
+    data?: CallPlaybackEndedWebhookEvent.Data;
+}
+export declare namespace CallPlaybackEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.playback.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * Whether the stopped audio was in overlay mode or not.
+             */
+            overlay?: boolean;
+            /**
+             * Reflects how command ended.
+             */
+            status?: 'file_not_found' | 'call_hangup' | 'unknown' | 'cancelled' | 'cancelled_amd' | 'completed' | 'failed';
+            /**
+             * Provides details in case of failure.
+             */
+            status_detail?: string;
+        }
+    }
+}
+export interface CallPlaybackStartedWebhookEvent {
+    data?: CallPlaybackStartedWebhookEvent.Data;
+}
+export declare namespace CallPlaybackStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.playback.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * Whether the audio is going to be played in overlay mode or not.
+             */
+            overlay?: boolean;
+        }
+    }
+}
+export interface CallRecordingErrorWebhookEvent {
+    data?: CallRecordingErrorWebhookEvent.Data;
+}
+export declare namespace CallRecordingErrorWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.recording.error';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Indication that there was a problem recording the call.
+             */
+            reason?: 'Failed to authorize with storage using custom credentials' | 'Invalid credentials json' | 'Unsupported backend' | 'Internal server error';
+        }
+    }
+}
+export interface CallRecordingSavedWebhookEvent {
+    data?: CallRecordingSavedWebhookEvent.Data;
+}
+export declare namespace CallRecordingSavedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.recording.saved';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * Whether recording was recorded in `single` or `dual` channel.
+             */
+            channels?: 'single' | 'dual';
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Recording URLs in requested format. The URL is valid for as long as the file
+             * exists. For security purposes, this feature is activated on a per request basis.
+             * Please contact customer support with your Account ID to request activation.
+             */
+            public_recording_urls?: Payload.PublicRecordingURLs;
+            /**
+             * ISO 8601 datetime of when recording ended.
+             */
+            recording_ended_at?: string;
+            /**
+             * ISO 8601 datetime of when recording started.
+             */
+            recording_started_at?: string;
+            /**
+             * Recording URLs in requested format. These URLs are valid for 10 minutes. After
+             * 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings
+             * documentation, or via Mission Control under Reporting -> Recordings.
+             */
+            recording_urls?: Payload.RecordingURLs;
+        }
+        namespace Payload {
+            /**
+             * Recording URLs in requested format. The URL is valid for as long as the file
+             * exists. For security purposes, this feature is activated on a per request basis.
+             * Please contact customer support with your Account ID to request activation.
+             */
+            interface PublicRecordingURLs {
+                /**
+                 * Recording URL in requested `mp3` format.
+                 */
+                mp3?: string | null;
+                /**
+                 * Recording URL in requested `wav` format.
+                 */
+                wav?: string | null;
+            }
+            /**
+             * Recording URLs in requested format. These URLs are valid for 10 minutes. After
+             * 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings
+             * documentation, or via Mission Control under Reporting -> Recordings.
+             */
+            interface RecordingURLs {
+                /**
+                 * Recording URL in requested `mp3` format.
+                 */
+                mp3?: string | null;
+                /**
+                 * Recording URL in requested `wav` format.
+                 */
+                wav?: string | null;
+            }
+        }
+    }
+}
+export interface CallRecordingTranscriptionSavedWebhookEvent {
+    data?: CallRecordingTranscriptionSavedWebhookEvent.Data;
+}
+export declare namespace CallRecordingTranscriptionSavedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.recording.transcription.saved';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * The type of calling party connection.
+             */
+            calling_party_type?: 'pstn' | 'sip';
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the recording session and can be used to correlate webhook
+             * events.
+             */
+            recording_id?: string;
+            /**
+             * ID that is unique to the transcription process and can be used to correlate
+             * webhook events.
+             */
+            recording_transcription_id?: string;
+            /**
+             * The transcription status.
+             */
+            status?: 'completed';
+            /**
+             * The transcribed text
+             */
+            transcription_text?: string;
+        }
+    }
+}
+export interface CallReferCompletedWebhookEvent {
+    data?: CallReferCompletedWebhookEvent.Data;
+}
+export declare namespace CallReferCompletedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.refer.completed';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique ID for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * SIP NOTIFY event status for tracking the REFER attempt.
+             */
+            sip_notify_response?: number;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallReferFailedWebhookEvent {
+    data?: CallReferFailedWebhookEvent.Data;
+}
+export declare namespace CallReferFailedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.refer.failed';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique ID for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * SIP NOTIFY event status for tracking the REFER attempt.
+             */
+            sip_notify_response?: number;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallReferStartedWebhookEvent {
+    data?: CallReferStartedWebhookEvent.Data;
+}
+export declare namespace CallReferStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.refer.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique ID for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Number or SIP URI placing the call.
+             */
+            from?: string;
+            /**
+             * SIP NOTIFY event status for tracking the REFER attempt.
+             */
+            sip_notify_response?: number;
+            /**
+             * Destination number or SIP URI of the call.
+             */
+            to?: string;
+        }
+    }
+}
+export interface CallSiprecFailedWebhookEvent {
+    data?: CallSiprecFailedWebhookEvent.Data;
+}
+export declare namespace CallSiprecFailedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'siprec.failed';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Q850 reason why siprec session failed.
+             */
+            failure_cause?: string;
+        }
+    }
+}
+export interface CallSiprecStartedWebhookEvent {
+    data?: CallSiprecStartedWebhookEvent.Data;
+}
+export declare namespace CallSiprecStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'siprec.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+        }
+    }
+}
+export interface CallSiprecStoppedWebhookEvent {
+    data?: CallSiprecStoppedWebhookEvent.Data;
+}
+export declare namespace CallSiprecStoppedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'siprec.stopped';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Q850 reason why the SIPREC session was stopped.
+             */
+            hangup_cause?: string;
+        }
+    }
+}
+export interface CallSpeakEndedWebhookEvent {
+    data?: CallSpeakEndedWebhookEvent.Data;
+}
+export declare namespace CallSpeakEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.speak.ended';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Reflects how the command ended.
+             */
+            status?: 'completed' | 'call_hangup' | 'cancelled_amd';
+        }
+    }
+}
+export interface CallSpeakStartedWebhookEvent {
+    data?: CallSpeakStartedWebhookEvent.Data;
+}
+export declare namespace CallSpeakStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.speak.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+        }
+    }
+}
+export interface CallStreamingFailedWebhookEvent {
+    data?: CallStreamingFailedWebhookEvent.Data;
+}
+export declare namespace CallStreamingFailedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.failed';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * A short description explaning why the media streaming failed.
+             */
+            failure_reason?: string;
+            /**
+             * Identifies the streaming.
+             */
+            stream_id?: string;
+            /**
+             * Streaming parameters as they were originally given to the Call Control API.
+             */
+            stream_params?: Payload.StreamParams;
+            /**
+             * The type of stream connection the stream is performing.
+             */
+            stream_type?: 'websocket' | 'dialogflow';
+        }
+        namespace Payload {
+            /**
+             * Streaming parameters as they were originally given to the Call Control API.
+             */
+            interface StreamParams {
+                /**
+                 * The destination WebSocket address where the stream is going to be delivered.
+                 */
+                stream_url?: string;
+                /**
+                 * Specifies which track should be streamed.
+                 */
+                track?: 'inbound_track' | 'outbound_track' | 'both_tracks';
+            }
+        }
+    }
+}
+export interface CallStreamingStartedWebhookEvent {
+    data?: CallStreamingStartedWebhookEvent.Data;
+}
+export declare namespace CallStreamingStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Destination WebSocket address where the stream is going to be delivered.
+             */
+            stream_url?: string;
+        }
+    }
+}
+export interface CallStreamingStoppedWebhookEvent {
+    data?: CallStreamingStoppedWebhookEvent.Data;
+}
+export declare namespace CallStreamingStoppedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.stopped';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Destination WebSocket address where the stream is going to be delivered.
+             */
+            stream_url?: string;
+        }
+    }
+}
+export interface CampaignStatusUpdateWebhookEvent {
+    /**
+     * Brand ID associated with the campaign.
+     */
+    brandId?: string;
+    /**
+     * The ID of the campaign.
+     */
+    campaignId?: string;
+    /**
+     * Unix timestamp when campaign was created.
+     */
+    createDate?: string;
+    /**
+     * Alphanumeric identifier of the CSP associated with this campaign.
+     */
+    cspId?: string;
+    /**
+     * Indicates whether the campaign is registered with T-Mobile.
+     */
+    isTMobileRegistered?: boolean;
+}
+export interface ConferenceCreatedWebhookEvent {
+    data?: ConferenceCreatedWebhookEvent.Data;
+}
+export declare namespace ConferenceCreatedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.created';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Conference ID that the participant joined.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceEndedWebhookEvent {
+    data?: ConferenceEndedWebhookEvent.Data;
+}
+export declare namespace ConferenceEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.ended';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Conference ID that the participant joined.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+            /**
+             * Reason the conference ended.
+             */
+            reason?: 'all_left' | 'host_left' | 'time_exceeded';
+        }
+    }
+}
+export interface ConferenceFloorChangedWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'conference.floor.changed';
+    payload?: ConferenceFloorChangedWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace ConferenceFloorChangedWebhookEvent {
+    interface Payload {
+        /**
+         * Call Control ID of the new speaker.
+         */
+        call_control_id?: string;
+        /**
+         * Call Leg ID of the new speaker.
+         */
+        call_leg_id?: string;
+        /**
+         * Call Session ID of the new speaker.
+         */
+        call_session_id?: string;
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * Conference ID that had a speaker change event.
+         */
+        conference_id?: string;
+        /**
+         * Call Control App ID (formerly Telnyx connection ID) used in the call.
+         */
+        connection_id?: string;
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+    }
+}
+export interface ConferenceParticipantJoinedWebhookEvent {
+    data?: ConferenceParticipantJoinedWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantJoinedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.joined';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Conference ID that the participant joined.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+        }
+    }
+}
+export interface ConferenceParticipantLeftWebhookEvent {
+    data?: ConferenceParticipantLeftWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantLeftWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.left';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Conference ID that the participant joined.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+        }
+    }
+}
+export interface ConferenceParticipantPlaybackEndedWebhookEvent {
+    data?: ConferenceParticipantPlaybackEndedWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantPlaybackEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.playback.ended';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Participant's call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceParticipantPlaybackStartedWebhookEvent {
+    data?: ConferenceParticipantPlaybackStartedWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantPlaybackStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.playback.started';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Participant's call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceParticipantSpeakEndedWebhookEvent {
+    data?: ConferenceParticipantSpeakEndedWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantSpeakEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.speak.ended';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Participant's call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceParticipantSpeakStartedWebhookEvent {
+    data?: ConferenceParticipantSpeakStartedWebhookEvent.Data;
+}
+export declare namespace ConferenceParticipantSpeakStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.participant.speak.started';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Participant's call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferencePlaybackEndedWebhookEvent {
+    data?: ConferencePlaybackEndedWebhookEvent.Data;
+}
+export declare namespace ConferencePlaybackEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.playback.ended';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferencePlaybackStartedWebhookEvent {
+    data?: ConferencePlaybackStartedWebhookEvent.Data;
+}
+export declare namespace ConferencePlaybackStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.playback.started';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * The name of the audio media file being played back, if media_name has been used
+             * to start.
+             */
+            media_name?: string;
+            /**
+             * The audio URL being played back, if audio_url has been used to start.
+             */
+            media_url?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceRecordingSavedWebhookEvent {
+    data?: ConferenceRecordingSavedWebhookEvent.Data;
+}
+export declare namespace ConferenceRecordingSavedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.recording.saved';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Participant's call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * Whether recording was recorded in `single` or `dual` channel.
+             */
+            channels?: 'single' | 'dual';
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * ID of the conference that is being recorded.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * The audio file format used when storing the call recording. Can be either `mp3`
+             * or `wav`.
+             */
+            format?: 'wav' | 'mp3';
+            /**
+             * Recording URLs in requested format. The URL is valid for as long as the file
+             * exists. For security purposes, this feature is activated on a per request basis.
+             * Please contact customer support with your Account ID to request activation.
+             */
+            public_recording_urls?: Payload.PublicRecordingURLs;
+            /**
+             * ISO 8601 datetime of when recording ended.
+             */
+            recording_ended_at?: string;
+            /**
+             * ID of the conference recording.
+             */
+            recording_id?: string;
+            /**
+             * ISO 8601 datetime of when recording started.
+             */
+            recording_started_at?: string;
+            /**
+             * Recording URLs in requested format. These URLs are valid for 10 minutes. After
+             * 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings
+             * documentation, or via Mission Control under Reporting -> Recordings.
+             */
+            recording_urls?: Payload.RecordingURLs;
+        }
+        namespace Payload {
+            /**
+             * Recording URLs in requested format. The URL is valid for as long as the file
+             * exists. For security purposes, this feature is activated on a per request basis.
+             * Please contact customer support with your Account ID to request activation.
+             */
+            interface PublicRecordingURLs {
+                /**
+                 * Recording URL in requested `mp3` format.
+                 */
+                mp3?: string | null;
+                /**
+                 * Recording URL in requested `wav` format.
+                 */
+                wav?: string | null;
+            }
+            /**
+             * Recording URLs in requested format. These URLs are valid for 10 minutes. After
+             * 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings
+             * documentation, or via Mission Control under Reporting -> Recordings.
+             */
+            interface RecordingURLs {
+                /**
+                 * Recording URL in requested `mp3` format.
+                 */
+                mp3?: string | null;
+                /**
+                 * Recording URL in requested `wav` format.
+                 */
+                wav?: string | null;
+            }
+        }
+    }
+}
+export interface ConferenceSpeakEndedWebhookEvent {
+    data?: ConferenceSpeakEndedWebhookEvent.Data;
+}
+export declare namespace ConferenceSpeakEndedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.speak.ended';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface ConferenceSpeakStartedWebhookEvent {
+    data?: ConferenceSpeakStartedWebhookEvent.Data;
+}
+export declare namespace ConferenceSpeakStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'conference.speak.started';
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * ID of the conference the text was spoken in.
+             */
+            conference_id?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * ID that is unique to the call session that started the conference.
+             */
+            creator_call_session_id?: string;
+            /**
+             * ISO 8601 datetime of when the event occurred.
+             */
+            occurred_at?: string;
+        }
+    }
+}
+export interface DeliveryUpdateWebhookEvent {
+    data?: DeliveryUpdateWebhookEvent.Data;
+    meta?: DeliveryUpdateWebhookEvent.Meta;
+}
+export declare namespace DeliveryUpdateWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'message.sent' | 'message.finalized';
+        /**
+         * ISO 8601 formatted date indicating when the resource was created.
+         */
+        occurred_at?: string;
+        payload?: MessagesAPI.OutboundMessagePayload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    interface Meta {
+        /**
+         * Number of attempts to deliver the webhook event.
+         */
+        attempt?: number;
+        /**
+         * The webhook URL the event was delivered to.
+         */
+        delivered_to?: string;
+    }
+}
+export interface FaxDeliveredWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'fax.delivered';
+    payload?: FaxDeliveredWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace FaxDeliveredWebhookEvent {
+    interface Payload {
+        /**
+         * The duration of the call in seconds.
+         */
+        call_duration_secs?: number;
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * The ID of the connection used to send the fax.
+         */
+        connection_id?: string;
+        /**
+         * The direction of the fax.
+         */
+        direction?: 'inbound' | 'outbound';
+        /**
+         * Identifies the fax.
+         */
+        fax_id?: string;
+        /**
+         * The phone number, in E.164 format, the fax will be sent from.
+         */
+        from?: string;
+        /**
+         * The media_name used for the fax's media. Must point to a file previously
+         * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+         * and media_url/contents can't be submitted together.
+         */
+        media_name?: string;
+        /**
+         * The original URL to the PDF used for the fax's media. If media_name was
+         * supplied, this is omitted
+         */
+        original_media_url?: string;
+        /**
+         * Number of transferred pages
+         */
+        page_count?: number;
+        /**
+         * The status of the fax.
+         */
+        status?: 'delivered';
+        /**
+         * The phone number, in E.164 format, the fax will be sent to or SIP URI
+         */
+        to?: string;
+        /**
+         * Identifier of the user to whom the fax belongs
+         */
+        user_id?: string;
+    }
+}
+export interface FaxFailedWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'fax.failed';
+    payload?: FaxFailedWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace FaxFailedWebhookEvent {
+    interface Payload {
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * The ID of the connection used to send the fax.
+         */
+        connection_id?: string;
+        /**
+         * The direction of the fax.
+         */
+        direction?: 'inbound' | 'outbound';
+        /**
+         * Cause of the sending failure
+         */
+        failure_reason?: 'rejected';
+        /**
+         * Identifies the fax.
+         */
+        fax_id?: string;
+        /**
+         * The phone number, in E.164 format, the fax will be sent from.
+         */
+        from?: string;
+        /**
+         * The media_name used for the fax's media. Must point to a file previously
+         * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+         * and media_url/contents can't be submitted together.
+         */
+        media_name?: string;
+        /**
+         * The original URL to the PDF used for the fax's media. If media_name was
+         * supplied, this is omitted
+         */
+        original_media_url?: string;
+        /**
+         * The status of the fax.
+         */
+        status?: 'failed';
+        /**
+         * The phone number, in E.164 format, the fax will be sent to or SIP URI
+         */
+        to?: string;
+        /**
+         * Identifier of the user to whom the fax belongs
+         */
+        user_id?: string;
+    }
+}
+export interface FaxMediaProcessedWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'fax.media.processed';
+    payload?: FaxMediaProcessedWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace FaxMediaProcessedWebhookEvent {
+    interface Payload {
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * The ID of the connection used to send the fax.
+         */
+        connection_id?: string;
+        /**
+         * The direction of the fax.
+         */
+        direction?: 'inbound' | 'outbound';
+        /**
+         * Identifies the fax.
+         */
+        fax_id?: string;
+        /**
+         * The phone number, in E.164 format, the fax will be sent from.
+         */
+        from?: string;
+        /**
+         * The media_name used for the fax's media. Must point to a file previously
+         * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+         * and media_url/contents can't be submitted together.
+         */
+        media_name?: string;
+        /**
+         * The original URL to the PDF used for the fax's media. If media_name was
+         * supplied, this is omitted
+         */
+        original_media_url?: string;
+        /**
+         * The status of the fax.
+         */
+        status?: 'media.processed';
+        /**
+         * The phone number, in E.164 format, the fax will be sent to or SIP URI
+         */
+        to?: string;
+        /**
+         * Identifier of the user to whom the fax belongs
+         */
+        user_id?: string;
+    }
+}
+export interface FaxQueuedWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'fax.queued';
+    payload?: FaxQueuedWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace FaxQueuedWebhookEvent {
+    interface Payload {
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * The ID of the connection used to send the fax.
+         */
+        connection_id?: string;
+        /**
+         * The direction of the fax.
+         */
+        direction?: 'inbound' | 'outbound';
+        /**
+         * Identifies the fax.
+         */
+        fax_id?: string;
+        /**
+         * The phone number, in E.164 format, the fax will be sent from.
+         */
+        from?: string;
+        /**
+         * The media_name used for the fax's media. Must point to a file previously
+         * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+         * and media_url/contents can't be submitted together.
+         */
+        media_name?: string;
+        /**
+         * The original URL to the PDF used for the fax's media. If media_name was
+         * supplied, this is omitted
+         */
+        original_media_url?: string;
+        /**
+         * The status of the fax.
+         */
+        status?: 'queued';
+        /**
+         * The phone number, in E.164 format, the fax will be sent to or SIP URI
+         */
+        to?: string;
+        /**
+         * Identifier of the user to whom the fax belongs
+         */
+        user_id?: string;
+    }
+}
+export interface FaxSendingStartedWebhookEvent {
+    /**
+     * Identifies the type of resource.
+     */
+    id?: string;
+    /**
+     * The type of event being delivered.
+     */
+    event_type?: 'fax.sending.started';
+    payload?: FaxSendingStartedWebhookEvent.Payload;
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: 'event';
+}
+export declare namespace FaxSendingStartedWebhookEvent {
+    interface Payload {
+        /**
+         * State received from a command.
+         */
+        client_state?: string;
+        /**
+         * The ID of the connection used to send the fax.
+         */
+        connection_id?: string;
+        /**
+         * The direction of the fax.
+         */
+        direction?: 'inbound' | 'outbound';
+        /**
+         * Identifies the fax.
+         */
+        fax_id?: string;
+        /**
+         * The phone number, in E.164 format, the fax will be sent from.
+         */
+        from?: string;
+        /**
+         * The media_name used for the fax's media. Must point to a file previously
+         * uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+         * and media_url/contents can't be submitted together.
+         */
+        media_name?: string;
+        /**
+         * The original URL to the PDF used for the fax's media. If media_name was
+         * supplied, this is omitted
+         */
+        original_media_url?: string;
+        /**
+         * The status of the fax.
+         */
+        status?: 'sending';
+        /**
+         * The phone number, in E.164 format, the fax will be sent to or SIP URI
+         */
+        to?: string;
+        /**
+         * Identifier of the user to whom the fax belongs
+         */
+        user_id?: string;
+    }
+}
+export interface InboundMessageWebhookEvent {
+    data?: InboundMessageWebhookEvent.Data;
+}
+export declare namespace InboundMessageWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'message.received';
+        /**
+         * ISO 8601 formatted date indicating when the resource was created.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Identifies the type of resource.
+             */
+            id?: string;
+            cc?: Array<Payload.Cc>;
+            /**
+             * Not used for inbound messages.
+             */
+            completed_at?: string | null;
+            cost?: Payload.Cost | null;
+            /**
+             * Detailed breakdown of the message cost components.
+             */
+            cost_breakdown?: Payload.CostBreakdown | null;
+            /**
+             * The direction of the message. Inbound messages are sent to you whereas outbound
+             * messages are sent from you.
+             */
+            direction?: 'inbound';
+            /**
+             * Encoding scheme used for the message body.
+             */
+            encoding?: string;
+            /**
+             * These errors may point at addressees when referring to unsuccessful/unconfirmed
+             * delivery statuses.
+             */
+            errors?: Array<MessagesAPI.MessagingError>;
+            from?: Payload.From;
+            media?: Array<Payload.Media>;
+            /**
+             * Unique identifier for a messaging profile.
+             */
+            messaging_profile_id?: string;
+            /**
+             * Number of parts into which the message's body must be split.
+             */
+            parts?: number;
+            /**
+             * ISO 8601 formatted date indicating when the message request was received.
+             */
+            received_at?: string;
+            /**
+             * Identifies the type of the resource.
+             */
+            record_type?: 'message';
+            /**
+             * Not used for inbound messages.
+             */
+            sent_at?: string | null;
+            /**
+             * Tags associated with the resource.
+             */
+            tags?: Array<string>;
+            /**
+             * Indicates whether the TCR campaign is billable.
+             */
+            tcr_campaign_billable?: boolean;
+            /**
+             * The Campaign Registry (TCR) campaign ID associated with the message.
+             */
+            tcr_campaign_id?: string | null;
+            /**
+             * The registration status of the TCR campaign.
+             */
+            tcr_campaign_registered?: string | null;
+            /**
+             * Message body (i.e., content) as a non-empty string.
+             *
+             * **Required for SMS**
+             */
+            text?: string;
+            to?: Array<Payload.To>;
+            /**
+             * The type of message. This value can be either 'sms' or 'mms'.
+             */
+            type?: 'SMS' | 'MMS';
+            /**
+             * Not used for inbound messages.
+             */
+            valid_until?: string | null;
+            /**
+             * The failover URL where webhooks related to this message will be sent if sending
+             * to the primary URL fails.
+             */
+            webhook_failover_url?: string | null;
+            /**
+             * The URL where webhooks related to this message will be sent.
+             */
+            webhook_url?: string | null;
+        }
+        namespace Payload {
+            interface Cc {
+                /**
+                 * The carrier of the receiver.
+                 */
+                carrier?: string;
+                /**
+                 * The line-type of the receiver.
+                 */
+                line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+                /**
+                 * Receiving address (+E.164 formatted phone number or short code).
+                 */
+                phone_number?: string;
+                status?: 'queued' | 'sending' | 'sent' | 'delivered' | 'sending_failed' | 'delivery_failed' | 'delivery_unconfirmed';
+            }
+            interface Cost {
+                /**
+                 * The amount deducted from your account.
+                 */
+                amount?: string;
+                /**
+                 * The ISO 4217 currency identifier.
+                 */
+                currency?: string;
+            }
+            /**
+             * Detailed breakdown of the message cost components.
+             */
+            interface CostBreakdown {
+                carrier_fee?: CostBreakdown.CarrierFee;
+                rate?: CostBreakdown.Rate;
+            }
+            namespace CostBreakdown {
+                interface CarrierFee {
+                    /**
+                     * The carrier fee amount.
+                     */
+                    amount?: string;
+                    /**
+                     * The ISO 4217 currency identifier.
+                     */
+                    currency?: string;
+                }
+                interface Rate {
+                    /**
+                     * The rate amount applied.
+                     */
+                    amount?: string;
+                    /**
+                     * The ISO 4217 currency identifier.
+                     */
+                    currency?: string;
+                }
+            }
+            interface From {
+                /**
+                 * The carrier of the sender.
+                 */
+                carrier?: string;
+                /**
+                 * The line-type of the sender.
+                 */
+                line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+                /**
+                 * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+                 * code).
+                 */
+                phone_number?: string;
+                status?: 'received' | 'delivered';
+            }
+            interface Media {
+                /**
+                 * The MIME type of the requested media.
+                 */
+                content_type?: string;
+                /**
+                 * The SHA256 hash of the requested media.
+                 */
+                hash_sha256?: string;
+                /**
+                 * The size of the requested media.
+                 */
+                size?: number;
+                /**
+                 * The url of the media requested to be sent.
+                 */
+                url?: string;
+            }
+            interface To {
+                /**
+                 * The carrier of the receiver.
+                 */
+                carrier?: string;
+                /**
+                 * The line-type of the receiver.
+                 */
+                line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+                /**
+                 * Receiving address (+E.164 formatted phone number or short code).
+                 */
+                phone_number?: string;
+                status?: 'queued' | 'sending' | 'sent' | 'delivered' | 'sending_failed' | 'delivery_failed' | 'delivery_unconfirmed' | 'webhook_delivered';
+            }
+        }
+    }
+}
+export interface NumberOrderStatusUpdateWebhookEvent {
+    data?: NumberBlockOrdersAPI.NumberBlockOrder;
+}
+export interface ReplacedLinkClickWebhookEvent {
+    data?: ReplacedLinkClickWebhookEvent.Data;
+}
+export declare namespace ReplacedLinkClickWebhookEvent {
+    interface Data {
+        /**
+         * The message ID associated with the clicked link.
+         */
+        message_id?: string;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: string;
+        /**
+         * ISO 8601 formatted date indicating when the message request was received.
+         */
+        time_clicked?: string;
+        /**
+         * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+         * code).
+         */
+        to?: string;
+        /**
+         * The original link that was sent in the message.
+         */
+        url?: string;
+    }
+}
+export interface StreamingFailedWebhookEvent {
+    data?: StreamingFailedWebhookEvent.Data;
+}
+export declare namespace StreamingFailedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.failed';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * A short description explaning why the media streaming failed.
+             */
+            failure_reason?: string;
+            /**
+             * Identifies the streaming.
+             */
+            stream_id?: string;
+            /**
+             * Streaming parameters as they were originally given to the Call Control API.
+             */
+            stream_params?: Payload.StreamParams;
+            /**
+             * The type of stream connection the stream is performing.
+             */
+            stream_type?: 'websocket' | 'dialogflow';
+        }
+        namespace Payload {
+            /**
+             * Streaming parameters as they were originally given to the Call Control API.
+             */
+            interface StreamParams {
+                /**
+                 * The destination WebSocket address where the stream is going to be delivered.
+                 */
+                stream_url?: string;
+                /**
+                 * Specifies which track should be streamed.
+                 */
+                track?: 'inbound_track' | 'outbound_track' | 'both_tracks';
+            }
+        }
+    }
+}
+export interface StreamingStartedWebhookEvent {
+    data?: StreamingStartedWebhookEvent.Data;
+}
+export declare namespace StreamingStartedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.started';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Destination WebSocket address where the stream is going to be delivered.
+             */
+            stream_url?: string;
+        }
+    }
+}
+export interface StreamingStoppedWebhookEvent {
+    data?: StreamingStoppedWebhookEvent.Data;
+}
+export declare namespace StreamingStoppedWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'streaming.stopped';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Call ID used to issue commands via Call Control API.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * State received from a command.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            /**
+             * Destination WebSocket address where the stream is going to be delivered.
+             */
+            stream_url?: string;
+        }
+    }
+}
+export interface TranscriptionWebhookEvent {
+    data?: TranscriptionWebhookEvent.Data;
+}
+export declare namespace TranscriptionWebhookEvent {
+    interface Data {
+        /**
+         * Identifies the type of resource.
+         */
+        id?: string;
+        /**
+         * The type of event being delivered.
+         */
+        event_type?: 'call.transcription';
+        /**
+         * ISO 8601 datetime of when the event occurred.
+         */
+        occurred_at?: string;
+        payload?: Data.Payload;
+        /**
+         * Identifies the type of the resource.
+         */
+        record_type?: 'event';
+    }
+    namespace Data {
+        interface Payload {
+            /**
+             * Unique identifier and token for controlling the call.
+             */
+            call_control_id?: string;
+            /**
+             * ID that is unique to the call and can be used to correlate webhook events.
+             */
+            call_leg_id?: string;
+            /**
+             * ID that is unique to the call session and can be used to correlate webhook
+             * events. Call session is a group of related call legs that logically belong to
+             * the same phone call, e.g. an inbound and outbound leg of a transferred call.
+             */
+            call_session_id?: string;
+            /**
+             * Use this field to add state to every subsequent webhook. It must be a valid
+             * Base-64 encoded string.
+             */
+            client_state?: string;
+            /**
+             * Call Control App ID (formerly Telnyx connection ID) used in the call.
+             */
+            connection_id?: string;
+            transcription_data?: Payload.TranscriptionData;
+        }
+        namespace Payload {
+            interface TranscriptionData {
+                /**
+                 * Speech recognition confidence level.
+                 */
+                confidence?: number;
+                /**
+                 * When false, it means that this is an interim result.
+                 */
+                is_final?: boolean;
+                /**
+                 * Recognized text.
+                 */
+                transcript?: string;
+                /**
+                 * Indicates which leg of the call has been transcribed. This is only available
+                 * when `transcription_engine` is set to `B`.
+                 */
+                transcription_track?: 'inbound' | 'outbound';
+            }
+        }
+    }
+}
+export type UnwrapWebhookEvent = CallAIGatherEndedWebhookEvent | CallAIGatherMessageHistoryUpdatedWebhookEvent | CallAIGatherPartialResultsWebhookEvent | CustomerServiceRecordStatusChangedWebhookEvent | CallAnsweredWebhookEvent | CallBridgedWebhookEvent | CallConversationEndedWebhookEvent | CallConversationInsightsGeneratedWebhookEvent | CallDtmfReceivedWebhookEvent | CallEnqueuedWebhookEvent | CallForkStartedWebhookEvent | CallForkStoppedWebhookEvent | CallGatherEndedWebhookEvent | CallHangupWebhookEvent | CallInitiatedWebhookEvent | CallLeftQueueWebhookEvent | CallMachineDetectionEndedWebhookEvent | CallMachineGreetingEndedWebhookEvent | CallMachinePremiumDetectionEndedWebhookEvent | CallMachinePremiumGreetingEndedWebhookEvent | CallPlaybackEndedWebhookEvent | CallPlaybackStartedWebhookEvent | CallRecordingErrorWebhookEvent | CallRecordingSavedWebhookEvent | CallRecordingTranscriptionSavedWebhookEvent | CallReferCompletedWebhookEvent | CallReferFailedWebhookEvent | CallReferStartedWebhookEvent | CallSiprecFailedWebhookEvent | CallSiprecStartedWebhookEvent | CallSiprecStoppedWebhookEvent | CallSpeakEndedWebhookEvent | CallSpeakStartedWebhookEvent | CallStreamingFailedWebhookEvent | CallStreamingStartedWebhookEvent | CallStreamingStoppedWebhookEvent | CampaignStatusUpdateWebhookEvent | ConferenceCreatedWebhookEvent | ConferenceEndedWebhookEvent | ConferenceFloorChangedWebhookEvent | ConferenceParticipantJoinedWebhookEvent | ConferenceParticipantLeftWebhookEvent | ConferenceParticipantPlaybackEndedWebhookEvent | ConferenceParticipantPlaybackStartedWebhookEvent | ConferenceParticipantSpeakEndedWebhookEvent | ConferenceParticipantSpeakStartedWebhookEvent | ConferencePlaybackEndedWebhookEvent | ConferencePlaybackStartedWebhookEvent | ConferenceRecordingSavedWebhookEvent | ConferenceSpeakEndedWebhookEvent | ConferenceSpeakStartedWebhookEvent | DeliveryUpdateWebhookEvent | FaxDeliveredWebhookEvent | FaxFailedWebhookEvent | FaxMediaProcessedWebhookEvent | FaxQueuedWebhookEvent | FaxSendingStartedWebhookEvent | InboundMessageWebhookEvent | NumberOrderStatusUpdateWebhookEvent | ReplacedLinkClickWebhookEvent | StreamingFailedWebhookEvent | StreamingStartedWebhookEvent | StreamingStoppedWebhookEvent | TranscriptionWebhookEvent;
+export declare namespace Webhooks {
+    export { type CallAIGatherEndedWebhookEvent as CallAIGatherEndedWebhookEvent, type CallAIGatherMessageHistoryUpdatedWebhookEvent as CallAIGatherMessageHistoryUpdatedWebhookEvent, type CallAIGatherPartialResultsWebhookEvent as CallAIGatherPartialResultsWebhookEvent, type CustomerServiceRecordStatusChangedWebhookEvent as CustomerServiceRecordStatusChangedWebhookEvent, type CallAnsweredWebhookEvent as CallAnsweredWebhookEvent, type CallBridgedWebhookEvent as CallBridgedWebhookEvent, type CallConversationEndedWebhookEvent as CallConversationEndedWebhookEvent, type CallConversationInsightsGeneratedWebhookEvent as CallConversationInsightsGeneratedWebhookEvent, type CallDtmfReceivedWebhookEvent as CallDtmfReceivedWebhookEvent, type CallEnqueuedWebhookEvent as CallEnqueuedWebhookEvent, type CallForkStartedWebhookEvent as CallForkStartedWebhookEvent, type CallForkStoppedWebhookEvent as CallForkStoppedWebhookEvent, type CallGatherEndedWebhookEvent as CallGatherEndedWebhookEvent, type CallHangupWebhookEvent as CallHangupWebhookEvent, type CallInitiatedWebhookEvent as CallInitiatedWebhookEvent, type CallLeftQueueWebhookEvent as CallLeftQueueWebhookEvent, type CallMachineDetectionEndedWebhookEvent as CallMachineDetectionEndedWebhookEvent, type CallMachineGreetingEndedWebhookEvent as CallMachineGreetingEndedWebhookEvent, type CallMachinePremiumDetectionEndedWebhookEvent as CallMachinePremiumDetectionEndedWebhookEvent, type CallMachinePremiumGreetingEndedWebhookEvent as CallMachinePremiumGreetingEndedWebhookEvent, type CallPlaybackEndedWebhookEvent as CallPlaybackEndedWebhookEvent, type CallPlaybackStartedWebhookEvent as CallPlaybackStartedWebhookEvent, type CallRecordingErrorWebhookEvent as CallRecordingErrorWebhookEvent, type CallRecordingSavedWebhookEvent as CallRecordingSavedWebhookEvent, type CallRecordingTranscriptionSavedWebhookEvent as CallRecordingTranscriptionSavedWebhookEvent, type CallReferCompletedWebhookEvent as CallReferCompletedWebhookEvent, type CallReferFailedWebhookEvent as CallReferFailedWebhookEvent, type CallReferStartedWebhookEvent as CallReferStartedWebhookEvent, type CallSiprecFailedWebhookEvent as CallSiprecFailedWebhookEvent, type CallSiprecStartedWebhookEvent as CallSiprecStartedWebhookEvent, type CallSiprecStoppedWebhookEvent as CallSiprecStoppedWebhookEvent, type CallSpeakEndedWebhookEvent as CallSpeakEndedWebhookEvent, type CallSpeakStartedWebhookEvent as CallSpeakStartedWebhookEvent, type CallStreamingFailedWebhookEvent as CallStreamingFailedWebhookEvent, type CallStreamingStartedWebhookEvent as CallStreamingStartedWebhookEvent, type CallStreamingStoppedWebhookEvent as CallStreamingStoppedWebhookEvent, type CampaignStatusUpdateWebhookEvent as CampaignStatusUpdateWebhookEvent, type ConferenceCreatedWebhookEvent as ConferenceCreatedWebhookEvent, type ConferenceEndedWebhookEvent as ConferenceEndedWebhookEvent, type ConferenceFloorChangedWebhookEvent as ConferenceFloorChangedWebhookEvent, type ConferenceParticipantJoinedWebhookEvent as ConferenceParticipantJoinedWebhookEvent, type ConferenceParticipantLeftWebhookEvent as ConferenceParticipantLeftWebhookEvent, type ConferenceParticipantPlaybackEndedWebhookEvent as ConferenceParticipantPlaybackEndedWebhookEvent, type ConferenceParticipantPlaybackStartedWebhookEvent as ConferenceParticipantPlaybackStartedWebhookEvent, type ConferenceParticipantSpeakEndedWebhookEvent as ConferenceParticipantSpeakEndedWebhookEvent, type ConferenceParticipantSpeakStartedWebhookEvent as ConferenceParticipantSpeakStartedWebhookEvent, type ConferencePlaybackEndedWebhookEvent as ConferencePlaybackEndedWebhookEvent, type ConferencePlaybackStartedWebhookEvent as ConferencePlaybackStartedWebhookEvent, type ConferenceRecordingSavedWebhookEvent as ConferenceRecordingSavedWebhookEvent, type ConferenceSpeakEndedWebhookEvent as ConferenceSpeakEndedWebhookEvent, type ConferenceSpeakStartedWebhookEvent as ConferenceSpeakStartedWebhookEvent, type DeliveryUpdateWebhookEvent as DeliveryUpdateWebhookEvent, type FaxDeliveredWebhookEvent as FaxDeliveredWebhookEvent, type FaxFailedWebhookEvent as FaxFailedWebhookEvent, type FaxMediaProcessedWebhookEvent as FaxMediaProcessedWebhookEvent, type FaxQueuedWebhookEvent as FaxQueuedWebhookEvent, type FaxSendingStartedWebhookEvent as FaxSendingStartedWebhookEvent, type InboundMessageWebhookEvent as InboundMessageWebhookEvent, type NumberOrderStatusUpdateWebhookEvent as NumberOrderStatusUpdateWebhookEvent, type ReplacedLinkClickWebhookEvent as ReplacedLinkClickWebhookEvent, type StreamingFailedWebhookEvent as StreamingFailedWebhookEvent, type StreamingStartedWebhookEvent as StreamingStartedWebhookEvent, type StreamingStoppedWebhookEvent as StreamingStoppedWebhookEvent, type TranscriptionWebhookEvent as TranscriptionWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
+}
+//# sourceMappingURL=webhooks.d.mts.map