Outbound IVR Calls

POST/v1/ivr/calls calls an Indian phone number and runs one of your published IVR flows on the call. Pass per-call variables (used as {{var.name}}), your own reference_id, and a status_callback_url that receives the signed result when the call ends. An Idempotency-Key header makes retries safe. DNC and 09:00-21:00 IST calling hours are enforced.

Request body#

Headers#

Example#

curl -X POST https://voice-api.edesy.in/v1/ivr/calls \
  -H "Authorization: Bearer $EDESY_API_KEY" \
  -H "Idempotency-Key: order-A123-confirm" \
  -H "Content-Type: application/json" \
  -d '{
    "flow_id": "5b1c2f0e-0000-4000-8000-000000000000",
    "to": "+919800000000",
    "variables": { "order_id": "A123", "name": "Ravi", "amount": 499 },
    "reference_id": "crm-lead-42",
    "status_callback_url": "https://crm.example.com/ivr/status"
  }'

{
  "data": {
    "call_sid": "a1b2c3d4-0000-4000-8000-000000000000",
    "call_log_id": "7f3e2d1c-0000-4000-8000-000000000000",
    "status": "queued",
    "reference_id": "crm-lead-42"
  }
}

How it works#

1. Edesy checks the flow is published, the number is valid and not on your do-not-call list, the time is within calling hours, your wallet has balance, and you are under the concurrency limit.
2. The call is queued and dialled from from (or your default IVR number).
3. When the person answers, the flow runs with your variables filled in.
4. HTTP Request nodes in the flow call your API as the caller presses keys.
5. When the call ends, Edesy POSTs the result to status_callback_url.

Idempotency#

Send Idempotency-Key: <unique string> to make retries safe:

• The same key and body within 24 hours returns the original response and does not dial again.
• The same key with a different body returns 422 idempotency_key_reused.
• A repeat while the first request is still being processed returns 409 idempotency_key_in_use.

Errors#

Get a call#

Returns the call log for any IVR call (API, inbound, test or order automation): status, duration, price, dtmf_path, variables, reference_id, call_outcome, and http_requests (every HTTP request the flow made during the call). Secret-looking header values are masked. Unknown calls return 404 not_found.

To list API calls, use GET/v1/ivr/call-logs?source=api&reference_id=crm-lead-42. See Logs API.

Status callback#

When the call ends, Edesy sends POST to your status_callback_url. It is signed like HTTP Request nodes and makes up to 5 attempts, with backoff, if your endpoint fails.

{
  "event": "ivr.call.completed",
  "timestamp": "2026-10-28T10:15:00Z",
  "data": {
    "call_sid": "a1b2c3d4-0000-4000-8000-000000000000",
    "call_log_id": "7f3e2d1c-0000-4000-8000-000000000000",
    "reference_id": "crm-lead-42",
    "flow_id": "5b1c2f0e-0000-4000-8000-000000000000",
    "flow_version": 3,
    "from": "918000000000",
    "to": "919800000000",
    "status": "completed",
    "hangup_cause": "normal",
    "sip_status": 0,
    "call_outcome": "answered",
    "duration_sec": 42,
    "price": 1.5,
    "currency": "INR",
    "dtmf_path": ["1"],
    "variables": { "order_id": "A123" },
    "http_requests": [ { "node_id": "http-1", "status": "delivered", "response_code": 200 } ],
    "answers": [ { "question_key": "city", "question": "Which city are you calling from?", "transcript": "Lucknow", "status": "captured", "attempt": 1 } ]
  }
}

Status callbacks are listed in HTTP Logs with the kind Status callback.

Limits#

Pricing#

Rs 1.50 per minute, billed per started minute from your wallet. Unanswered calls are free. Prices exclude 18% GST. See Pricing.