Send a Voice Message

post

https://api.liguelead.com.br/v1/voice

This endpoint is used to initiate a voice delivery. Before calling it, you must first upload the audio file using the POST /voice/upload 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 access the complete guide and learn more about sending voice, click here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

The title used to identify the voice message.

voice_upload_id

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).

phones*

retry_attempts

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.

retry_interval_min

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.

retry_end_time

string

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

400

Validation error. Returned when retry_end_time has an invalid format (expected HH:MM), is outside the allowed range of 08:00 to 21:45, or is less than 10 minutes in the future in the America/Sao_Paulo timezone.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Voice accepted successfully