sendMessage

// Types:
sendMessage: (payload: TeamTextMessagePayload | 
                       TeamRichMessagePayload | 
                       CustomerMessagePayload | 
                       DynamicComponentPayload) => Promise<void>;

// Example:
window.AE_SDK((thrownError, AE_SDK) => {
    AE_SDK.sendMessage({
        type: "TeamTextMessage", 
        message: "This is a Team message!",
        options: { senderName: "Team of Experts" }
    });
});

Sends a message to timeline. This function supports 4 different payloads:

1. Team Text Message - for a plain text message which will be sent from the expert to the customer.
2. Team Rich Message - for a pre-defined message component which will be sent from the expert to the customer.
3. Customer Message - for a plain text message which will be sent from the customer to the expert (either hidden or not), this message will initiate a session. If the user already has an ongoing session, then this method won't send the message.
4. Dynamic Component - for rendering a component message which will be sent from the expert to the customer.

Parameters

Name	Type	Description
payload	TeamTextMessagePayload or TeamRichMessagePayload or CustomerMessagePayload or DynamicComponentPayload	please specify the type and the payload fields respectively

TeamTextMessagePayload

Name	Type	Description
type	string	value = 'TeamTextMessage'
message	string	The message to send to the customer
options?	TimelineApiOptions	Options for sending

TeamRichMessagePayload

Name	Type	Description
type	string	value = 'TeamRichMessage'
messageType	string	The specific custom message type
content	any	Content of the message to the customer
options?	TimelineApiOptions	Options for sending

CustomerMessagePayload

Name	Type	Description	Default
type	string	value = 'CustomerMessage'	-----
message	string	The message to send to the expert	-----
hidden?	boolean	Rather the message would be hidden from customer's timeline	false

Customer Message can be used only if the customer is not in a session yet, meaning that this function can be called as the first message on the timeline, and not otherwise.

DynamicComponentPayload

Name	Type	Description
type	string	value = 'DynamicComponent'
url	boolean	The url of the dynamic component
item	string	The specific component type
content	any	Content of the message to the customer

TimelineApiOptions

Name	Type	Description
senderName?	string	custom sender name to present with that message