Skip to main content
flag
Mon - Fri   10:00 – 18:00

TTS request failed webhook

API Documentation / Voice Broadcast / TTS request failed webhook

Base URL for your account: https://cpaas.studio

POST https://your-server.example/your-webhook (we call you)

Sent once to the webhook_url of a Voice Broadcast with Text to Speech request when the whole request fails while preparing (for example text to speech failed for every message), so no broadcast and no calls were made. It is the same failure Broadcast with TTS Status reports.

Signed like every webhook — see Verifying webhook signatures.

Parameters

Param Type Required Notes
event string yes Always voice.broadcast.tts.failed.
event_id string (UUID) yes Same on every retry. Also the X-CPaaS-Event-Id header.
request_id string yes The id /broadcast/tts returned (TTB…), not a broadcast id — no broadcast was created.
status string yes Always failed.
error object yes code and message — the same as error on Broadcast with TTS Status.
reference string or null yes Your reference.
custom_param string or null yes Your webhook_param, unchanged.
timestamp ISO-8601 yes When the request failed.

Success response (data)

{
    "event": "voice.broadcast.tts.failed",
    "event_id": "5d1c7a90-2b3e-4f61-8c0d-9e4a2f7b6c13",
    "request_id": "TTB7K2M9QX4WQ",
    "status": "failed",
    "error": {
        "code": "TTS_GENERATION_FAILED",
        "message": "Text to speech failed for every message."
    },
    "reference": "order-4471",
    "custom_param": "crm-lead-88231",
    "timestamp": "2026-11-09T10:16:02+00:00"
}

Notes

  • Delivery, retries and timeouts are the same as Status webhook.

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.