sendMessage( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Inbox Messages
Learn more about permission scopes.
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>
Was this helpful?
Yes
No