Send a Voice Message

This endpoint is used to initiate a voice delivery with a pre-recorded audio. Before calling it, you must first upload the audio file using the POST /voice/uploads endpoint. The request payload must be in JSON format. A 202 Accepted response means the request has been successfully received and queued for processing. To place AI-driven calls (an AI agent that holds a live conversation), use the dedicated POST /voice-agent/call endpoint instead — this endpoint does not accept voice agents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The title used to identify the voice message.

integer
required

The ID of the uploaded audio file to be sent. You can retrieve it using the Get Uploaded Audio Files endpoint.

phones
array of strings
required

An array containing the phone numbers (as strings) to which the voice message will be delivered. Do not include country codes (DDI) for Brazilian numbers. When is_international is true, provide the full number with country code instead (a leading +, if present, is stripped automatically) and the Brazilian format rules below are not applied.

phones*
boolean
Defaults to false

Set to true when every number in phones is outside Brazil. Skips the Brazilian phone format validation and the automatic 55 country-code prefix, sending the number as provided (except a leading +, which is always stripped). When omitted or false, phones is treated as Brazilian numbers as described above.

integer
1 to 3
Defaults to 3

Number of retry attempts after a failed call. When omitted, the voice service applies the default value of 3 attempts.

integer
5 to 180
Defaults to 15

Interval, in minutes, between each retry attempt. When omitted, the voice service applies the default interval of 15 minutes.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Cutoff time for additional retry attempts in HH:MM format (for example, "21:00"). The value must be between 08:00 and 21:45 in the America/Sao_Paulo timezone and be at least 10 minutes in the future relative to the time the request is sent. When omitted, no custom cutoff time is applied beyond the silent window.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json