Skip to content

SendChatIntegrationEventRequest

Source code in docs_src/capo_connect/types/send_chat_integration_event_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class SendChatIntegrationEventRequest(TypedDict, closed=True):
    source_id: "capo_connect.types.source_id.SourceId"
    """<p>External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.</p>"""
    destination_id: "capo_connect.types.destination_id.DestinationId"
    """<p>Chat system identifier, used in part to uniquely identify chat. This is associated with the Connect Customer instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</p>"""
    subtype: NotRequired["capo_connect.types.subtype.Subtype"]
    """<p>Classification of a channel. This is used in part to uniquely identify chat. </p> <p>Valid value: <code>["connect:sms", connect:"WhatsApp"]</code> </p>"""
    event: "capo_connect.types.chat_event.ChatEvent"
    """<p>Chat integration event payload</p>"""
    new_session_details: NotRequired[
        "capo_connect.types.new_session_details.NewSessionDetails"
    ]
    """<p>Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.</p>"""

destination_id instance-attribute 

destination_id: DestinationId

Chat system identifier, used in part to uniquely identify chat. This is associated with the Connect Customer instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.

event instance-attribute 

event: ChatEvent

Chat integration event payload

new_session_details instance-attribute 

new_session_details: NotRequired[NewSessionDetails]

Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

source_id instance-attribute 

source_id: SourceId

External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

subtype instance-attribute 

subtype: NotRequired[Subtype]

Classification of a channel. This is used in part to uniquely identify chat.

Valid value: ["connect:sms", connect:"WhatsApp"]