Send Call
AI-generatedSummary
Send Call
Inputs
- title (required) — Title for the voice call dispatch
- audioSource (required) — Choose whether to use an existing audio ID or upload a file
- voiceUploadId (required) — ID of a previously uploaded audio (voice_upload_id). Required when audioSource is 'id'.
- binaryPropertyName (required) — Name of the binary field that holds the audio file (MP3 or WAV, max 50 MB). Required when audioSource is 'upload'.
- audioTitle — Name used to identify the uploaded audio. Defaults to the file name. Used when audioSource is 'upload'.
- phones (required) — Comma‑separated list of phone numbers to call
- additionalFields — Optional retry and webhook settings
- additionalFields.retryAttempts — Number of retry attempts after a failed call (1–3, API default 3)
- additionalFields.retryEndTime — Cutoff time for retries in HH:MM (America/Sao_Paulo). Must be between 08:00 and 21:45 and at least 10 minutes in the future.
- additionalFields.retryIntervalMin — Interval in minutes between retry attempts (5–180, API default 15)
- additionalFields.webhookUrl — URL that receives the status events of this send instead of the app webhook URL. Called exactly as written, query string included. Must be public http/https, max 512 chars.
Output shape
{ request: { url: string, body: object }, response: object, uploaded_audio?: { audio_id: number, title: string } }
If audioSource is 'upload', the output includes an uploaded_audio object with the ID and title of the newly uploaded audio.