Initiate voice call

Place an outbound AI voice call to a lead immediately, without a campaign.

The call uses the specified voice agent and dials the lead’s phone_number. Transcript and recording appear in GET /voice/calls/ once the call ends (typically within 30 to 60 seconds of the webhook being processed).

Idempotency: provide idempotency_key (or the Idempotency-Key header) to retry safely. A repeat with the same key while the original call is dialing or done returns the original call_id without placing or charging a second call. A key whose call definitely failed may be retried. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout.

POST

/

api

/

v1

/

public

/

voice

/

calls

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/voice/calls' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"lead_id":"example","agent_id":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/voice/calls'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'lead_id': 'example', 'agent_id': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice/calls", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"lead_id": "example", "agent_id": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/voice/calls", bytes.NewBufferString(`{"lead_id": "example", "agent_id": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "call_id": "<string>",
  "status": "<string>",
  "message": "<string>"
}

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

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Body

application/json

agent_id

string

required

A voice agent's id: the id from List voice agents.

lead_id

string

required

A lead's id: the id from List all leads.

additional_variables

Additional Variables · object | null

Extra {{key}} variables resolved into the agent prompt at call time.

Show child attributes

from_number

string | null

Outbound caller ID in E.164 format. When omitted, uses the first active phone number configured for the workspace.

idempotency_key

string | null

Idempotency key returned by the Sendora API.

Maximum string length: 128

prompt_override

string | null

Override the agent system prompt for this single call. Supports {{lead.*}} tokens.

Maximum string length: 8000

voice_id

string | null

Use this voice for this call only: an id from List available voices.

voicemail

VoicemailConfig · object | null

Voicemail returned by the Sendora API.

Show child attributes

Response

Successful Response

call_id

string

required

The call's tracking id. Pass it to Get call details once the call has ended.

status

string

required

dialing | failed | skipped

message

string | null

Message returned by the Sendora API.

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/voice/calls' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"lead_id":"example","agent_id":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/voice/calls'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'lead_id': 'example', 'agent_id': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice/calls", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"lead_id": "example", "agent_id": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/voice/calls", bytes.NewBufferString(`{"lead_id": "example", "agent_id": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "call_id": "<string>",
  "status": "<string>",
  "message": "<string>"
}

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