Extending The Widget For Lead Routing

  • Written by
    askavenue
  • Updated: June 11th 2018

The askavenue Chat Widget includes additional options to allow your chat widget to not only load on every page on your website, but to customize it so only specific Agents or where only a single Agent can receive chats.

To send a chat to a specific agent, the Agent ID must be passed to data-agent-id in the widget code. the Agent ID can be imported when inviting agents to your account. Alternatively, our system will generate an Agent ID for each agent if one is not supplied. The Agent ID must then be passed in your widget code on the page(s) you want to chats sent to that agent.

eg. data-agent-id=”[agent id]”

These options can be extended by passing custom parameters in the Javascript code.

A sample Javascript Widget Code block looks like this.

<script type="text/javascript" id="widget_loader" data-account-id="[your-account-id]" src="https://apiv2.askavenue.com/chat.js" data-agent-id="123" ></script>

data-agent-id=”123″ is optional and should only be passed when you want chats to only go to the agent with Agent ID = 123.

Configuration

Name Default Description

data-account-id

 Assigned This is your unique identifier assigned to you by askavenue. If set, all active Agents added to your Account will receive a question.

data-agent-id

 Blank This is the Agent’s unique identifier (ID). If set, only the Agent with the specified ID will receive the broadcast question. This is used for direct agent messaging and bypasses all other broadcast rules. Note: all other options are ignored if this value is set. Only letters and numbers are accepted.

data-max-agents

 5 This is the maximum number (quantity) of Agents who will receive a broadcast question. If set and agent_id is blank, only the entered quantity will receive the question. If left blank, up to 5 Active Agents in the Company will receive the question. If set, must be greater than 0.

data-radius

 5 This is the proximity to which the question will broadcast to in Kilometers. If set, the question is broadcast to the set distance in kilometers from [latitude] and [longitude] values defined. For example, if set to 5 then the question will broadcast to all Agents in the Company within 5 kms of [latitude] and [longitude]. This is ignored if latitude and latitude are not set. If set, must be between 1 and 500.

data-latitude

 Blank This is the latitude coordinate based on where the question will broadcast to. Required if radius_limit is set. This is ignored if data-radius is not set. If set, must be between -90 and 90.

data-longitude

 Blank This is the longitude coordinate based on where the question will broadcast to. Required if radius_limit is set. This is ignored if data-radius is not set.  If set, must be between -180 and 180.

 

Installing AskAvenue , Getting Started , FAQs , Developer Docs
1 Star2 Stars (+4 rating, 2 votes)
Loading...