Account Object description
This API Object can be used in order communicate with a CoBrowser.net Account. You are able to execute account specific functions, or receive account specific data.
Returns
A JSON encoded string. The resultset is returned in an object with the same name as the command.
Call Method
The Account object should be called as followes: https://client.cobrowser.net/api/Account.php?user=username&apiKey=apiKey&c=command [[Optional: &commandoption=commanvalue]]
Authentication
Use your username and apiKey for authentication as described in Call Method.
- In order to use the API, your account must be setup with an API Key. Please use this form to request one.
- API calls are only accepted using https (SSL) connections.
Available Commands
The following commands are available for this API Object.
| Command |
Description & Fields |
Options |
Returns |
| getOnlineAgents |
Receive a list of all agents that are currently signed in. This function also includes agents that have an 'Offline' status. |
- none |
List with agents, each agents has the following parameters:
- id
- name (last name)
- firstname
- username (without account postfix)
- status (current status offline/online)
- lastactive (UNIX FORMATTED timestamp of last activity)
- slot_num (number of possible simultaneous conversations)
- hasFree (1/0 does the agent has free slots?)
- numFree (number of free slots)
-
numOpen (number of chats that are currently open)
-
numClosed (number of chats that are currently closed or offline)
-
avgOpenDuration (average duration current slots are open)
-
avgClosedDuration (average duration current slots are closed or offline)
-
avgNewDuration (average duration current slots are new)
-
avgBurningDuration (average duration current slots are burning)
-
avgSleepingDuration (average duration current slots are sleeping)
-
minOpenDuration (minimal duration current slots are open)
-
minClosedDuration (minimal duration current slots are closed or offline)
-
minNewDuration (minimal duration current slots are new)
-
minBurningDuration (minimal duration current slots are burning)
-
minSleepingDuration (minimal duration current slots are sleeping)
-
maxOpenDuration (maximum duration current slots are open)
-
maxClosedDuration (maximum duration current slots are closed)
-
maxNewDuration (maximum duration current slots are new)
-
maxBurningDuration (maximum duration current slots are burning)
-
maxSleepingDuration (maximum duration current slots are sleeping)
|
| getAllAgents |
Receive a list of all agents within this account. |
- none |
List with agents, each agents has the following parameters:
- id
- name (last name)
- firstname
- username (without account postfix)
- status (current status offline/online)
- lastactive (UNIX FORMATTED timestamp of last activity)
- slot_num (number of possible simultaneous conversations)
- hasFree (1/0 does the agent has free slots?)
- numFree (number of free slots)
- numOpen (number of chats that are currently open)
- numClosed (number of chats that are currently closed or offline)
- avgOpenDuration (average duration current slots are open)
- avgClosedDuration (average duration current slots are closed or offline)
- avgNewDuration (average duration current slots are new)
- avgBurningDuration (average duration current slots are burning)
- avgSleepingDuration (average duration current slots are sleeping)
- minOpenDuration (minimal duration current slots are open)
- minClosedDuration (minimal duration current slots are closed or offline)
- minNewDuration (minimal duration current slots are new)
- minBurningDuration (minimal duration current slots are burning)
- minSleepingDuration (minimal duration current slots are sleeping)
- maxOpenDuration (maximum duration current slots are open)
- maxClosedDuration (maximum duration current slots are closed)
- maxNewDuration (maximum duration current slots are new)
- maxBurningDuration (maximum duration current slots are burning)
- maxSleepingDuration (maximum duration current slots are sleeping)
|
Comments
0 comments
Article is closed for comments.