campaigns

List all outbound call campaigns

Changed on

Retrieves a paginated list of all outbound call campaigns configured for your team. Each campaign includes its name, status (running, stopped, completed), creation date, assigned users/groups, retry configuration, and progress statistics. Use the is_running filter to retrieve only active campaigns.

Permission: No specific permission required. A valid API key is sufficient.

get/campaigns/call

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/campaigns/call
  • Auth
    API key in header Authorization

Query parameters

limit_countinteger

Maximum number of campaigns to return per page. Default: server-defined.

limit_offsetinteger

Number of campaigns to skip for pagination. Default: 0.

ascending_order'asc'

Sort order by creation date. Set to asc for ascending (oldest first). Omit for descending (newest first).

is_runningboolean

If true, returns only campaigns that are currently running. If omitted, returns all campaigns regardless of status.

Response

Successful operation

team_idinteger
user_idinteger
limit_offset_settedinteger
limit_count_settedinteger
campaign_calllist_list_countinteger

The count of all campaigns calllist (including archived and stopped)

total_team_campaignsinteger

Total of campaigns (not archived) by a given team

Example response

{
  "team_id": 123123,
  "user_id": 234234,
  "limit_count_setted": 1,
  "campaign_calllist_list": [
    {
      "campaign_calllist_uuid": "b55f949b-c49b-4354-b10a-c8c4cdbd8690",
      "team_id": 123123,
      "user_id": 234234,
      "name": "My campaign CALL List",
      "fifo_left_to_call": 8,
      "update_date": "2018-08-12T12:12:40.53Z",
      "creation_date": "2018-08-12T12:12:40.53Z",
      "deletion_date": "2018-08-12T12:12:40.53Z",
      "max_retry": 3,
      "retry_time": 200,
      "ivr_id": 200,
      "start_date": "2018-08-12T12:12:40.53Z",
      "campaign_count_numbers": 50,
      "campaign_count_active_numbers": 10,
      "campaign_count_users": 5,
      "campaign_count_groups": 7,
      "stop_reason": "no more numbers to call",
      "script": {
        "script_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
        "generic_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
        "name": "My script",
        "is_enabled": true
      }
    }
  ],
  "campaign_calllist_list_count": 1
}

Changes