Skip to main content
POST
Request a call to a person

Body

application/json
execute
boolean

Actually submit the call request; default is a dry-run that only shows the plan (exit 3)

force
boolean

Bypass call rules for an explicit operator-requested live call

person
string

Target person ID

phone
string

Target phone number in E.164 format (temporary MVP, e.g. +5511999999999)

priority
string

Priority level (low, normal, high, urgent)

profile
string

Call profile ID

reason
string

Reason for the call

skipOriginNotify
boolean

Do not inform the originating session when the call reaches a terminal state

var
string[]

Dynamic variable sent to the voice agent; accepts repeated key=value pairs

Response

Success — body conforms to the @Returns schema.

blocked
boolean
required
hint
string
required
provider_mode
enum<string>
required
Available options:
stub,
live
request
object
required
block_reason
string | null
{key}
any