Outbound APIs

The outbound API section deals with APIs on how to answer, close, reject, or schedule an Outbound Call.  This section contains the following APIs:

• Answer a call

• Reject a call

• Clos e a call

• Schedule a call

Here is a sample response of an Outbound API:

{
    "channel": "Cisco",
    "topic": "OutboundCall",
    "subtopic": "OutBoundCallStateChange",
    "data": {
        "source": "event",
        "call": {
            "ButtonStates": {
                "items": {
                    "DirectTransfer": "Enable",
                    "Consult": "Enable",
                    "Hold": "Enable",
                    "UpdateCallData": "Enable",
                    "Drop": "Enable",
                    "UpdateSchedule": "Enable"
                },
                "count": 6
            },
            "ActionsAllowed": {
                "items": {
                    "SetTRANSFER_SST": {
                        "VariableName": "DirectTransferCall",
                        "VariableType": 3,
                        "ButtonName": "DirectTransfer",
                        "VariableStructure": {
                            "CallID": "",
                            "MediaAddress": "",
                            "TOAddress": ""
                        }
                    },
                    "SetCONSULT_CALL": {
                        "VariableName": "ConsultCall",
                        "VariableType": 3,
                        "ButtonName": "Consult",
                        "VariableStructure": {
                            "CallID": "",
                            "MediaAddress": "",
                            "TOAddress": ""
                        }
                    },
                    "SetHOLD": {
                        "VariableName": "HoldCall",
                        "VariableType": 3,
                        "ButtonName": "Hold",
                        "VariableStructure": {
                            "CallID": "",
                            "MediaAddress": ""
                        }
                    },
                    "SetUPDATE_CALL_DATA": {
                        "VariableName": "UpdateCallData",
                        "ButtonName": "UpdateCallData",
                        "VariableType": 3,
                        "VariableStructure": {
                            "callID": "",
                            "label": ""
                        }
                    },
                    "SetDROP": {
                        "VariableName": "DropCall",
                        "ButtonName": "Drop",
                        "VariableType": 3,
                        "VariableStructure": {
                            "CallID": "",
                            "MediaAddress": ""
                        }
                    },
                    "SetUPDATE_SCHEDULED_CALLBACK": {
                        "VariableName": "UpdateSchedule",
                        "ButtonName": "UpdateSchedule",
                        "VariableType": 3,
                        "VariableStructure": {
                            "callID": "",
                            "extn": ""
                        }
                    }
                },
                "count": 6
            },
            "ResponseType": 0,
            "ResponseText": "Success",
            "ResponseActual": {
                "dialog": {
                    "associatedDialogUri": "/finesse/api/Dialog/2130706631",
                    "fromAddress": "5068",
                    "id": "16786700",
                    "mediaProperties": {
                        "DNIS": "5068",
                        "callType": "OUTBOUND",
                        "dialedNumber": "961084713",
                        "callvariables": {},
                        "eccvariables": {},
                        "queueNumber": "5620",
                        "queueName": "arul1",
                        "callKeyCallId": "3",
                        "callKeyPrefix": "152995",
                        "callKeySequenceNum": "1"
                    },
                    "mediaType": "Voice",
                    "participants": {
                        "participant": [
                            {
                                "actions": [
                                    "TRANSFER_SST",
                                    "CONSULT_CALL",
                                    "HOLD",
                                    "UPDATE_CALL_DATA",
                                    "SEND_DTMF",
                                    "DROP",
                                    "UPDATE_SCHEDULED_CALLBACK"
                                ],
                                "mediaAddress": "5068",
                                "mediaAddressType": "AGENT_DEVICE",
                                "startTime": "2019-11-21T06: 39: 34.188Z",
                                "state": "ACTIVE",
                                "stateChangeTime": "2019-11-21T06: 39: 34.188Z"
                            },
                            {
                                "actions": [
                                    "TRANSFER_SST",
                                    "CONSULT_CALL",
                                    "HOLD",
                                    "UPDATE_CALL_DATA",
                                    "SEND_DTMF",
                                    "DROP",
                                    "UPDATE_SCHEDULED_CALLBACK"
                                ],
                                "mediaAddress": "961084713",
                                "startTime": "2019-11-21T06:39:34.188Z",
                                "state": "ACTIVE",
                                "stateChangeTime": "2019-11-21T06:39:34.188Z"
                            }
                        ]
                    },
                    "state": "ACTIVE",
                    "toAddress": "961084713",
                    "uri": "/finesse/api/Dialog/16786700",
                    "CallState": "ACTIVE",
                    "CallStateChangeTime": "2019-11-21T06:39:34.188Z",
                    "Type": "outbound"
                },
                "user": {
                    "extension": "5068",
                    "password": "12345",
                    "username": "311640960"
                }
            },
            "CallVariables": {
                "callVariable1": "",
                "callVariable2": "",
                "callVariable3": "",
                "callVariable4": "",
                "callVariable5": "",
                "callVariable6": "",
                "callVariable7": "",
                "callVariable8": "",
                "callVariable9": "",
                "callVariable10": "",
                "BACampaign": "arul1",
                "BAStatus": "PREVIEW_OUTBOUND",
                "BAResponse": "CPA_Voice",
                "BAAccountNumber": "2|3|24|0|0|84|4",
                "BADialedListID": "1004",
                "BATimeZone": "+00330",
                "BABuddyName": "Henriques1,Charles1"
            },
            "ExtendedCallVariables": {},
            "ResponseFields": {
                "Participants": {
                    "participant": [
                        {
                            "actions": [
                                "TRANSFER_SST",
                                "CONSULT_CALL",
                                "HOLD",
                                "UPDATE_CALL_DATA",
                                "SEND_DTMF",
                                "DROP",
                                "UPDATE_SCHEDULED_CALLBACK"
                            ],
                            "mediaAddress": "5068",
                            "mediaAddressType": "AGENT_DEVICE",
                            "startTime": "2019-11-21T06: 39: 34.188Z",
                            "state": "ACTIVE",
                            "stateChangeTime": "2019-11-21T06: 39: 34.188Z"
                        },
                        {
                            "actions": [
                                "TRANSFER_SST",
                                "CONSULT_CALL",
                                "HOLD",
                                "UPDATE_CALL_DATA",
                                "SEND_DTMF",
                                "DROP",
                                "UPDATE_SCHEDULED_CALLBACK"
                            ],
                            "mediaAddress": "961084713",
                            "startTime": "2019-11-21T06: 39: 34.188Z",
                            "state": "ACTIVE",
                            "stateChangeTime": "2019-11-21T06: 39: 34.188Z"
                        }
                    ]
                },
                "MediaProperties": {
                    "DNIS": "5068",
                    "callType": "OUTBOUND",
                    "dialedNumber": "961084713",
                    "callvariables": {},
                    "eccvariables": {},
                    "queueNumber": "5620",
                    "queueName": "arul1",
                    "callKeyCallId": "3",
                    "callKeyPrefix": "152995",
                    "callKeySequenceNum": "1"
                },
                "fromAddress": "5068",
                "mediaType": "Voice",
                "toAddress": "961084713",
                "CallState": "ACTIVE",
                "Type": "outbound",
                "CallStateChangeTime": "2019-11-21T06: 39: 34.188Z",
                "Campaign": "arul1",
                "DN": "961084713"
            },
            "id": "16786700"
        },
        "event": "ACTIVE"
    }
}