# Hellou AI Voice Campaigns API

**Canonical:** https://apis.io/apis/hellou-ai/hellou-ai-voice-campaigns-api/  
**Provider:** Hellou AI — https://apis.io/providers/hellou-ai/  
**Base URL:** https://one.hellou.ai  
**Documentation:** https://one.hellou.ai/docs/api

Hellou AI Voice Campaigns API is one of 47 APIs that [Hellou AI](https://apis.io/providers/hellou-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Voice Campaigns. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Voice campaigns and the Contact Center live overview. An **outbound** campaign dials the contacts of its audience; an **inbound** campaign has no contact list and logs its available agents in to PBX queues. Administrators manage campaigns; agents see only the campaigns assigned to them. Contacts, live calls and recordings are served to the dashboard and are not part of this reference.

## Operations (60 of 64)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/accounts/{account_id}/voice_campaigns` | List voice campaigns |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns` | Create a voice campaign |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/supervisor_report` | Get the supervisor report |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/parse_preview` | Preview a contact file |
| PATCH | `/api/v1/accounts/{account_id}/voice_campaigns/bulk_update` | Change several voice campaigns at once |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}` | Get a voice campaign |
| PUT | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}` | Update a voice campaign |
| DELETE | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}` | Delete a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/launch` | Launch a voice campaign |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/sweep_schedule` | Get a campaign's sweep schedule |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/sweep_schedule` | Start an automatic sweep series |
| PATCH | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/sweep_schedule` | Change an automatic sweep series |
| DELETE | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/sweep_schedule` | End an automatic sweep series |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/clone` | Clone a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/archive` | Archive a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/unarchive` | Unarchive a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/pause` | Pause a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/{contact_id}/skip` | Skip the queued lead in preview mode |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/resume` | Resume a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/cancel` | Cancel a voice campaign |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/report_stats` | Get a voice campaign's agent results |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/monitor` | Get a voice campaign's live board |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents` | Add agents to a voice campaign |
| DELETE | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/{user_id}` | Remove an agent from a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/{user_id}/logout` | Log an agent out of a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/me/ready` | Mark the signed-in agent as ready |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/me/pause` | Pause the signed-in agent with a break reason |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/me/wrap_up` | Move the signed-in agent to wrap-up |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/agents/me/logout` | Log the signed-in agent out of the campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/{contact_id}/disposition` | Submit the outcome of a call |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/{contact_id}/dial` | Dial the queued lead in preview mode |
| POST | `/api/v1/accounts/{account_id}/contact_center/agents/{user_id}/logout` | Log an agent out of all voice campaigns |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/test_call` | Test an AI voice campaign on your phone |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts` | List a campaign's contacts and results |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts` | Add contacts to a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/remove` | Remove contacts from a voice campaign |
| POST | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/upload_csv` | Upload a contact file to a voice campaign |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/export` | Export a campaign's results as CSV or a spreadsheet |
| GET | `/api/v1/accounts/{account_id}/voice_campaigns/{display_id}/contacts/{id}/preview` | Preview one campaign contact as its AI agent will receive it |
| GET | `/api/v1/accounts/{account_id}/contact_center/live` | Get the live Contact Center overview |
| GET | `/api/v1/accounts/{account_id}/voice_campaign_programs` | List voice campaign programs |
| POST | `/api/v1/accounts/{account_id}/voice_campaign_programs` | Create a voice campaign program |
| GET | `/api/v1/accounts/{account_id}/voice_campaign_programs/{id}` | Get a voice campaign program |
| PUT | `/api/v1/accounts/{account_id}/voice_campaign_programs/{id}` | Update a voice campaign program |
| DELETE | `/api/v1/accounts/{account_id}/voice_campaign_programs/{id}` | Delete a voice campaign program |
| GET | `/api/v1/accounts/{account_id}/voice_campaign_programs/{id}/export` | Export a voice campaign program as a spreadsheet |
| GET | `/api/v1/accounts/{account_id}/voice_campaign_metrics` | Get the Contact Center report metrics |
| GET | `/api/v1/accounts/{account_id}/call_forms` | List call forms |
| POST | `/api/v1/accounts/{account_id}/call_forms` | Create a call form |
| GET | `/api/v1/accounts/{account_id}/call_forms/{id}` | Get a call form |
| PATCH | `/api/v1/accounts/{account_id}/call_forms/{id}` | Change a call form |
| DELETE | `/api/v1/accounts/{account_id}/call_forms/{id}` | Archive a call form |
| GET | `/api/v1/accounts/{account_id}/calls/{call_id}/wrap_up` | Get the wrap-up of a call |
| POST | `/api/v1/accounts/{account_id}/calls/{call_id}/wrap_up` | File the wrap-up of a call |
| GET | `/api/v1/accounts/{account_id}/call_wrap_ups` | List call wrap-ups |
| POST | `/api/v1/accounts/{account_id}/call_wrap_ups` | File the wrap-up of a phone-system call |
| GET | `/api/v1/accounts/{account_id}/call_wrap_ups/lookup` | Get the wrap-up of a phone-system call |
| PATCH | `/api/v1/accounts/{account_id}/call_wrap_ups/{id}` | Finish or change a wrap-up |
| GET | `/api/v1/accounts/{account_id}/dialer_dispositions` | List dispositions |
| POST | `/api/v1/accounts/{account_id}/dialer_dispositions` | Create a disposition |

…and 4 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/hellou-ai/openapi/hellou-ai-voice-campaigns-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-ai-call-report-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-report-stats-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-inbox-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-create-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-call-schema.json

## Other Hellou AI APIs (12)

- [Hellou AI Account AgentBots API](https://apis.io/apis/hellou-ai/hellou-ai-account-agentbots-api/)
- [Hellou AI Account Users API](https://apis.io/apis/hellou-ai/hellou-ai-account-users-api/)
- [Hellou AI Accounts API](https://apis.io/apis/hellou-ai/hellou-ai-accounts-api/)
- [Hellou AI Agent Bots API](https://apis.io/apis/hellou-ai/hellou-ai-agentbots-api/)
- [Hellou AI Agents API](https://apis.io/apis/hellou-ai/hellou-ai-agents-api/)
- [Hellou AI AI Classifications API](https://apis.io/apis/hellou-ai/hellou-ai-ai-classifications-api/)
- [Hellou AI AI Phone Lines API](https://apis.io/apis/hellou-ai/hellou-ai-ai-phone-lines-api/)
- [Hellou AI Assignment Settings API](https://apis.io/apis/hellou-ai/hellou-ai-assignment-settings-api/)
- [Hellou AI Automation Rule API](https://apis.io/apis/hellou-ai/hellou-ai-automation-rule-api/)
- [Hellou AI Calls API](https://apis.io/apis/hellou-ai/hellou-ai-calls-api/)
- [Hellou AI Campaigns API](https://apis.io/apis/hellou-ai/hellou-ai-campaigns-api/)
- [Hellou AI Canned Responses API](https://apis.io/apis/hellou-ai/hellou-ai-canned-responses-api/)

## Tags

Voice Campaigns

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hellou-ai/hellou-ai-voice-campaigns-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hellou-ai/.