{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ringover/json-schema/ringover-blacklist-list-schema.json",
  "title": "blacklist_list",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ringover-blacklist-api-openapi.yml#/components/schemas/blacklist_list",
  "type": "object",
  "properties": {
    "team_id": {
      "type": "integer",
      "format": "int64",
      "description": "Your team identifier"
    },
    "limit_offset_setted": {
      "type": "integer",
      "format": "int64",
      "description": "Number of elements that will be ignored (default: 0)."
    },
    "limit_count_setted": {
      "type": "integer",
      "format": "int64",
      "description": "The number of results (default: 100)."
    },
    "total_blacklist_count": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of blacklisted phone numbers"
    },
    "blacklist_list_count": {
      "type": "integer",
      "format": "int64",
      "description": "The size of the array <em>blacklist_list</em>, corresponds to the number of blacklisted phone numbers retrieved."
    },
    "blacklist_list": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/blacklist"
      }
    }
  },
  "$defs": {
    "blacklist": {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "integer",
          "format": "int64",
          "description": "Your user identifier"
        },
        "team_id": {
          "type": "integer",
          "format": "int64",
          "description": "Your team identifier"
        },
        "number": {
          "type": "integer",
          "format": "int64",
          "description": "A blacklisted number"
        },
        "comment": {
          "type": [
            "string",
            "null"
          ],
          "description": "The comment about this blacklisted number, can be null."
        },
        "direction": {
          "type": "string",
          "description": "IN or OUT for blacklisted numbers (direction of the call)"
        }
      }
    }
  }
}