Volume Reach/Docs

Volume Reach Public API

Trigger AI-powered qualification calls from your CRM and receive structured results via webhook — without writing any voice-agent, telephony, or compliance code.

Audience: developers and Zapier / Go High Level / HubSpot / Make users integrating Volume Reach into their lead workflow.

Pattern: new lead fills out form → your CRM fires → Volume Reach dials + qualifies → structured data back to your webhook → your system books the appointment, updates the CRM, routes to sales.


When to use this

Use the Public API when you want to:

  • Call every inbound lead within seconds of a form submission (Facebook Lead Ads, Google PPC landing pages, web forms).
  • Qualify leads before they hit your sales team — let an AI agent confirm interest, budget, timeline, and best callback time.
  • Keep your own booking / CRM system as the source of truth — Volume Reach delivers structured data; you decide what to do with it.

Volume Reach handles the hard parts (phone numbers, TTS, STT, LLM, telephony, A2P registration, call recording, concurrent-call limits, retry logic). Your code just calls one HTTP endpoint and handles one webhook.


5-minute overview

Your CRM / Lead Source
  │  New lead arrives (e.g. Go High Level form)
  ▼
POST https://api.volumereach.com/api/v1/public/calls
  Authorization: Bearer vr_live_...
  { agentId, phoneNumber, variables, metadata, idempotencyKey, knownConsent }
  │
  ▼
  { id: "call_xyz", status: "queued" }
  │
  │  Volume Reach dials the lead, the AI agent runs your script,
  │  transcribes the call, classifies the outcome, and extracts
  │  structured data according to your schema.
  │
  ▼
POST https://your-app.com/webhooks/volumereach  (your endpoint)
  X-Webhook-Signature: sha256=...
  X-Webhook-Delivery-Id: <uuid>
  {
    event: "call.completed",
    data: {
      call_id, outcome, duration_seconds, transcript, recording_url,
      variables, metadata, extraction: { interested: true, appointmentDateTimeISO: "..." }
    }
  }
  │
  ▼
Your integration (Zapier, Go High Level, HubSpot workflow, custom code)
  books the Google Calendar slot, updates your CRM, etc.

Documentation map

Start with the Getting Started guide if this is your first integration.

TopicDoc
Setup walkthrough (15 min end-to-end)Getting Started
Full endpoint reference + error codesAPI Reference
Webhook events + payload shape + HMAC verificationWebhooks
Structured post-call data extractionStructured Extraction
TCPA / consent responsibility modelCompliance
Troubleshooting + FAQFAQ

Integration recipes (copy / paste)

PlatformRecipe
Go High Level — Workflow → call → contact updateGo High Level
Zapier — Facebook Lead → Volume Reach → Google CalendarZapier
HubSpot — Workflow-triggered calls + deal updatesHubSpot
Raw HTTP — Node.js, Python, Go, curlRaw HTTP

Quick reference

Base URL

https://api.volumereach.com/api/v1/public

Authentication

Every request requires a Bearer API key. Create one at Settings → API Keys in the Volume Reach app.

Authorization: Bearer vr_live_...

Core endpoints

MethodPathPurposeScope
POST/callsTrigger an outbound qualification callcalls:place
GET/calls/:idRead call status + transcript + extractioncalls:read
POST/calls/:id/endForce-terminate an in-progress callcalls:place
GET/agentsList your configured voice agentsread
GET/agents/:idRead a single agent (incl. extraction schema)read
POST/agents/:id/extraction-schemaSave / update extraction schemawrite
POST/webhooksCreate a webhook endpoint (signing secret shown once)webhooks
GET/webhooksList webhook endpointswebhooks
POST/automation-triggersSubscribe an endpoint to an event typewebhooks
DELETE/automation-triggers/:idUnsubscribewebhooks

What's not in v1

Deferred until customers ask. See API Reference → Future additions.

  • Mid-call tool execution (agent calls your HTTPS endpoint during the conversation).
  • Scheduled calls (scheduledAt in the future).
  • Inbound agent routing (phone number → voice agent).
  • Per-endpoint signing-secret rotation with overlap window.

Support

  • Status page / incidents: https://status.volumereach.com
  • In-app support chat: click the bubble in the bottom-right of the Volume Reach app.
  • Email: support@volumereach.com
  • Developer docs feedback: mention "Public API" in your support message.

When contacting support, include:

  • Your account email
  • The API key prefix (e.g. vr_live_abc1...) — never the full key
  • The call_id or X-Webhook-Delivery-Id of the failing request
  • Approximate timestamp (UTC)