MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Bulk calls

Bulk call live status

Real-time status of a running bulk-call campaign.

GET/bulk-call//live-status
Path parameters
bulk_call_idrequired
Query parameters
user_idinteger

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients). 

curl -X GET 'https://omnidim.io/api/v1/bulk-call/{bulk_call_id}/live-status' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "status": "success",
  "bulk_call_id": 314,
  "campaign_status": "completed",
  "summary": {
    "total_contacts": 1,
    "queued": 0,
    "in_progress": 0,
    "completed": 0,
    "failed": 0,
    "busy": 0,
    "no_answer": 1
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

bulk_call_id*integer

Id of the bulk call campaign.

Query Parameters

user_id?integer

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.

Response body

application/json

Response Body

Live status payload.

application/json
status?string
bulk_call_id?integer
campaign_status?string
summary?

Was this page helpful?

Set calling hours

Restrict a campaign to a daily calling window, in the campaign's timezone. Outside the window the campaign holds rather than finishing, and resumes the next day.

Create session

Create a voice Session: a short-lived, single-conversation reservation that lets a client hold a live voice chat with your agent. This is step 1 of 2. Creating the Session does not start any audio on its own; it returns a ws_url that a client then connects to over WebSocket to actually talk.