Ringover · Schema

campaign_calllist_full

CommunicationsCloudVoIPCollaborationArtificial Intelligence

Properties

Name Type Description
campaign_calllist_uuid string Unique identifier for the object
team_id integer Team identifier
user_id integer User identifier
name string The name of the campaign CALL List
campaign_tags array tags of the campaign
users_list array The list of users
groups_list array The list of groups
fifo_left_to_call integer The number of numbers left to call
update_date string
creation_date string
deletion_date string
max_retry integer The max retry attempts for numbers in the campaign CALL List
retry_time integer Optional time in seconds to wait before retrying a number
ivr_id integer Optional id of the ivr
start_date string Optional start date of the campaign
campaign_count_numbers integer
campaign_count_active_numbers integer
campaign_count_users integer
campaign_count_groups integer
is_private boolean true if the campaign call is private
is_running boolean true if the campaign call is currently running
stop_reason string the reason why the campaign call has been stopped
script object Optional script for the campaign
total_numbers_list_count integer
total_archive_logs integer The size of archive log array
archive_logs array
total_start_logs integer The size of start log array
start_logs array
View JSON Schema on GitHub

JSON Schema

ringover-campaign-calllist-full-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ringover/json-schema/ringover-campaign-calllist-full-schema.json",
  "title": "campaign_calllist_full",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ringover-campaigns-api-openapi.yml#/components/schemas/campaign_calllist_full",
  "allOf": [
    {
      "$ref": "#/$defs/campaign_calllist_light"
    },
    {
      "type": "object",
      "properties": {
        "total_numbers_list_count": {
          "type": "integer",
          "format": "int64"
        },
        "total_archive_logs": {
          "type": "integer",
          "format": "int64",
          "description": "The size of archive log array"
        },
        "archive_logs": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/campaign_calllist_archive_logs"
          }
        },
        "total_start_logs": {
          "type": "integer",
          "format": "int64",
          "description": "The size of start log array"
        },
        "start_logs": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/campaign_calllist_start_logs"
          }
        }
      }
    }
  ],
  "$defs": {
    "campaign_call_script": {
      "type": "object",
      "properties": {
        "script_uuid": {
          "type": "string",
          "description": "The identifier of the script",
          "format": "uuid"
        },
        "generic_uuid": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "description": "The name of the script"
        },
        "data": {
          "type": "string"
        },
        "is_enabled": {
          "type": "boolean",
          "description": "true if the script is enabled"
        }
      }
    },
    "campaign_calllist_archive_logs": {
      "type": "object",
      "properties": {
        "team_id": {
          "type": "integer",
          "format": "int64"
        },
        "archived_by_user_id": {
          "type": "integer",
          "format": "int64"
        },
        "unarchived_by_user_id": {
          "type": "integer",
          "format": "int64"
        },
        "archived_start_date": {
          "type": "string",
          "format": "date-time"
        },
        "unarchived_start_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "campaign_calllist_basic": {
      "type": "object",
      "properties": {
        "campaign_calllist_uuid": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier for the object"
        },
        "team_id": {
          "type": "integer",
          "format": "int64",
          "description": "Team identifier"
        },
        "user_id": {
          "type": "integer",
          "format": "int64",
          "description": "User identifier"
        },
        "name": {
          "type": "string",
          "description": "The name of the campaign CALL List"
        },
        "campaign_tags": {
          "type": "array",
          "description": "tags of the campaign",
          "items": {
            "type": "integer",
            "format": "int64"
          }
        },
        "users_list": {
          "type": "array",
          "description": "The list of users",
          "items": {
            "type": "integer",
            "format": "int64"
          }
        },
        "groups_list": {
          "type": "array",
          "description": "The list of groups",
          "items": {
            "type": "integer",
            "format": "int64"
          }
        },
        "fifo_left_to_call": {
          "type": "integer",
          "format": "int64",
          "description": "The number of numbers left to call"
        },
        "update_date": {
          "type": "string",
          "format": "date-time"
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "deletion_date": {
          "type": "string",
          "format": "date-time"
        },
        "max_retry": {
          "type": "integer",
          "description": "The max retry attempts for numbers in the campaign CALL List"
        },
        "retry_time": {
          "type": "integer",
          "description": "Optional time in seconds to wait before retrying a number",
          "default": 3600
        },
        "ivr_id": {
          "type": "integer",
          "description": "Optional id of the ivr"
        },
        "start_date": {
          "type": "string",
          "format": "date-time",
          "description": "Optional start date of the campaign"
        }
      }
    },
    "campaign_calllist_light": {
      "allOf": [
        {
          "$ref": "#/$defs/campaign_calllist_basic"
        },
        {
          "type": "object",
          "properties": {
            "campaign_count_numbers": {
              "type": "integer",
              "format": "int64"
            },
            "campaign_count_active_numbers": {
              "type": "integer",
              "format": "int64"
            },
            "campaign_count_users": {
              "type": "integer",
              "format": "int64"
            },
            "campaign_count_groups": {
              "type": "integer",
              "format": "int64"
            },
            "is_private": {
              "type": "boolean",
              "description": "true if the campaign call is private"
            },
            "is_running": {
              "type": "boolean",
              "description": "true if the campaign call is currently running"
            },
            "stop_reason": {
              "type": "string",
              "description": "the reason why the campaign call has been stopped"
            },
            "ivr_id": {
              "type": "integer",
              "description": "Optional id of the ivr"
            },
            "script": {
              "description": "Optional script for the campaign",
              "$ref": "#/$defs/campaign_call_script"
            }
          }
        }
      ]
    },
    "campaign_calllist_start_logs": {
      "type": "object",
      "properties": {
        "team_id": {
          "type": "integer",
          "format": "int64"
        },
        "started_by_user_id": {
          "type": "integer",
          "format": "int64"
        },
        "stopped_by_user_id": {
          "type": "integer",
          "format": "int64"
        },
        "start_date": {
          "type": "string",
          "format": "date-time"
        },
        "stop_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/ringover-campaign-calllist-full"
All schemas
curl "https://apis.io/api/v1/json-schemas?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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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