Skip to content
MoreVoice
Developers
Search
Ctrl
K
Cancel
Website
Help
Status
Sign in
Select theme
Dark
Light
Auto
Select language
English
עברית
Menu
Get started
What is MoreVoice
Quickstart
Authentication and keys
Test mode
Build with AI
Guides
Assistants
Custom tools
Flows
Phone numbers and SIP
Inbound routing
Outbound calls
Campaigns
Compliance
Human agents and queues
Copilot
QA
Call objects
Errors and limits
Web widget
React
Real-time events
Media streams
MCP
CLI
API reference
Overview
Calls and AI agents
Calls
Overview
List calls
GET
Create an outbound call
POST
Retrieve a call
GET
Delete a call
DELETE
Complete, merge, swap or cancel a consultation
POST
Retrieve a call's control state
GET
List a call's copilot events
GET
Send DTMF tones
POST
Stream a call's live events
GET
Retrieve a call's flow path
GET
Hang up a call
POST
Put a call on hold or take it off hold
POST
Add a participant
POST
Remove a participant
DELETE
Mute, hold or change the role of a participant
PATCH
Retrieve a call's payment pause
GET
Pause or resume recording for a card payment
POST
Retrieve a call's recording
GET
Stream a call's audio to your WebSocket
POST
Stop a media stream
DELETE
Retrieve a call's summary
GET
Summarise a call again
POST
Retrieve a call's transcript
GET
Stream a call's live transcript
GET
Transfer a call
POST
Download a recording (signed link)
GET
Assistants
Overview
List assistants
GET
Create an assistant
POST
Retrieve an assistant
GET
Delete an assistant
DELETE
Update an assistant
PATCH
Duplicate an assistant
POST
Tools
Overview
Test a custom tool
POST
Voices
Overview
List voices
GET
Preview a voice
POST
Flows
Overview
List flows
GET
Create a flow
POST
Validate a flow graph
POST
Retrieve a flow
GET
Delete a flow
DELETE
Update a flow
PATCH
Retrieve a flow's analytics
GET
Retrieve a flow's draft
GET
Replace a flow's draft
PUT
Duplicate a flow
POST
Publish a flow
POST
Simulate a call through a flow
POST
Retrieve what uses a flow
GET
List a flow's versions
GET
Retrieve a flow version
GET
Restore a flow version into the draft
POST
Flow templates
Overview
List flow templates
GET
Retrieve a flow template
GET
Knowledge base
Overview
List knowledge-base documents
GET
Add a knowledge-base document
POST
Retrieve a knowledge-base document
GET
Delete a knowledge-base document
DELETE
Download a document's original file
GET
Re-index a knowledge-base document
POST
Search the knowledge base
POST
Web calls
Overview
Start a web call
POST
Client tokens
Overview
Create a client token
POST
Numbers and routing
Phone numbers
Overview
List phone numbers
GET
Create a sandbox number (test mode)
POST
Retrieve a phone number
GET
Release a sandbox number (test mode)
DELETE
Connections
Overview
List connections
GET
Create a connection
POST
Retrieve a connection
GET
Delete a connection
DELETE
Update a connection
PATCH
Re-register a connection
POST
Inbound routes
Overview
List inbound routes
GET
Create an inbound route
POST
Retrieve an inbound route
GET
Delete an inbound route
DELETE
Update an inbound route
PATCH
Campaigns and compliance
Campaigns
Overview
List campaigns
GET
Create a campaign
POST
Retrieve a campaign
GET
Delete a campaign
DELETE
Update a campaign
PATCH
Cancel a campaign
POST
List a campaign's contacts
GET
Add contacts to a campaign
POST
Import a contact list in the background
POST
Retrieve a campaign contact
GET
Requeue or skip a campaign contact
PATCH
List a contact's dial attempts
GET
Export a campaign's contacts or attempts as CSV
GET
Pause a campaign
POST
Check whether a campaign can start
GET
Resume a paused campaign
POST
Start a campaign
POST
Retrieve a campaign's results
GET
Imports
Overview
Retrieve a contact import
GET
Consents
Overview
List consent records
GET
Record consents
POST
Revoke a number's consent
DELETE
Do not call
Overview
List the do-not-call list
GET
Add numbers to the do-not-call list
POST
Check numbers before calling
POST
Retrieve a do-not-call entry
GET
Remove a number from the do-not-call list
DELETE
Callbacks
Overview
List callbacks
GET
Request a callback
POST
Callback statistics
GET
Retrieve a callback
GET
Update a callback
PATCH
Cancel a callback
POST
Mark a callback done
POST
Add a note to a callback
POST
Contact centre
Queues
Overview
List queues
GET
Create a queue
POST
Retrieve a queue
GET
Delete a queue
DELETE
Update a queue
PATCH
Retrieve a queue's live state
GET
Agents
Overview
Retrieve an agent's status
GET
Users
Overview
List users
GET
Retrieve a user
GET
Deactivate a user
DELETE
Update a user
PATCH
Reactivate a user
POST
Teams
Overview
List teams
GET
Create a team
POST
Retrieve a team
GET
Delete a team
DELETE
Rename a team
PATCH
Invitations
Overview
List invitations
GET
Invite a user
POST
Retrieve an invitation
GET
Withdraw an invitation
DELETE
Resend an invitation
POST
Conference rooms
Overview
List conference rooms
GET
Create a conference room
POST
Retrieve a conference room
GET
Delete a conference room
DELETE
Update a conference room
PATCH
List a room's past sessions
GET
Download the calendar invitation
GET
Email invitations
POST
Create a new guest link
POST
Who is in the room now
GET
Moderate a live session
POST
Copilot profiles
Overview
List copilot profiles
GET
Create a copilot profile
POST
List copilot profile templates
GET
Retrieve a copilot profile
GET
Delete a copilot profile
DELETE
Update a copilot profile
PATCH
Duplicate a copilot profile
POST
QA
Overview
Retrieve a call's QA scorecard
GET
Override a scorecard item
PATCH
Score a call
POST
Retrieve the QA rubric
GET
Replace the QA rubric
PUT
Insights
Overview
Retrieve conversation insights
GET
Reports
Overview
Download a run's CSV
GET
Download a run's PDF
GET
List reports
GET
Create a report
POST
List the report widgets
GET
Preview report data
POST
Retrieve a report
GET
Delete a report
DELETE
Update a report
PATCH
List a report's runs
GET
Send a report now
POST
Webhooks and events
Webhook endpoints
Overview
List webhook endpoints
GET
Create a webhook endpoint
POST
Retrieve a webhook endpoint
GET
Delete a webhook endpoint
DELETE
Update a webhook endpoint
PATCH
Retrieve a webhook endpoint's public key
GET
Replay events to an endpoint
POST
Rotate a webhook endpoint's secret
POST
Send a test event
POST
Webhook deliveries
Overview
List webhook deliveries
GET
Retrieve a webhook delivery
GET
Retry a webhook delivery
POST
Events
Overview
List events
GET
Stream events as they happen
GET
Retrieve an event
GET
Account and tools
Authentication
Overview
Retrieve the caller
GET
Usage
Overview
Retrieve usage
GET
Organizations
Overview
List client organizations
GET
Create a client organization
POST
Retrieve a client organization
GET
Retrieve a client organization's usage
GET
Audio assets
Overview
List audio assets
GET
Upload an audio asset
POST
Retrieve an audio asset
GET
Delete an audio asset
DELETE
Rename an audio asset
PATCH
Download an audio asset
GET
Secrets
Overview
List secrets
GET
Create or replace a secret
PUT
Delete a secret
DELETE
Request logs
Overview
List request logs
GET
Stream request logs as they are written
GET
Retrieve a request log
GET
CLI
Overview
Open a CLI listen session
GET
Answer a relayed tool call
POST
Test helpers
Overview
Send a sample event
POST
Simulate an inbound call
POST
OpenAPI
Overview
Get the OpenAPI document
GET
Get the Postman collection
GET
Webhooks
agent.status_changed
POST
agent.wrapup_completed
POST
billing.invoice_issued
POST
billing.payment_failed
POST
billing.payment_succeeded
POST
billing.plan_changed
POST
billing.subscription_changed
POST
call.analyzed
POST
call.answered
POST
call.cost_finalized
POST
call.created
POST
call.dtmf
POST
call.ended
POST
call.ringing
POST
call.routing_decided
POST
call.started
POST
call.tool_called
POST
call.transferred
POST
callback.cancelled
POST
callback.completed
POST
callback.failed
POST
callback.scheduled
POST
campaign.blocked
POST
campaign.cancelled
POST
campaign.completed
POST
campaign.paused
POST
campaign.resumed
POST
campaign.started
POST
connection.status_changed
POST
consent.recorded
POST
contact.attempted
POST
contact.completed
POST
contact.opted_out
POST
flow.node_failed
POST
flow.published
POST
kb.document.failed
POST
kb.document.ready
POST
kyc.approved
POST
kyc.info_requested
POST
kyc.rejected
POST
kyc.submitted
POST
kyc.suspended
POST
number.kyc_approved
POST
number.kyc_expired
POST
number.kyc_rejected
POST
number.port_completed
POST
number.port_foc_scheduled
POST
number.port_rejected
POST
number.provisioned
POST
number.released
POST
qa.overridden
POST
qa.scored
POST
queue.call_abandoned
POST
queue.call_answered
POST
queue.call_entered
POST
queue.overflowed
POST
recording.ready
POST
test
POST
transcript.final
POST
transcript.ready
POST
usage.threshold
POST
webhook_endpoint.disabled
POST
API playground
SDK reference
Node.js
Python
TypeScript reference
Webhooks
Tool calls
Pagination
Event streams
Retries and idempotency
Errors
Calls helpers
Campaigns helpers
Csv
Codecs
Media stream
mv.agents
mv.assistants
mv.audioAssets
mv.callbacks
mv.calls
mv.campaigns
mv.cli
mv.clientTokens
mv.cliListen
mv.conferenceRooms
mv.connections
mv.consents
mv.copilotProfiles
mv.dnc
mv.events
mv.flows
mv.flowTemplates
mv.imports
mv.inboundRoutes
mv.insights
mv.invitations
mv.kb
mv.kbDocuments
mv.openapi
mv.organizations
mv.phoneNumbers
mv.qa
mv.queues
mv.reports
mv.requestLogs
mv.secrets
mv.teams
mv.testHelpersEvents
mv.testHelpersInboundCalls
mv.tools
mv.usage
mv.users
mv.voices
mv.webCalls
mv.webhookDeliveries
mv.webhookEndpoints
mv.whoami
Python reference
client.agents
client.assistants
client.audio_assets
client.callbacks
client.calls
client.campaigns
client.cli
client.cli_listen
client.client_tokens
client.conference_rooms
client.connections
client.consents
client.copilot_profiles
client.dnc
client.events
client.flow_templates
client.flows
client.imports
client.inbound_routes
client.insights
client.invitations
client.kb
client.kb_documents
client.openapi
client.organizations
client.phone_numbers
client.qa
client.queues
client.reports
client.request_logs
client.secrets
client.teams
client.test_helpers_events
client.test_helpers_inbound_calls
client.tools
client.usage
client.users
client.voices
client.web_calls
client.webhook_deliveries
client.webhook_endpoints
client.whoami
Webhooks
Setup and retries
Verifying signatures
Event catalogue
Recipes
All recipes
Changelog and versioning
Changelog
Versioning policy
Website
Help
Status
Sign in
Select theme
Dark
Light
Auto
Select language
English
עברית
Overview
Copy page
View as Markdown
Open in Claude
Open in ChatGPT
Connect the docs to your AI tools
Secrets
Section titled “Secrets”
Secret names available to tools and flows (values are never returned).
Operations
Section titled “Operations”
GET
/secrets
PUT
/secrets/{name}
DELETE
/secrets/{name}