send_chat_integration_event
async
¶
send_chat_integration_event(
source_id: SourceId,
destination_id: DestinationId,
event: ChatEvent,
*,
config_overrides: Optional[AsyncConnectClientConfig] = None,
subtype: Optional[Subtype] = None,
new_session_details: Optional[NewSessionDetails] = None,
) -> SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. A chat integration event includes:
-
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
-
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
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.
Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration.
Parameters:
-
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.
-
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.
-
subtype(Optional[Subtype], default:None) –Classification of a channel. This is used in part to uniquely identify chat.
Valid value:
["connect:sms", connect:"WhatsApp"] -
event(ChatEvent) –Chat integration event payload
-
new_session_details(Optional[NewSessionDetails], default:None) –Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.
Raises:
-
AccessDeniedException–You do not have sufficient permissions to perform this action.
-
InternalServiceException–Request processing failed because of an error or failure with the service.
-
InvalidRequestException–The request is not valid.
-
ResourceNotFoundException–The specified resource was not found.
-
ThrottlingException–The throttling limit has been exceeded.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_connect/_services/async_connect.py
22877 22878 22879 22880 22881 22882 22883 22884 22885 22886 22887 22888 22889 22890 22891 22892 22893 22894 22895 22896 22897 22898 22899 22900 22901 22902 22903 22904 22905 22906 22907 22908 22909 22910 22911 22912 22913 22914 22915 22916 22917 22918 22919 22920 22921 22922 22923 22924 22925 22926 22927 22928 22929 22930 22931 22932 22933 22934 22935 22936 22937 22938 22939 22940 22941 | |