Skip to content

ProxySession

Source code in docs_src/capo_chime_sdk_voice/types/proxy_session.py
class ProxySession(TypedDict, closed=True):
    voice_connector_id: NotRequired[
        "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId"
    ]
    """<p>The Voice Connector ID.</p>"""
    proxy_session_id: NotRequired[
        "capo_chime_sdk_voice.types.non_empty_string128.NonEmptyString128"
    ]
    """<p>The proxy session ID.</p>"""
    name: NotRequired["capo_chime_sdk_voice.types.string128.String128"]
    """<p>The proxy session name.</p>"""
    status: NotRequired[
        "capo_chime_sdk_voice.types.proxy_session_status.ProxySessionStatus"
    ]
    """<p>The proxy session status.</p>"""
    expiry_minutes: NotRequired[
        "capo_chime_sdk_voice.types.positive_integer.PositiveInteger"
    ]
    """<p>The number of minutes allowed for the proxy session.</p>"""
    capabilities: NotRequired[
        "capo_chime_sdk_voice.types.capability_list.CapabilityList"
    ]
    """<p>The proxy session capabilities.</p>"""
    created_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The created time stamp, in ISO 8601 format.</p>"""
    updated_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The updated time stamp, in ISO 8601 format.</p>"""
    ended_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The ended time stamp, in ISO 8601 format.</p>"""
    participants: NotRequired["capo_chime_sdk_voice.types.participants.Participants"]
    """<p>The proxy session participants.</p>"""
    number_selection_behavior: NotRequired[
        "capo_chime_sdk_voice.types.number_selection_behavior.NumberSelectionBehavior"
    ]
    """<p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>"""
    geo_match_level: NotRequired[
        "capo_chime_sdk_voice.types.geo_match_level.GeoMatchLevel"
    ]
    """<p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>"""
    geo_match_params: NotRequired[
        "capo_chime_sdk_voice.types.geo_match_params.GeoMatchParams"
    ]
    """<p>The country and area code for the proxy phone number.</p>"""

capabilities instance-attribute

capabilities: NotRequired[CapabilityList]

The proxy session capabilities.

created_timestamp instance-attribute

created_timestamp: NotRequired[Iso8601Timestamp]

The created time stamp, in ISO 8601 format.

ended_timestamp instance-attribute

ended_timestamp: NotRequired[Iso8601Timestamp]

The ended time stamp, in ISO 8601 format.

expiry_minutes instance-attribute

expiry_minutes: NotRequired[PositiveInteger]

The number of minutes allowed for the proxy session.

geo_match_level instance-attribute

geo_match_level: NotRequired[GeoMatchLevel]

The preference for matching the country or area code of the proxy phone number with that of the first participant.

geo_match_params instance-attribute

geo_match_params: NotRequired[GeoMatchParams]

The country and area code for the proxy phone number.

name instance-attribute

name: NotRequired[String128]

The proxy session name.

number_selection_behavior instance-attribute

number_selection_behavior: NotRequired[NumberSelectionBehavior]

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

participants instance-attribute

participants: NotRequired[Participants]

The proxy session participants.

proxy_session_id instance-attribute

proxy_session_id: NotRequired[NonEmptyString128]

The proxy session ID.

status instance-attribute

status: NotRequired[ProxySessionStatus]

The proxy session status.

updated_timestamp instance-attribute

updated_timestamp: NotRequired[Iso8601Timestamp]

The updated time stamp, in ISO 8601 format.

voice_connector_id instance-attribute

voice_connector_id: NotRequired[VoiceConnectorId]

The Voice Connector ID.