API
  Overview
  Step by step
  Example
  Functions

 

   Home > API
[ Print ]
 

Welcome Developers!

Overview

Library functions for eTalkup web users. You can use this library to create a charming web panel on your website. Enjoy it.

  • source: SDK.js
  • desc: Copyright © 2008 eTalkup DigiBell

Step by step

  • Copy the script from SDK to your pages

    This script afford an object "panelSDK" which is the namespace of all of the functions.

  • Use the object

    In this example, we will use two functions of panelSDK. You can find the details in Functions

    1. panelSDK.getStatusOfWorkgroup(), which returns a digit that shows whether the operators of your     company is online.

    2. panelSDK.startChatWithWorkgroup(), Use this function to start a chat.

Example

This example shows how to change image based on online status of the operators.



Functions

panelSDK.getStatusOfWorkgroup()

  • function:Get online/offline status of the company
  • returns:1:online,0:offline,-1: Company not found

panelSDK.getStatusOfQueue(string queueName)

  • function:Get online/offline status of a queue (department)
  • parameters:The queue name
  • returns:1:online,0:offline,-1:queue not found

panelSDK.getStatusOfOperator(int operaterID)

  • function:Get online/offline status of a operator
  • parameters:The OperaterID
  • returns:1:online,0:offline,-1:operator not found

panelSDK.getOperatorIDByName(string operatorName)

  • function:Get an operator ID by name
  • parameters:The Operator's Name
  • returns:operatorID if succeed; -1:operator name does not exist

panelSDK.getQueueIDByName(string queueName)

  • function:Get queue ID by name
  • parameters:The queue name
  • returns:QueueID if succeed; -1:Queue name does not exits

panelSDK.getQueueIDByoperatorID(int operatorID)

  • function:Get operator's department(queue) ID
  • parameters:The operatorID
  • returns:QueueID if succeed; -1:operator not found in the queue

panelSDK.startChatWithWorkgroup()

  • function:Start chat with the company The system will automatically pickup the available operator in the company
  • returns:void

panelSDK.startChatWithQueue(string queueName)

  • function:Start chat with a specific department(queue) of the company. The system will automatically pickup the available operator in the queue
  • parameters:The queueName
  • returns:0: if succeed; -1: queue not found

panelSDK.startChatWithOperator(int operatorID)

  • function:Start chat with a specific operator
  • parameters:The operatorID
  • returns:0: if succeed; -1: operator not found

panelSDK.getQueueArray()

  • function:Get an array of all the queues of the company
  • returns:The queue object array, which is a hash map of the queue id and queue name

panelSDK.getUserArray()

  • function:Get the array of all the operators of the company
  • returns:The operator object array, which is a hash map of the operator id, operator name, and perator queue id

panelSDK.getUserByQueueIDArray()

  • function:Get the array of all operators in a specific department(queue)
  • returns:The operator object array, which is a hash map of the operator id, operator name, and operator queue id
About    |    Live Chat Features    |    Partnership & Affiliate Program    |    FAQ    |    Testimonials    |    Blog    |    Site Map
 
Copyright © 2007-2009 eTalkup Live Chat Software by DigiBell Inc.
All Rights Reserved. All trademarks are the property of their respective owners.  Privacy Policy   |   Terms of Use
 
email  Email | del.icio.us  Del.icio.us | digg  Digg | technorati  Technorati | reddit  Reddit | stumbleupon  StumbleUpon | facebook  Facebook | newsvine  Newsvine | tell-a-friend  Tell a friend
Links: Software Discount | Shopping Comparison | Bing Wallpaper