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

List rotation pool

The campaign's number pool, and which number is dialing right now.

GET/calls/bulk_call//numbers
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/calls/bulk_call/{bulk_call_id}/numbers' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "status": "success",
  "bulk_call_id": 314,
  "rotation_strategy": "fixed_count",
  "calls_per_number": 50,
  "rotation_health_threshold": 30,
  "rotation_fallback": "pause",
  "numbers": [
    {
      "assignment_id": 508,
      "phone_number_id": 74,
      "phone_number": "+15551234567",
      "sequence": 10,
      "is_active": true,
      "is_dialing_now": true,
      "calls_dispatched": 124,
      "calls_this_cycle": 24,
      "health_score": 82.5
    },
    {
      "assignment_id": 509,
      "phone_number_id": 123,
      "phone_number": "+15559876543",
      "sequence": 20,
      "is_active": true,
      "is_dialing_now": false,
      "calls_dispatched": 100,
      "calls_this_cycle": 50,
      "health_score": null
    }
  ]
}

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

The pool and its rotation settings.

application/json
status?string
bulk_call_id?integer
rotation?

The campaign's rotation settings.

numbers?

Was this page helpful?

Bulk call results

Per-contact results for a campaign: what happened on each call, the variables you sent with that contact, and a pointer to the recording.

Add number to rotation pool

Add one of your numbers to the campaign's rotation pool. Works while the campaign is running, which is how you bring in a fresh number when the pool is running out of healthy ones.