send_chat_integration_event ¶

def send_chat_integration_event(
    self,
    source_id: "capo_connect.types.source_id.SourceId",
    destination_id: "capo_connect.types.destination_id.DestinationId",
    event: "capo_connect.types.chat_event.ChatEvent",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    subtype: Optional["capo_connect.types.subtype.Subtype"] = None,
    new_session_details: Optional[
        "capo_connect.types.new_session_details.NewSessionDetails"
    ] = None,
) -> "capo_connect.types.send_chat_integration_event_response.SendChatIntegrationEventResponse":
    """<p>Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. A chat integration event includes:</p> <ul> <li> <p>SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat</p> </li> <li> <p> ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat</p> </li> </ul> <p>When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. </p> <p>Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration. </p>

    Args:
        source_id: <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: <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: <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: <p>Chat integration event payload</p>
        new_session_details: <p>Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.send_chat_integration_event_request.SendChatIntegrationEventRequest]",
    ) -> OperationResponse[
        "capo_connect.types.send_chat_integration_event_response.SendChatIntegrationEventResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.send_chat_integration_event

        output, http_response = (
            capo_connect._operations.amazon_connect_service.send_chat_integration_event.send_chat_integration_event(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendChatIntegrationEvent")
    )
    input_: capo_connect.types.send_chat_integration_event_request.SendChatIntegrationEventRequest = {
        "source_id": source_id,
        "destination_id": destination_id,
        "event": event,
    }
    if subtype is not None:
        input_["subtype"] = subtype
    if new_session_details is not None:
        input_["new_session_details"] = new_session_details

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output