Skip to main content
POST
/
interactions
Create a new outbound interaction (phone call)
curl --request POST \
  --url https://api.voice-mate.com/v1/interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "from_phone": "+15893858485",
  "to_phone": "+15893858485",
  "override_agent_id": "agent_340846df-6fc5-4550-8c8e-590761765548",
  "variables": {
    "customer_name": "John Doe",
    "appointment_time": "2025-06-01T10:00:00Z"
  }
}'
{
  "status": "success",
  "interaction": {
    "sid": "interaction_601696d9-9fa9-4db0-8f5a-252427780c8d",
    "agent_sid": "agent_340846df-6fc5-4550-8c8e-590761765548",
    "type": "phone_call",
    "status": "initiated",
    "direction": "outbound",
    "from_number": "+14247881561",
    "to_number": "+34671573813"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer auth header. Pass with value 'Bearer {api_key}'. Api key can be found in account Settings -> API Keys page

Body

application/json
​
from_phone
string
required

E.164 formatted phone number to make the call from. Must be a phone number registered to your account.

Example:

"+15893858485"

​
to_phone
string
required

E.164 formatted phone number to call.

Example:

"+15893858485"

​
override_agent_id
string | null

Optional SID of the agent to use for this specific call. If not provided, the outbound agent configured for the from_phone will be used.

Example:

"agent_340846df-6fc5-4550-8c8e-590761765548"

​
variables
object

Optional key-value pairs of variables to pass to the agent for this interaction.

Example:
{
  "customer_name": "John Doe",
  "appointment_time": "2025-06-01T10:00:00Z"
}

Response

Interaction initiated

​
status
enum<string>
required
Available options:
success,
error
​
interaction
object
required