API Reference

Place a Voice Broadcast (runtime TTS)

post
https://api.lodgestory.com/api/wp-crm/voice//calls/voice-broadcast

Dial one number and play a message rendered to speech at runtime (ElevenLabs), then hang up — no agent involved.

The call is queued and fires asynchronously within a few seconds (instantly if the same text+voice was rendered before). The response returns the broadcast handles (campaign_id/contact_id) to correlate the resulting call.

Subject to the per-org daily/monthly cap and the destination prefix allowlist. Requires the voice API enabled + CRM_ADMIN/ACCOUNT_OWNER/CRM_BOT.

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

Your organisation UUID (returned as org from the /token endpoint).

Body Params
string
required

The customer number to dial, E.164 (a leading + is added if missing).

string
required

The message spoken on the call. Rendered to speech at runtime via ElevenLabs, played to the customer, then the call hangs up. No agent is involved.

string
required

ElevenLabs voice id to speak in (see GET /voices for available ids and names).

string

Which calling account to use. Optional — defaults to your single active voice account; required only if you have more than one (see GET /accounts).

string

Caller-ID DID to dial from (see GET /numbers). Optional — defaults to the account default DID.

number

Ring timeout in seconds (10-120). Defaults to the system value.

string

Your tracking reference (echoed back in the response).

Responses

400

Bad request — destination not allowed, or no DID/voice

401

Unauthorized

403

Forbidden — role not permitted or voice API not enabled

429

Too many requests / call cap reached

Updated 29 days ago

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

Updated 29 days ago