Ringless voicemail API

Leave a recorded message in someone's voicemail from one of your Aloware numbers, without making their phone ring. Send the recipient, the line and a link to the audio file. If the number isn't a contact yet, Aloware creates one, so the message shows up in the contact's history like any other.

• Method: POST
• Auth: your account API token, in the body as api_token
• Format: JSON in, JSON out
• Required: api_token, to, audio_url, and from or line_id

Billed: Ringless voicemails sent through the API count as automated, paid usage under Aloware's billing terms.

Endpoint

POST /api/v1/webhook/rvm-gateway/send

Fields

Line IDs come from the Account lists API.

Request examples

From a phone number

curl -X POST \
  https://app.aloware.io/api/v1/webhook/rvm-gateway/send \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_token": "[API_TOKEN]",
    "from": "+18552562001",
    "to": "+18181234567",
    "audio_url": "https://www.yourwebsite.com/MeetingReminder.wav"
  }'

From a line

{
    "api_token": "[API_TOKEN]",
    "line_id": 1234,
    "to": "+18181234567",
    "audio_url": "https://www.yourwebsite.com/MeetingReminder.wav"
}

Responses

202: sent

{
    "message": "RVM sent."
}

422: not sent

The errors object names each field that is missing or wrong.

{
    "message": "The given data was invalid.",
    "errors": {
        "to": [
            "The to field is required."
        ],
        "audio_url": [
            "The audio url field is required."
        ]
    }
}

Safe retries

This endpoint takes an optional Idempotency-Key header, so a retry after a timeout runs only once. See Safe retries.

Put your own Aloware API token in place of [API_TOKEN].

Need another endpoint?

For other API functions or any question about this one, email support@aloware.com with what you're trying to do.