Skip to content
Get started

API Reference

Libraries

npm install @revoxai/sdk
pip install revox
gem "revox"

API Overview

Auth Status

Retrieve
GET/auth-status

Campaigns

Create a campaign
POST/campaigns
List campaigns
GET/campaigns
Get campaign by ID
GET/campaigns/{id}
Update a campaign
PATCH/campaigns/{id}
Delete a campaign
DELETE/campaigns/{id}
Launch a draft campaign
POST/campaigns/{id}/launch
Pause a running campaign
POST/campaigns/{id}/pause
Resume a paused campaign
POST/campaigns/{id}/resume
Cancel a campaign
POST/campaigns/{id}/cancel
Get campaign statistics
GET/campaigns/{id}/statistics
Get campaign rows
GET/campaigns/{id}/rows
Export campaign rows
GET/campaigns/{id}/export

Phone Numbers

Get phone numbers
GET/phone-numbers
Update a phone number
PATCH/phone-numbers/{id}
Delete a phone number
DELETE/phone-numbers/{id}

Assistants

Create an assistant
POST/assistants
Get assistants
GET/assistants
Get assistant by ID
GET/assistants/{id}
Update an assistant
PATCH/assistants/{id}
Delete an assistant
DELETE/assistants/{id}
Clone an assistant
POST/assistants/{id}/clone

Call

Get call by ID
GET/call/{id}
Place a call
POST/call
Get calls
POST/call/search
Export calls history
POST/call/export
Pause a call
POST/call/{id}/pause
Resume a paused call
POST/call/{id}/resume
Cancel a call
POST/call/{id}/cancel

Voices

Get voices
GET/voices
Get voice by ID
GET/voices/{id}
Delete a voice
DELETE/voices/{id}
Generate voice preview
POST/voices/preview
Clone a voice
POST/voices/clone

Users

Retrieve
GET/users/me