User state log
Retrieves user state log.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/statistics/userstate |
| Options | from, to, projects, users, of |
| Body | N/A |
| Response | |
| Body | User states, tab-separated, in .csv or .json format. |
Request
Resource parameters
Options
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your account name. (subdomain) |
| from | string | yes | First date of the time period to be searched. Format: yyyymmdd format. (e.g., from=20120301) |
| of | string | no | Output format. Possible values: – json (default) – tab – csv |
| projects | integer | no | Project(s) data are retrieved from. Multiple items can be separated with commas. (e.g: projects=53,64). |
| to | string | yes | Last date of the requested time period to be searched, in yyyymmdd format (e.g: from=20120331). |
| users | integer | no | Which user(s) data should be retrieved. If there are several items, they should be separated with commas. (e.g: users=13,14,15). |
| start | integer | no | Specifies the offset of the first record. Possible values: [0-9]+ |
| num | integer | no | Specifies the maximum number of records to be returned. Possible values: [0-9]+ |
| direction | string | no | Specifies the display order of response. Possible values: “ASC”, “DESC” |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| auxid | integer | Auxiliary codes connected with breaks from work. |
| duration | integer | Time spent in ‘state’. |
| name | integer | Name of the user. |
| numberid | integer | Record’s identifier for the caller. |
| prevstate | string | The status before the last status. |
| prevtime | integer | Timestamp when entering ‘prevstate’, in ‘YYYY-MM-DD hh:mm:ss’ format. |
| projectid | integer | Project identifier. |
| state | string | Last closed status. Possible values: – OFFLINE – UNAVAILABLE – AVAILABLE – PREWORK – WAITING4CALL – WAITING4RECALL – RINGING – CALL – HOLD – AFTERWORK – AUX |
| time | integer | Timestamp when entering ‘state’, in ‘YYYY-MM-DD hh:mm:ss’ format. |
| userid | integer | User identifier. |
| username | integer | User’s username. |
Example
List the states of Robert Green (userid=6) on 20.02.2013.
https://mycc.asp.virtual-call-center.eu/v2/statistics/userstate?from=20130220&to=20130220&users=6
Response body
{
"response": [
{
"userid": 6,
"prevstate": "OFFLINE",
"state": "UNAVAILABLE",
"prevtime": "2013-02-20 15:40:06",
"time": "2013-02-20 15:40:06",
"projectid": 0,
"numberid": 0,
"auxid": null,
"duration": 0,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "UNAVAILABLE",
"state": "AVAILABLE",
"prevtime": "2013-02-20 15:40:06",
"time": "2013-02-20 15:40:11",
"projectid": 0,
"numberid": 0,
"auxid": null,
"duration": 5.75,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "AVAILABLE",
"state": "AUX",
"prevtime": "2013-02-20 15:40:11",
"time": "2013-02-20 15:40:19",
"projectid": 1,
"numberid": 0,
"auxid": null,
"duration": 7.44,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "AUX",
"state": "AVAILABLE",
"prevtime": "2013-02-20 15:40:19",
"time": "2013-02-20 15:41:05",
"projectid": 1,
"numberid": 0,
"auxid": "lunch",
"duration": 46.4,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "AVAILABLE",
"state": "WAITING4CALL",
"prevtime": "2013-02-20 15:41:05",
"time": "2013-02-20 15:41:12",
"projectid": 1,
"numberid": 0,
"auxid": null,
"duration": 6.96,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "WAITING4CALL",
"state": "RINGING",
"prevtime": "2013-02-20 15:41:12",
"time": "2013-02-20 15:41:17",
"projectid": 1,
"numberid": 2,
"auxid": null,
"duration": 4.57,
"username": "green_op",
"name": "Robert Green"
},
{
"userid": 6,
"prevstate": "RINGING",
"state": "AFTERWORK",
"prevtime": "2013-02-20 15:41:17",
"time": "2013-02-20 15:41:25",
"projectid": 1,
"numberid": 2,
"auxid": null,
"duration": 7.88,
"username": "green_op",
"name": "Robert Green"
}
],
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.