Create Outbound IVR

POST

/v1/outbound-ivr

Starts an Outbound IVR call and plays an audio file or uses Text-to-Speech (TTS).
Fires a webhook request to webhookUrl after the call terminates.
AudioFileUrl Accept .wav directory, feel free to contact support for audio generation from text

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🔴500Internal Server Error

application/json

Bodyapplication/json

🟢200Success

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/outbound-ivr' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "ChannelId": "3a197b6e-xxxx-xxxx-xxxx-5c2bc394dccd",
    "ExternalId": "myUniqueId",
    "DestinationNumber": "9665xxxxxxxx",
    "AudioFileUrl": null,
    "WelcomeMessageFileUrl": null,
    "SuccessMessageFileUrl": null,
    "FailedMessageFileUrl": null,
    "Options": [
        {
            "Digit": "1",
            "Description": "Confirm",
            "ResponseMessageFileUrl": null
        },
        {
            "Digit": "3",
            "Description": "Cancel"
        }
    ],
    "WebhookUrl": "https://webhook.site/2512f5b3-f389-4338-89dd-c9903bb5120a",
    "MaxAudioRetries": 3,
    "InputTimeoutMs": 6000,
    "DigitTimeoutMs": 3000
}'

Response Example

500 - Example 1

{
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "channelId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "externalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "destinationNumber": "+9665xxxxxxx",
    "audioFileUrl": "https://xxxxxx.wav",
    "ttsText": "Dear Customer, to confirm your appointment please press 1, to cancel please press 2.",
    "ttsVoice": 1,
    "audioType": 2,
    "options": [
        {
            "digit": "1",
            "description": "Confirm"
        },
        {
            "digit": "2",
            "description": "Cancel"
        }
    ],
    "webhookUrl": "https://xxxxxxx",
    "maxAudioRetries": 3,
    "inputTimeoutMs": 6000,
    "digitTimeoutMs": 3000,
    "status": 0,
    "result": 0,
    "pressedDigit": null,
    "initiatedAt": null,
    "ringingAt": null,
    "answeredAt": null,
    "completedAt": null,
    "callId": null,
    "errorMessage": null,
    "hangupCause": null,
    "creationTime": "2025-11-13T04:16:49.646512+03:00"
}

Modified at 2026-08-03 11:55:12

Get Conversation

Tag a conversation