sendMessage( )


Sends a message to the business or participant.

Specify the message type in message.content by including the appropriate object: basic, template, minimal, or form. For more information on message types and how each type renders in Inbox and the Chat widget, see Message Types.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Inbox Messages
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
conversationIdstringRequired

ID of the conversation to add the message to.


messageMessageRequired

Message to send.


optionsSendMessageOptions

Additional options for sending a message.

Returns
Return Type:Promise<SendMessageResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?