Disposition Module
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:
| Node | M/O | Data type size | Value | Description |
|---|---|---|---|---|
| method | M | Text | saveDisposition | Unique Command for JSON Request. (This method value cannot be changed) |
| apikey | M | Text | test_org | Unique key assigned to an organization. (API key will change per client organisation) |
| servicekey | M | Text | VoiceProcess | Unique key assigned to a process. (Service key will change per client process) |
| Uniquesystemcallid | 345345336546456 | Unique System call ID for current Media Communication | ||
| dispomasterid | M | Numerical | 11 | Unique Disposition Master ID |
| disporeasonid | M | Numerical | 15 | Unique Disposition Reason ID |
| remarks | Text | Test Remark | Remarks for disposition | |
| selecteddatetime | Text | Next Call-back Time Blank for Normal Calls (Date format: YYYY-MM-DD hh:mm:ss) | ||
| contactvalue | Text | 9800100200 | Call back Contact Number | |
| media | M | Text | Voice In | Email 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:
| Node | Value | Description |
|---|---|---|
| method | saveDisposition | Unique Command for JSON Response |
| requestid | 51 | Unique requestid |
| resdatetime | 2018-11-12 14:00:05 | Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss) |
| status | 3 | Refer the status parameter table |
| statusdesc | success | status 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 :
| Status | Status Description |
|---|---|
| 3 | Successful |
| 4 | Login not found |
| 6 | Wrong Status mode [Status should be wrapup] |
| 7 | Wrong date format |
| 8 | Date not in range(min and max date value configured from db) |
| 31 | Disposition Master ID / Reason Id not found |
| 32 | Contact Number In DNC |
| 33 | Callback count exceed for process |
| 111 | Error while processing |
| 421 | Invalid Process Id |