Initiate An Outbound Call

Initiate a single outbound call to a phone number using an agent.

POST /v1/voiceai/outbound-call

Initiate An Outbound Call

cURL

curl --request POST \
  --url https://api.threetone.in/v1/voiceai/outbound-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "<string>",
  "phone_number_id": "<string>",
  "to_phone_number": "<string>"
}
'

import requests

url = "https://api.threetone.in/v1/voiceai/outbound-call"

payload = {
    "agent_id": "<string>",
    "phone_number_id": "<string>",
    "to_phone_number": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: '<string>', phone_number_id: '<string>', to_phone_number: '<string>'})
};

fetch('https://api.threetone.in/v1/voiceai/outbound-call', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "success": true,
  "conversation_id": "<string>",
  "message": "Success",
  "call_sid": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

x-api-key · string · header · required

API key for programmatic access

Body

application/json

Request to initiate an outbound call.

agent_id · string · required

Agent ID to use for the call

phone_number_id · string · required

Phone number ID to call from

to_phone_number · string · required

Phone number to call (E.164 format)

dynamic_variables · Dynamic Variables · object | null

Dynamic variables to pass to the agent

Response

200

application/json

Successful Response

Response from initiating an outbound call.

success · boolean · required

Whether the call was initiated successfully

conversation_id · string · required

Generated conversation ID

message · string · default: Success

Status message

call_sid · string | null

SIP call ID if available