Current Status
Purpose:
Used to obtain real-time status of Jodo users.
Also, used to allocate data after check user status.
Use Case:
This API is used by CRM / Business Application to get real-time status of Jodo user.
It should be called before call disposition API.
Based on status, CRM / Business Application can take next action – push new data for processing / calling.
User Input Parameters:
| Node | M/O | Data type size | Value | Description |
|---|---|---|---|---|
| method | M | Text | userStatus | Unique Command for JSON Request. (This method value cannot be changed) |
| apikey | M | Text | test_org | Unique key assigned to an organisation. (API key will change per client organisation) |
| servicekey | M | Text | VoiceProcess | Unique key map to the process. (This service key will change per client process) |
| loginids | M | Text | [“rupesh.v@avhan.com”,”t est@avhan.com”], | Jodo user login id |
| reqdatetime | M | DateTime | 2018-11-12 14:00:05 | Date and Time of the request. (Date format: YYYY-MM-DD hh:mm:ss) |
Output Parameters:
| Node | Value | Description |
|---|---|---|
| method | userStatus | Unique Command for JSON Response |
| resdatetime | 2018-11-12 14:00:05 | Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss) |
| status | 001 | Refer the status parameter table |
| statusdesc | success | status parameter description |
| Statusdata | JSON Array | “currentstatus”:5,”currentstatusdesc”:”Talking”,”statusdesc”:”Succ ess”,”login”:”user8″,”status”:3 |
| currentstatus | 5 | 5 1, 5, 2, 7 |
| currentstatusdesc | Talking | Available, Talking, Manual, Wrap-up |
| duration | 10 | Duration in current status in seconds. |
Return Value:
This API returns in one format I.e. JSON format.
JSON Request
{
"method":"userStatus",
"apikey":"test_org",
"servicekey":"VoiceProcess",
"loginids":["rupesh.v@avhan.com","user10"],
"reqdatetime": "2017-11-20 10:00:05"
}
JSON Response
{ "statusdata":[
{"duration":100,"currentstatus":1,
"currentstatusdesc":"Ready",
"statuschangetime":"07-Mar-19 11:59:59 PM", "login":"user1","statusdesc":"Success","status":3}
{"duration":11,"currentstatus":11,
"currentstatusdesc":"System Sent NA",
"statuschangetime":"07-Mar-19 11:59:59 PM", "login":"user10","statusdesc":"Success","status":3}
],
"method":"userStatus",
"timestamp":"2019-03-08 11:53:02"
}
User Status Code Information
| Status | Status Description |
|---|---|
| 1 | Ready |
| 2 | Manual Call |
| 3 | Preview Call |
| 4 | ACD |
| 5 | Talking |
| 6 | Hold |
| 7 | Wrapup |
| 8 | Dialing |
| 9 | Live Session |
| 10 | Transfer |