Skip to content
Vocapable Developers

Overview

Vocapable Control API 0.1.0

Section titled “Vocapable Control API 0.1.0”

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/healthz
GET
/readyz
GET
/v1/account-deletion
POST
/v1/account-deletion/requests
POST
/v1/account-deletion/email-confirmations
POST
/v1/account-deletion/email-confirmations/confirm
GET
/v1/me
GET
/v1/users
GET
/v1/api-keys
POST
/v1/api-keys
POST
/v1/api-keys/{key_id}/rotate
DELETE
/v1/api-keys/{key_id}
GET
/v1/mobile/authorize
POST
/v1/mobile/token
GET
/v1/mobile/me
GET
/v1/mobile/devices
PUT
/v1/mobile/devices/current/push
GET
/v1/mobile/devices/current/notification-preferences
PUT
/v1/mobile/devices/current/notification-preferences
POST
/v1/mobile/devices/current/notification-preferences/test
DELETE
/v1/mobile/devices/{device_id}
POST
/v1/mobile/logout
GET
/v1/mobile/team
GET
/v1/mobile/team/invitations
POST
/v1/mobile/team/invitations
DELETE
/v1/mobile/team/invitations/{invitation_id}
GET
/v1/mobile/team/{membership_id}/transfer-destination-verification
POST
/v1/mobile/team/{membership_id}/transfer-destination-verification
POST
/v1/mobile/team/{membership_id}/transfer-destination-verification/check
PATCH
/v1/mobile/team/{membership_id}
POST
/v1/mobile/invitations/accept
GET
/v1/mobile/integrations/readiness
GET
/v1/mobile/integrations/health
GET
/v1/mobile/integrations/timeline
GET
/v1/mobile/receptionist/insights
GET
/v1/mobile/receptionist/live-calls
GET
/v1/mobile/receptionist/activity
GET
/v1/mobile/receptionist/activity/page
GET
/v1/mobile/receptionist/metrics
GET
/v1/mobile/receptionist/activity/calls/{call_id}/transcript
POST
/v1/mobile/receptionist/activity/calls/{call_id}/ai-output-reports
GET
/v1/mobile/receptionist/activity/calls/{call_id}/recording
GET
/v1/mobile/receptionist/activity/voicemails/{voicemail_id}
GET
/v1/mobile/receptionist/activity/appointments/{appointment_id}
GET
/v1/mobile/receptionist/transfers
GET
/v1/mobile/receptionist/transfers/page
GET
/v1/mobile/receptionist/transfers/{handoff_id}
GET
/v1/mobile/receptionist/my-transfers
GET
/v1/mobile/receptionist/my-transfers/page
GET
/v1/mobile/receptionist/my-transfers/{handoff_id}
GET
/v1/mobile/receptionist/handoffs/{handoff_id}/live
GET
/v1/mobile/receptionist/handoff-capability
GET
/v1/mobile/receptionist/call-ai/contacts
GET
/v1/mobile/receptionist/call-ai/contacts/search
GET
/v1/mobile/receptionist/call-ai/agents
POST
/v1/mobile/receptionist/call-ai
GET
/v1/mobile/receptionist/numbers
GET
/v1/mobile/receptionist/numbers/{number_id}/schedule
PATCH
/v1/mobile/receptionist/numbers/{number_id}/schedule
GET
/v1/mobile/receptionist/numbers/{number_id}/emergency-override
PUT
/v1/mobile/receptionist/numbers/{number_id}/emergency-override
DELETE
/v1/mobile/receptionist/numbers/{number_id}/emergency-override
GET
/v1/mobile/receptionist/readiness
GET
/v1/mobile/receptionist/hub
GET
/v1/mobile/receptionist/studio
GET
/v1/mobile/receptionist/numbers/{number_id}/studio
PATCH
/v1/mobile/receptionist/numbers/{number_id}/studio
POST
/v1/mobile/receptionist/numbers/{number_id}/studio/intelligence-snapshots
POST
/v1/mobile/receptionist/numbers/{number_id}/test-receptionist
GET
/v1/mobile/operations/tasks
GET
/v1/mobile/operations/tasks/{task_id}
POST
/v1/mobile/operations/tasks/{task_id}/acknowledge
PUT
/v1/mobile/operations/tasks/{task_id}/assignee
POST
/v1/mobile/operations/tasks/{task_id}/resolve
GET
/v1/mobile/operations/resolve-target/{event_type}/{resource_id}
POST
/v1/mobile/step-up/requests
GET
/v1/mobile/step-up/requests/{request_id}
POST
/v1/mobile/step-up/requests/{request_id}/password
POST
/v1/mobile/step-up/requests/{request_id}/email
POST
/v1/mobile/step-up/requests/{request_id}/email/confirm
GET
/v1/mobile/workspace/overview
GET
/v1/mobile/workspace/setup
GET
/v1/mobile/workspaces
GET
/v1/mobile/billing/summary
PUT
/v1/mobile/billing/budget
POST
/v1/mobile/billing/portal
GET
/v1/mobile/change-feed
GET
/v1/mobile/coach/preferences
PUT
/v1/mobile/coach/recommendations/{key}
PUT
/v1/mobile/coach/telemetry-consent
POST
/v1/mobile/coach/telemetry
GET
/v1/mobile/availability/me
PUT
/v1/mobile/availability/me
DELETE
/v1/mobile/availability/me
GET
/v1/mobile/availability
POST
/v1/mobile/receptionist/handoffs/{handoff_id}/booking/availability
GET
/v1/mobile/receptionist/handoffs/{handoff_id}/booking
POST
/v1/mobile/receptionist/handoffs/{handoff_id}/booking
GET
/v1/agreements
POST
/v1/agreements/accept
GET
/v1/agents
POST
/v1/agents
GET
/v1/agents/{agent_id}
PATCH
/v1/agents/{agent_id}
GET
/v1/agents/{agent_id}/release-gate-evaluations
POST
/v1/agents/{agent_id}/release-gate-evaluations
GET
/v1/agents/{agent_id}/receptionist-release
POST
/v1/agents/{agent_id}/receptionist-release/rollback
GET
/v1/agents/{agent_id}/versions/{version}/voicemail-message
POST
/v1/agents/{agent_id}/publish
GET
/v1/agents/{agent_id}/versions
GET
/v1/templates
GET
/v1/templates/{template_id}
POST
/v1/templates/{template_id}/instantiate
GET
/v1/agents/{agent_id}/receptionist-intelligence
PUT
/v1/agents/{agent_id}/receptionist-intelligence
GET
/v1/agents/{agent_id}/receptionist-intelligence/preview
GET
/v1/agents/{agent_id}/receptionist-intelligence/sources
POST
/v1/agents/{agent_id}/receptionist-intelligence/sources
GET
/v1/agents/{agent_id}/receptionist-intelligence/sources/{source_id}
POST
/v1/agents/{agent_id}/receptionist-intelligence/sources/{source_id}/approve
POST
/v1/agents/{agent_id}/receptionist-intelligence/sources/{source_id}/reject
POST
/v1/agents/{agent_id}/receptionist-intelligence/sources/{source_id}/refresh
GET
/v1/agents/{agent_id}/receptionist-intelligence/versions
POST
/v1/agents/{agent_id}/receptionist-intelligence/versions
GET
/v1/agents/{agent_id}/receptionist-intelligence/versions/{version}
GET
/v1/agents/{agent_id}/receptionist-regression-cases
POST
/v1/agents/{agent_id}/receptionist-regression-cases
GET
/v1/agents/{agent_id}/receptionist-regression-cases/{case_id}/versions
GET
/v1/agents/{agent_id}/receptionist-regression-cases/{case_id}/versions/{version}
GET
/v1/agents/{agent_id}/receptionist-regression-cases/{case_id}
PUT
/v1/agents/{agent_id}/receptionist-regression-cases/{case_id}
POST
/v1/agents/{agent_id}/receptionist-regression-cases/{case_id}/archive
GET
/v1/voices
GET
/v1/knowledge-packs
POST
/v1/knowledge-packs
POST
/v1/knowledge-packs/{pack_id}/versions
POST
/v1/knowledge-packs/{pack_id}/documents
GET
/v1/knowledge-packs/{pack_id}/versions/{version}
GET
/v1/voice-profiles
POST
/v1/voice-profiles
GET
/v1/voice-rights-attestation
GET
/v1/voice-clone-consent-form
GET
/v1/voice-profiles/{profile_id}
POST
/v1/voice-profiles/{profile_id}/sample-recording
POST
/v1/voice-profiles/{profile_id}/consent-recording
POST
/v1/voice-profiles/{profile_id}/consent-proof
GET
/v1/contacts
POST
/v1/contacts
GET
/v1/contacts/{contact_id}
DELETE
/v1/contacts/{contact_id}
PATCH
/v1/contacts/{contact_id}
GET
/v1/contacts/{contact_id}/dialability
GET
/v1/contacts/{contact_id}/notes
POST
/v1/contacts/{contact_id}/notes
DELETE
/v1/contacts/{contact_id}/notes/{note_id}
POST
/v1/contacts/bulk
GET
/v1/contact-lists
POST
/v1/contact-lists
GET
/v1/contact-lists/{list_id}/members
POST
/v1/contact-lists/{list_id}/members
DELETE
/v1/contact-lists/{list_id}/members
GET
/v1/contact-lists/{list_id}
DELETE
/v1/contact-lists/{list_id}
PATCH
/v1/contact-lists/{list_id}
GET
/v1/contact-imports
POST
/v1/contact-imports
GET
/v1/contact-imports/{import_id}
GET
/v1/contact-imports/{import_id}/errors
GET
/v1/contact-attempts
GET
/v1/campaigns
POST
/v1/campaigns
GET
/v1/campaigns/overview
GET
/v1/campaigns/{campaign_id}
PATCH
/v1/campaigns/{campaign_id}
POST
/v1/campaigns/{campaign_id}/launch
POST
/v1/campaigns/{campaign_id}/pause
POST
/v1/campaigns/{campaign_id}/resume
POST
/v1/campaigns/{campaign_id}/cancel
GET
/v1/campaigns/{campaign_id}/stats
GET
/v1/campaigns/{campaign_id}/attempts
GET
/v1/campaigns/{campaign_id}/outcomes
GET
/v1/campaigns/{campaign_id}/survey-rollup
GET
/v1/dashboard-summary
GET
/v1/analytics/funnel
GET
/v1/analytics/dispositions
GET
/v1/analytics/pathways
GET
/v1/analytics/latency
POST
/v1/scrub-runs
GET
/v1/scrub-runs/{run_id}
GET
/v1/scrub-runs/{run_id}/results
POST
/v1/scrub-runs/{run_id}/acknowledge
GET
/v1/dnc-entries
POST
/v1/dnc-entries
GET
/v1/consents
POST
/v1/consents
GET
/v1/dnc-subscriptions
POST
/v1/dnc-subscriptions
GET
/v1/workflow-outcomes
GET
/v1/workflow-outcomes
GET
/v1/qualification-fit-metrics
GET
/v1/qualification-fit-metrics
GET
/v1/workflow-outcomes/summary
GET
/v1/workflow-outcomes/summary
GET
/v1/workflow-outcomes/{action_id}/fit-reviews
GET
/v1/workflow-outcomes/{action_id}/fit-reviews
POST
/v1/workflow-outcomes/{action_id}/fit-reviews
POST
/v1/workflow-outcomes/{action_id}/fit-reviews
GET
/v1/workflow-outcomes/{action_id}/contact-correction
GET
/v1/workflow-outcomes/{action_id}/contact-correction
POST
/v1/workflow-outcomes/{action_id}/contact-correction-reviews
POST
/v1/workflow-outcomes/{action_id}/contact-correction-reviews
GET
/v1/calls
POST
/v1/calls
GET
/v1/calls/inbound-voicemails
GET
/v1/calls/inbound-voicemails/{voicemail_id}
GET
/v1/calls/{call_id}
GET
/v1/calls/{call_id}/dispositions
POST
/v1/calls/{call_id}/disposition
GET
/v1/calls/{call_id}/turns
GET
/v1/calls/{call_id}/transcript
GET
/v1/calls/{call_id}/recording
GET
/v1/appointments
GET
/v1/survey-responses
GET
/v1/calls/{call_id}/survey-response
GET
/v1/shift-confirmations
GET
/v1/calls/{call_id}/billing
GET
/v1/caller-request-metrics
GET
/v1/caller-requests
GET
/v1/caller-requests/{request_id}
PATCH
/v1/caller-requests/{request_id}
GET
/v1/inbox
GET
/v1/human-reps
POST
/v1/human-reps
PATCH
/v1/human-reps/{rep_id}
GET
/v1/rep-groups
POST
/v1/rep-groups
GET
/v1/rep-groups/{rep_group_id}/members
PUT
/v1/rep-groups/{rep_group_id}/members/{rep_id}
PUT
/v1/human-reps/{rep_id}/presence
GET
/v1/calls/{call_id}/handoff-readiness
POST
/v1/calls/{call_id}/live-listen-token
GET
/v1/calls/{call_id}/billing
GET
/v1/usage/summary
GET
/v1/usage/events
GET
/v1/invoices
GET
/v1/subscription
POST
/v1/subscription
GET
/v1/subscription/commitment
GET
/v1/billing/budget
PUT
/v1/billing/budget
PUT
/v1/subscription/extra-sessions
PUT
/v1/subscription/receptionist-connections
GET
/v1/subscription/expansions
POST
/v1/subscription/expansions
GET
/v1/subscription/expansions/{intent_id}
DELETE
/v1/subscription/expansions/{intent_id}
POST
/v1/subscription/expansions/{intent_id}/checkout
POST
/v1/subscription/expansions/{intent_id}/recover
POST
/v1/subscription/receptionist-connections/quote
GET
/v1/subscription/receptionist-purchases
POST
/v1/subscription/receptionist-purchases
GET
/v1/subscription/receptionist-purchases/{purchase_id}
POST
/v1/subscription/receptionist-purchases/{purchase_id}/recover
GET
/v1/billing/prepaid
POST
/v1/billing/prepaid/funding-intents
GET
/v1/billing/prepaid/auto-fund
PUT
/v1/billing/prepaid/auto-fund
POST
/v1/billing/customer-portal
POST
/v1/agents/{agent_id}/test-call
POST
/v1/agents/{agent_id}/voice-session
POST
/v1/agents/{agent_id}/chat
POST
/v1/agents/{agent_id}/setup-chat
GET
/v1/telephony-accounts
POST
/v1/telephony-accounts
GET
/v1/telephony-accounts/{account_id}
PATCH
/v1/telephony-accounts/{account_id}
PUT
/v1/telephony-accounts/{account_id}/default
GET
/v1/telephony-accounts/{account_id}/inbound-sms-webhook
GET
/v1/telephony-accounts/{account_id}/inbound-voice-webhook
POST
/v1/telephony-accounts/{account_id}/verify
GET
/v1/phone-numbers
POST
/v1/phone-numbers
POST
/v1/phone-numbers/{number_id}/assign
POST
/v1/phone-numbers/{number_id}/release
PATCH
/v1/phone-numbers/{number_id}/inbound-voice-routing
GET
/v1/phone-numbers/{number_id}/answering-policy
PUT
/v1/phone-numbers/{number_id}/answering-policy
DELETE
/v1/phone-numbers/{number_id}/answering-policy
GET
/v1/number-pools
POST
/v1/number-pools
POST
/v1/number-pools/{pool_id}/members
GET
/v1/verified-numbers
POST
/v1/verified-numbers
POST
/v1/verified-numbers/{verified_number_id}/check
GET
/v1/integration-connections
POST
/v1/integration-connections
GET
/v1/integration-connections/callback
POST
/v1/calendar/availability
POST
/v1/calendar/events
POST
/v1/exports
GET
/v1/exports/{export_id}
GET
/v1/webhook-endpoint
PUT
/v1/webhook-endpoint
POST
/v1/webhook-endpoint/rotate-secret
GET
/v1/webhook-deliveries
POST
/v1/webhook-endpoint/test
POST
/v1/webhook-deliveries/{delivery_id}/redrive
GET
/v1/receptionist-action-targets
PUT
/v1/receptionist-action-targets/{outcome_type}
DELETE
/v1/receptionist-action-targets/{outcome_type}
GET
/v1/receptionist-action-targets/{outcome_type}/deliveries
POST
/v1/receptionist-action-targets/{outcome_type}/test
GET
/v1/webhook-targets
POST
/v1/webhook-targets
GET
/v1/webhook-targets/{target_id}
DELETE
/v1/webhook-targets/{target_id}
PATCH
/v1/webhook-targets/{target_id}
POST
/v1/webhook-targets/{target_id}/rotate-secret
GET
/v1/messages
POST
/v1/messages
GET
/v1/message-templates
POST
/v1/message-templates
PATCH
/v1/message-templates/{template_id}
POST
/v1/messages/inbound
GET
/v1/workspace-capabilities
POST
/v1/workspace-telemetry

Authentication

Section titled “Authentication”

HTTPBearer

Section titled “HTTPBearer”

API key: vcp_live_… or vcp_test_…

Security scheme type: http

DashboardSessionCookie

Section titled “DashboardSessionCookie”

First-party dashboard session cookie; native mutations also require X-CSRF-Token.

Security scheme type: apiKey

Cookie parameter name: __Host-vcp-session

MobileBearer

Section titled “MobileBearer”

Short-lived Vocapable Mobile access token (vma1.…), never an API key.

Security scheme type: http

bearerAuth

Section titled “bearerAuth”

API key in the Authorization header: Authorization: Bearer vcp_live_… or vcp_test_…. Test keys route all telephony to a mock provider, so no PSTN dial ever originates from a test key.

Security scheme type: http

Bearer format: API key