Skip to main content
POST
Start voice call

Authorizations

Authorization
string
header
required

API Key no formato Bearer (ex.: sk_live_...).

Body

application/json
from
string
required

Workspace phone number id or E.164.

to
required

E.164 destination (+...). Prefer an array (canonical); string accepted for compatibility.

Required array length: 1 - 100 elements
type
enum<string>
required

Initial action: speak (TTS in payload.text), play (payload.audioUrl), gather (payload.gather), template (payload.templateId).

Available options:
speak,
play,
gather,
template
payload
object
required

Content per type. speak: text, optional voice/language. play: audioUrl. gather: gather object. template: templateId + optional variables.

record
boolean
machineDetection
string
Example:

"detect"

clientState
string

Response

Chamada enfileirada.

success
boolean
required
data
object
required