telnyx 3.0.0a0__py3-none-any.whl → 3.1.0__py3-none-any.whl

telnyx/types/call_hangup_webhook_event.py

@@ -0,0 +1,150 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .sip_header import SipHeader
+from .custom_sip_header import CustomSipHeader
+
+__all__ = [
+    "CallHangupWebhookEvent",
+    "Data",
+    "DataPayload",
+    "DataPayloadCallQualityStats",
+    "DataPayloadCallQualityStatsInbound",
+    "DataPayloadCallQualityStatsOutbound",
+]
+
+
+class DataPayloadCallQualityStatsInbound(BaseModel):
+    jitter_max_variance: Optional[str] = None
+    """Maximum jitter variance for inbound audio."""
+
+    jitter_packet_count: Optional[str] = None
+    """Number of packets used for jitter calculation on inbound audio."""
+
+    mos: Optional[str] = None
+    """Mean Opinion Score (MOS) for inbound audio quality."""
+
+    packet_count: Optional[str] = None
+    """Total number of inbound audio packets."""
+
+    skip_packet_count: Optional[str] = None
+    """Number of skipped inbound packets (packet loss)."""
+
+
+class DataPayloadCallQualityStatsOutbound(BaseModel):
+    packet_count: Optional[str] = None
+    """Total number of outbound audio packets."""
+
+    skip_packet_count: Optional[str] = None
+    """Number of skipped outbound packets (packet loss)."""
+
+
+class DataPayloadCallQualityStats(BaseModel):
+    inbound: Optional[DataPayloadCallQualityStatsInbound] = None
+    """Inbound call quality statistics."""
+
+    outbound: Optional[DataPayloadCallQualityStatsOutbound] = None
+    """Outbound call quality statistics."""
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_quality_stats: Optional[DataPayloadCallQualityStats] = None
+    """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_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    custom_headers: Optional[List[CustomSipHeader]] = None
+    """Custom headers set on answer command"""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    hangup_cause: Optional[
+        Literal[
+            "call_rejected",
+            "normal_clearing",
+            "originator_cancel",
+            "timeout",
+            "time_limit",
+            "user_busy",
+            "not_found",
+            "unspecified",
+        ]
+    ] = None
+    """
+    The reason the call was ended (`call_rejected`, `normal_clearing`,
+    `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or
+    `unspecified`).
+    """
+
+    hangup_source: Optional[Literal["caller", "callee", "unknown"]] = None
+    """The party who ended the call (`callee`, `caller`, `unknown`)."""
+
+    sip_hangup_cause: Optional[str] = None
+    """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_headers: Optional[List[SipHeader]] = None
+    """User-to-User and Diversion headers from sip invite."""
+
+    start_time: Optional[datetime] = None
+    """ISO 8601 datetime of when the call started."""
+
+    state: Optional[Literal["hangup"]] = None
+    """State received from a command."""
+
+    tags: Optional[List[str]] = None
+    """Array of tags associated to number."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.hangup"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallHangupWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_initiated_webhook_event.py

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .sip_header import SipHeader
+from .custom_sip_header import CustomSipHeader
+
+__all__ = ["CallInitiatedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_screening_result: Optional[str] = None
+    """Call screening result."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    caller_id_name: Optional[str] = None
+    """Caller id."""
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_codecs: Optional[str] = None
+    """The list of comma-separated codecs enabled for the connection."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    custom_headers: Optional[List[CustomSipHeader]] = None
+    """Custom headers from sip invite"""
+
+    direction: Optional[Literal["incoming", "outgoing"]] = None
+    """Whether the call is `incoming` or `outgoing`."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    offered_codecs: Optional[str] = None
+    """The list of comma-separated codecs offered by caller."""
+
+    shaken_stir_attestation: Optional[str] = None
+    """SHAKEN/STIR attestation level."""
+
+    shaken_stir_validated: Optional[bool] = None
+    """Whether attestation was successfully validated or not."""
+
+    sip_headers: Optional[List[SipHeader]] = None
+    """User-to-User and Diversion headers from sip invite."""
+
+    start_time: Optional[datetime] = None
+    """ISO 8601 datetime of when the call started."""
+
+    state: Optional[Literal["parked", "bridging"]] = None
+    """State received from a command."""
+
+    tags: Optional[List[str]] = None
+    """Array of tags associated to number."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.initiated"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallInitiatedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_left_queue_webhook_event.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["CallLeftQueueWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    queue: Optional[str] = None
+    """The name of the queue"""
+
+    queue_position: Optional[int] = None
+    """Last position of the call in the queue."""
+
+    reason: Optional[Literal["bridged", "bridging-in-process", "hangup", "leave", "timeout"]] = None
+    """The reason for leaving the queue"""
+
+    wait_time_secs: Optional[int] = None
+    """Time call spent in the queue in seconds."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.dequeued"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallLeftQueueWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_machine_detection_ended_webhook_event.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallMachineDetectionEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    result: Optional[Literal["human", "machine", "not_sure"]] = None
+    """Answering machine detection result."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.machine.detection.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallMachineDetectionEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_machine_greeting_ended_webhook_event.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallMachineGreetingEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    result: Optional[Literal["beep_detected", "ended", "not_sure"]] = None
+    """Answering machine greeting ended result."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.machine.greeting.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallMachineGreetingEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_machine_premium_detection_ended_webhook_event.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallMachinePremiumDetectionEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    result: Optional[Literal["human_residence", "human_business", "machine", "silence", "fax_detected", "not_sure"]] = (
+        None
+    )
+    """Premium Answering Machine Detection result."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.machine.premium.detection.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallMachinePremiumDetectionEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_machine_premium_greeting_ended_webhook_event.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CallMachinePremiumGreetingEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    from_: Optional[str] = FieldInfo(alias="from", default=None)
+    """Number or SIP URI placing the call."""
+
+    result: Optional[Literal["beep_detected", "no_beep_detected"]] = None
+    """Premium Answering Machine Greeting Ended result."""
+
+    to: Optional[str] = None
+    """Destination number or SIP URI of the call."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.machine.premium.greeting.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallMachinePremiumGreetingEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_playback_ended_webhook_event.py

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["CallPlaybackEndedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    overlay: Optional[bool] = None
+    """Whether the stopped audio was in overlay mode or not."""
+
+    status: Optional[
+        Literal["file_not_found", "call_hangup", "unknown", "cancelled", "cancelled_amd", "completed", "failed"]
+    ] = None
+    """Reflects how command ended."""
+
+    status_detail: Optional[str] = None
+    """Provides details in case of failure."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.playback.ended"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallPlaybackEndedWebhookEvent(BaseModel):
+    data: Optional[Data] = None

telnyx/types/call_playback_started_webhook_event.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["CallPlaybackStartedWebhookEvent", "Data", "DataPayload"]
+
+
+class DataPayload(BaseModel):
+    call_control_id: Optional[str] = None
+    """Call ID used to issue commands via Call Control API."""
+
+    call_leg_id: Optional[str] = None
+    """ID that is unique to the call and can be used to correlate webhook events."""
+
+    call_session_id: Optional[str] = None
+    """
+    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.
+    """
+
+    client_state: Optional[str] = None
+    """State received from a command."""
+
+    connection_id: Optional[str] = None
+    """Call Control App ID (formerly Telnyx connection ID) used in the call."""
+
+    media_name: Optional[str] = None
+    """
+    The name of the audio media file being played back, if media_name has been used
+    to start.
+    """
+
+    media_url: Optional[str] = None
+    """The audio URL being played back, if audio_url has been used to start."""
+
+    overlay: Optional[bool] = None
+    """Whether the audio is going to be played in overlay mode or not."""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the type of resource."""
+
+    event_type: Optional[Literal["call.playback.started"]] = None
+    """The type of event being delivered."""
+
+    occurred_at: Optional[datetime] = None
+    """ISO 8601 datetime of when the event occurred."""
+
+    payload: Optional[DataPayload] = None
+
+    record_type: Optional[Literal["event"]] = None
+    """Identifies the type of the resource."""
+
+
+class CallPlaybackStartedWebhookEvent(BaseModel):
+    data: Optional[Data] = None