Live Agent Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

startChat

Use the startChat method to request a chat from a button in a new window.

Usage

Requests a chat from the provided button in a new window.

Optionally, you can route chats from a specific button directly to the agent with the userId you specify. If the agent you specify is unavailable, you can specify whether to fall back to the button’s routing rules (true) or not (false).

Syntax

void startChat(String buttonId, (optional) String userId, (optional) Boolean fallback)

Parameters

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.
(Optional) userId String The Salesforce.com 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.