Outbound Call Trigger

Outbound Call Trigger API

The Outbound Call Trigger API is designed for IVR projects to initiate calls to customers.

Endpoint:
URL: https://{{baseUrl}}:22222/v2/call
HTTP Method: POST
Content Type: application/json

Here's an example of a request:

curl --location 'https://{{baseUrl}}:22222/v2/call' \
--header 'Content-Type: application/json' \
--header 'Project;' \
--data-raw '{
       "Project": "{{project_name}}",
    "ConversationId": "{{conversation_Id}}",
    "AccessToken": "{{token}}",
    "ScenarioPath": "{{scenario_path}}",
    "OrchestratorUrl": "{{orchestrator_url}}",
    "Tenant": "Default",
    "EndUser": {
        "Name": "John Doe",
        "Phone": "5xxxxxxxxx",
        "Email": "johndoe@xxx.com"
    },
    "Locale": "{{locale}}",
    "ScenarioInputParameters": [
        {
            "Name": "_DisplayNumber",
            "Value": "200"
        },
        {
            "Name": "_Destination",
            "Value": "{{DestinationNumber}}"
        },
        {
            "Name": "{{variable1}}",
            "Value": "{{value1}}"
        },
        {
            "Name": "{{variable2}}",
            "Value": "{{value2}"
        }
    ],
    "ResultDestination": "{{result_destination_address}}",
    "SendResultImmediately": false
}'

Expected Response:

The server responds with HTTP 200 and provides the UniqueId of the outbound call.

{
    "UniqueId": "{{unique_id}}"
}

The following parameters can be provided in the request body:

Get Call Results

Endpoint:
URL: https://{{baseUrl}}:22222/v2/callresult
HTTP Method: POST
Content Type: application/json

Here's an example of a request:

curl --location 'https://{{baseUrl}}:22222/v2/callresult' \
--header 'Content-Type: application/json' \
--data '{
    "UniqueIds": [
    "{{Unique_Id}}"
    ]
}'

Expected Response:

The server responds with HTTP 200 and provides the UniqueId of the outbound call.

{
    "CallResults": [
        {
            "UniqueId": "{{unique_Id}}",
            "CallRequestId": "",
            "CallState": "{{call_state}}"
        }
    ]
}

Possible Call States: