Skip to main content
POST
/
api
/
v2
/
agent
/
outboundCall
curl --request POST \
  --url 'https://api.vida.dev/api/v2/agent/outboundCall?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "+15551234567",
  "context": "Call back about pricing"
}
'
{
  "success": true,
  "message": "Outbound call initiated.",
  "inserted": 3,
  "tasks": [
    {}
  ]
}

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
  • Option 1
  • Option 2
​
target
string
required

Phone in E.164 or VIDA username

Example:

"+1234567890"

​
context
string

Context for the agent to use during the call

Example:

"Name: Lyle Pratt. Interested in product demo."

​
taskContext
string

Task-specific context injected only for this call

​
greeting
string

Custom greeting to use at call start

​
waitToGreet
boolean

Delay greeting until caller speaks

​
agentId
integer

Optional campaign id override for the call

​
scheduledFor
integer

Unix seconds in the future to schedule the call

​
meta
object

Optional metadata

​
externalTaskId
string

Optional customer-provided identifier applied to created task(s)

Response

Queued successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Outbound call initiated."

​
inserted
integer
Example:

3

​
tasks
object[]