Skip to content

ConversationWebsocketMessage.md

Latest commit

 

History

History
90 lines (52 loc) · 3.58 KB

ConversationWebsocketMessage.md

File metadata and controls

90 lines (52 loc) · 3.58 KB

UltraCartRestApiV2.ConversationWebsocketMessage

Properties

Name Type Description Notes
conversation_arn String Conversation ARN [optional]
conversation_uuid String Conversation UUID if the websocket message is tied to a specific conversation [optional]
event_add_coupon ConversationEventAddCoupon [optional]
event_add_item ConversationEventAddItem [optional]
event_conversation_closed ConversationSummary [optional]
event_engage_customer ConversationWebchatQueueStatusQueueEntry [optional]
event_new_conversation ConversationSummary [optional]
event_new_message ConversationSummary [optional]
event_participant_join ConversationSummary [optional]
event_participant_join_participant ConversationParticipant [optional]
event_participant_left ConversationSummary [optional]
event_participant_left_participant ConversationParticipant [optional]
event_participant_update ConversationSummary [optional]
event_queue_new_member ConversationWebchatQueueStatusQueueEntry [optional]
event_queue_position ConversationEventQueuePosition [optional]
event_queue_status_update ConversationWebchatQueueStatus [optional]
event_read_message ConversationEventReadMessage [optional]
event_rrweb ConversationEventRRWeb [optional]
event_type String Type of event [optional]
event_typing ConversationEventTyping [optional]
event_updated_message ConversationMessage [optional]
event_webchat_context ConversationEventWebchatContext [optional]
message ConversationMessage [optional]
type String Type of message [optional]

Enum: EventTypeEnum

  • queue position (value: "queue position")

  • webchat start conversation (value: "webchat start conversation")

  • conversation closed (value: "conversation closed")

  • new conversation (value: "new conversation")

  • new message (value: "new message")

  • updated message (value: "updated message")

  • queue status update (value: "queue status update")

  • rrweb (value: "rrweb")

  • participant update (value: "participant update")

  • participant join (value: "participant join")

  • participant left (value: "participant left")

  • read message (value: "read message")

  • typing (value: "typing")

  • add coupon (value: "add coupon")

  • add item (value: "add item")

  • webchat context (value: "webchat context")

  • engage customer (value: "engage customer")

  • queue new member (value: "queue new member")

Enum: TypeEnum

  • message (value: "message")

  • event (value: "event")

  • ping (value: "ping")

  • check queue position (value: "check queue position")