Current Status

Author: Salman Pathan 197 views

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:

NodeM/OData type sizeValueDescription
methodMTextuserStatusUnique Command for JSON Request. (This method value cannot be changed)
apikeyMTexttest_orgUnique key assigned to an organisation. (API key will change per client organisation)
servicekeyMTextVoiceProcessUnique key map to the process. (This service key will change per client process)
loginidsMText[“rupesh.v@avhan.com”,”t est@avhan.com”],Jodo user login id
reqdatetimeMDateTime2018-11-12 14:00:05Date and Time of the request. (Date format: YYYY-MM-DD hh:mm:ss)

Output Parameters:

NodeValueDescription
methoduserStatusUnique Command for JSON Response
resdatetime2018-11-12 14:00:05Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss)
status001Refer the status parameter table
statusdescsuccessstatus parameter description
StatusdataJSON Array“currentstatus”:5,”currentstatusdesc”:”Talking”,”statusdesc”:”Succ ess”,”login”:”user8″,”status”:3
currentstatus55 1, 5, 2, 7
currentstatusdescTalkingAvailable, Talking, Manual, Wrap-up
duration10Duration 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

StatusStatus Description
1Ready
2Manual Call
3Preview Call
4ACD
5Talking
6Hold
7Wrapup
8Dialing
9Live Session
10Transfer