Table of Contents

Concierge Links

Lordell Updated by Lordell

Concierge Links lets developers control the behavior of the Concierge Chat window and link those behaviors to key words contained in your website. The API supports controlling the size of the chat, opening the chat window with predetermined text, and automatically submitting inquiries for a speedy and seamless user experience. 

Open Chat Window

When the Concierge chat window is collapsed, this command will open or expand the window to the default view. 

<a href="javascript:void(0)" onclick="window.capacityConcierge.open(‘CHAT BOX TEXT’)">HYPERLINK TEXT</a>

Close Chat Window

When the Concierge window is in its default view, this command will close or collapse the Concierge window. 

<a href="javascript:void(0)" onclick="window.capacityConcierge.close(‘CHAT BOX TEXT’)">EXAMPLE TEXT</a> 

Open Chat Window with Inquiry

This command will load the Concierge chat with whatever pre-defined text the user clicks on.

<a href="javascript:void(0)" onclick="window.capacityConcierge.load('CHAT BOX TEXT')">EXAMPLE TEXT</a>

Load Inquiry

This command loads prescribed text into the chat window.

<a href="javascript:void(0)" onclick="window.capacityConcierge.load('CHAT BOX TEXT')">Load Concierge with Hello</a>

Submit Inquiry

Use this command to load and submit an inquiry into the Capacity Concierge.

<a href="javascript:void(0)" onclick="window.capacityConcierge.submit()">EXAMPLE TEXT</a>

Ask 

The `ask` command opens the chat window, loads the inquiry text and submits the `inquiry`string to Concierge interface.

<a href="javascript:void(0)" onclick="window.capacityConcierge.ask('CHAT BOX TEXT')">EXAMPLE TEXT</a>

Clear Inquiry

The `clear` method removes the inquiry in the input field of the Concierge interface

If text was already loaded in the chat window, the developer can clear the text loaded so that the new inquiry can be submitted.  

<a href="javascript:void(0)" onclick="window.capacityConcierge.clear()">EXAMPLE TEXT</a>

is_open

The  is_open  boolean property indicates whether the Concierge chat window is expanded from its minimized state. This command is a check. It allows the developer to verify if the Concierge chat is open.

if (window.capacityConcierge.is_open) {

  window.capacityConcierge.load('CHAT BOX TEXT')

}

has_message 

The  has_message  boolean property indicates whether the input field of the Concierge interface is filled. This command is a check as well. It allows the developer to check to see if the concierge has already been loaded with text.

if (window.capacityConcierge.has_message) {

  window.capacityConcierge.submit()

}

How did we do?

Contact