Create a call

POST

calls

curl --request POST \
  --url https://api.eu.volubile.ai/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient": {
    "phone": "+33612345678",
    "context": {
      "firstName": "firstname",
      "lastName": "lastname",
      "orderNumber": "5HZ99FRT"
    }
  }
}'

This response does not have an example.

Authorizations

X-Api-Key

string

header

required

Your API key.

Body

application/json

agentId

string

required

Unique identifier of the OUTBOUND agent to use for the call

recipient

object

required

Recipient to call

recipient.phone

string

required

Phone number to call, in the E.164 international standard format

Example:

"+33612345678"

recipient.context

object

Custom object for dynamic content injection into the agent prompt. Keys in this map correspond to placeholders in the prompt template: e.g {{ firstName }}. At runtime, each placeholder will be replaced with its corresponding value.

⚠️ All sent variables not found in configured agent prompt will be ignored.

recipient.context.{key}

object

⚠️ All sent variables not found in configured agent prompt will be ignored.

Example:

{
  "firstName": "firstname",
  "lastName": "lastname",
  "orderNumber": "5HZ99FRT"
}

Example:

{
  "firstName": "firstname",
  "lastName": "lastname",
  "orderNumber": "5HZ99FRT"
}

Response

201

_mintlify/placeholder

Created

Get a call Get recording of a call

curl --request POST \
  --url https://api.eu.volubile.ai/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient": {
    "phone": "+33612345678",
    "context": {
      "firstName": "firstname",
      "lastName": "lastname",
      "orderNumber": "5HZ99FRT"
    }
  }
}'

This response does not have an example.

API Documentation

Agents

Calls

Campaigns

Authorizations

Body

Response