Skip to content

StartWebRTCContactResponse

Source code in docs_src/capo_connect/types/start_web_rtc_contact_response.py
class StartWebRTCContactResponse(TypedDict, closed=True):
    connection_data: NotRequired["capo_connect.types.connection_data.ConnectionData"]
    """<p>Information required for the client application (mobile application or website) to connect to the call.</p>"""
    contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The identifier of the contact in this instance of Connect Customer. </p>"""
    participant_id: NotRequired["capo_connect.types.participant_id.ParticipantId"]
    """<p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact participant is the same throughout the contact lifecycle.</p>"""
    participant_token: NotRequired[
        "capo_connect.types.participant_token.ParticipantToken"
    ]
    """<p>The token used by the contact participant to call the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a contact participant.</p>"""

connection_data instance-attribute

connection_data: NotRequired[ConnectionData]

Information required for the client application (mobile application or website) to connect to the call.

contact_id instance-attribute

contact_id: NotRequired[ContactId]

The identifier of the contact in this instance of Connect Customer.

participant_id instance-attribute

participant_id: NotRequired[ParticipantId]

The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.

participant_token instance-attribute

participant_token: NotRequired[ParticipantToken]

The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.