Disposition Module

Author: Salman Pathan 237 views

Call Disposition request

At the end of the media session, a disposition status is set in business workflow / application to select and action next-steps in business operations. This also helps in analysing business operations.

Purpose:

This function is used to dispose call / session

Use Case:

CRM / Business Applications to call Disposition API to set disposition at the end event of a media session & save selected disposition details in Jodo.
After this, Jodo will execute actions assigned to disposition value in Jodo such as – send SMS confirmation or email notification or schedule a future appointment time / call back & change user status to ‘ready’ for next media session.

User Input Parameters:

NodeM/OData type sizeValueDescription
methodMTextsaveDispositionUnique Command for JSON Request. (This method value cannot be changed)
apikeyMTexttest_orgUnique key assigned to an organization. (API key will change per client organisation)
servicekeyMTextVoiceProcessUnique key assigned to a process. (Service key will change per client process)
Uniquesystemcallid345345336546456Unique System call ID for current Media Communication
dispomasteridMNumerical11Unique Disposition Master ID
disporeasonidMNumerical15Unique Disposition Reason ID
remarksTextTest RemarkRemarks for disposition
selecteddatetimeTextNext Call-back Time Blank for Normal Calls (Date format: YYYY-MM-DD hh:mm:ss)
contactvalueText9800100200Call back Contact Number
mediaMTextVoice InEmail In (Incoming / received email) Email Out (Outgoing / Sent email) SMS In (Incoming / received SMS) SMS Out (Outgoing / Sent SMS) Chat (Website / messenger Chat conversation) Voice In (Incoming / received Voice Call / session) Voice Out (outgoing / Sent Voice call / session) Social Media – Twitter channel Social Media -Facebook channel Video

Output Parameters:

NodeValueDescription
methodsaveDispositionUnique Command for JSON Response
requestid51Unique requestid
resdatetime2018-11-12 14:00:05Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss)
status3Refer the status parameter table
statusdescsuccessstatus parameter description

Return Value:

This API returns in one format I.e., JSON format.

Generated report JSON Request

Return Value: This API returns response in JSON format.

Report request JSON Request

				
					{
 "method":"saveDisposition",
"login":"dinesh.s@avhan.com",
 "apikey":"test_org",
"servicekey":"VoiceProcess",
"dispomasterid":1,
"disporeasonid":1,
"remarks":"This is testing remarks",
 "selecteddatetime":"2018-11-01 17:00:00",
"contactvalue":"9874561320",
"media": “Voice In”,
"reqdatetime":"2018-11-01 17:00:00",
}
				
			

Request JSON Response

				
					{
"method":"saveDisposition",
 "statusdesc":"success",
"status":3,
"resdatetime":"2018-11-01 17:00:00"
 }
				
			

Report request JSON Fail Response

				
					{
"method":"savedisposition",
"reasonid":31,
"statusdesc":"fail",
 "status":4,
 "resdatetime":"2018-11-01 17:00:00"
}
				
			

Status codes :

StatusStatus Description
3Successful
4Login not found
6Wrong Status mode [Status should be wrapup]
7Wrong date format
8Date not in range(min and max date value configured from db)
31Disposition Master ID / Reason Id not found
32Contact Number In DNC
33Callback count exceed for process
111Error while processing
421Invalid Process Id