Create Outbound IVR

POST

/v1/outbound-ivr

Starts an Outbound IVR call and plays an audio file (or used Text To Speech).
Fires a webhook request to webhookUrl after the call terminates.

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,
    "TtsText": "Dear Customer, to confirm your appointment please press 1, to cancel please press 32.",
    "TtsVoice": "Female",
    "WelcomeMessageFileUrl": null,
    "SuccessMessageFileUrl": null,
    "FailedMessageFileUrl": null,
    "Options": [
        {
            "Digit": "1",
            "Description": "Confirm"
        },
        {
            "Digit": "3",
            "Description": "Cancel"
        }
    ],
    "WebhookUrl": "https://webhook.site/2512f5b3-f389-4338-89dd-c9903bb5120a",
    "MaxAudioRetries": 3,
    "InputTimeoutMs": 6000,
    "DigitTimeoutMs": 3000
}'

Response Example

500 - Example 1

{}

Modified at 2025-11-30 21:22:03

Upload Audio File

Get Workspace Users