webhook

Voicemail available event

Sent on a call.aftercall subscription when the voicemail audio file is ready (event: voicemail_available).

voicemail_link is deprecated. It is a public CDN URL (v1): anyone with the link can download the voicemail. Retrieve the voicemail from private_voicemail_link. Download that URL with your public API key in the Authorization header, without a Bearer prefix. voicemail_duration is the length in seconds.

Call voicemail event (resource: call, event: voicemail) reports that a voicemail was left. This event follows once the audio file is ready.

To certify that the request was sent by Ringover, verify the request signature with your webhook key — see Securing your webhooks under the webhook tag (V1: JWT HS512 in X-Ringover-Webhook-Signature, with the deprecated Authorization header for backward compatibility; V3, on request: Base64 HMAC-SHA256 in X-Ringover-Webhook-Signature-V3).

postWebhookcall_voicemail_available

Payload

eventstring
resourcestring
timestampnumber
attemptinteger

Example payload

{
  "event": "voicemail_available",
  "resource": "aftercall",
  "timestamp": 1554823493.762305,
  "data": {
    "call_id": "1234567890987654321",
    "channel_id": "1234567890987654422",
    "voicemail_link": "https://cdn.ringover.com/messages/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.mp3",
    "private_voicemail_link": "https://cdn.ringover.com/v2/public/download/types/messages/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.mp3",
    "voicemail_duration": 42
  }
}

Response

Successful operation

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.