About This Guide
Prerequisites
API Versions
Create Deployments
showWhenOnline
showWhenOffline
addButtonEventHandler
startChat
startChatWithWindow
Corresponding Calls for Chat Buttons
Deployment API Code Sample
Use the startChatWithWindow method to request a chat from a button using the name of a window.
Requests a chat from the provided button using the provided window name. Available in API versions 28.0 and later.
void startChatWithWindow(String buttonId, String windowName, (optional) String userId, (optional) Boolean fallback)
| Name | Type | Description | Available Versions |
|---|---|---|---|
buttonId | String | The ID of the chat button for which to request a chat in a new window. | Available in API versions 28.0 and later. |
windowName | String | The name of the window. | Available in API versions 28.0 and later. |
(Optional) userId | String | The Salesforce user ID of the agent to whom to directly route chats from the button. | Available in API versions 29.0 and later |
(Optional) fallback | Boolean | Specifies whether to fall back to the button’s routing rules (true) or not (false) if the agent with the specified sfdcUserId is unavailable. | Available in API versions 29.0 and later |