Hellou AI

Hellou AI Voice Campaigns API

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.

GitHub OpenAPI

Operations 64

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 #
PATCH /api/v1/accounts/{account_id}/dialer_dispositions/{id} Change a disposition #
DELETE /api/v1/accounts/{account_id}/dialer_dispositions/{id} Archive a disposition #
GET /api/v1/accounts/{account_id}/dialer_report_targets Get the report thresholds #
PUT /api/v1/accounts/{account_id}/dialer_report_targets Change the report thresholds #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hellou-ai/openapi/hellou-ai-voice-campaigns-api-openapi.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hellou-ai:hellou-ai-voice-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hellou-ai-voice-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HellouOne Voice Campaigns API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:


# --- truncated at 32 KB (232 KB total) ---
# Full source: https://artifacts.apis.io/hellou-ai/openapi/hellou-ai-voice-campaigns-api-openapi.yml