PhoneNumbersJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-phone-numbers-job-schema.json",
  "title": "PhoneNumbersJob",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-bulk-phone-number-operations-api-openapi.yml#/components/schemas/PhoneNumbersJob",
  "properties": {
    "created_at": {
      "description": "ISO 8601 formatted date indicating when the resource was created.",
      "readOnly": true,
      "type": "string"
    },
    "etc": {
      "description": "ISO 8601 formatted date indicating when the estimated time of completion of the background job.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "failed_operations": {
      "items": {
        "$ref": "#/$defs/PhoneNumbersJobFailedOperation"
      },
      "readOnly": true,
      "type": "array"
    },
    "id": {
      "description": "Identifies the resource.",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "pending_operations": {
      "items": {
        "$ref": "#/$defs/PhoneNumbersJobPendingOperation",
        "description": "The phone numbers pending confirmation on update results. Entries in this list are transient, and will be moved to either successful_operations or failed_operations once the processing is done."
      },
      "readOnly": true,
      "type": "array"
    },
    "phone_numbers": {
      "items": {
        "$ref": "#/$defs/PhoneNumbersJobPhoneNumber",
        "description": "The unique phone numbers given as arguments in the job creation."
      },
      "type": "array"
    },
    "record_type": {
      "description": "Identifies the type of the resource.",
      "readOnly": true,
      "type": "string"
    },
    "status": {
      "default": "pending",
      "description": "Indicates the completion status of the background update.",
      "enum": [
        "pending",
        "in_progress",
        "completed",
        "failed",
        "expired"
      ],
      "readOnly": true,
      "type": "string"
    },
    "successful_operations": {
      "items": {
        "$ref": "#/$defs/PhoneNumbersJobSuccessfulOperation",
        "description": "The phone numbers successfully updated."
      },
      "readOnly": true,
      "type": "array"
    },
    "type": {
      "description": "Identifies the type of the background job.",
      "enum": [
        "update_emergency_settings",
        "delete_phone_numbers",
        "update_phone_numbers"
      ],
      "readOnly": true,
      "type": "string"
    },
    "updated_at": {
      "description": "ISO 8601 formatted date indicating when the resource was updated.",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "PhoneNumbersJobFailedOperation": {
      "properties": {
        "errors": {
          "items": {
            "$ref": "#/$defs/numbers_Error"
          },
          "type": "array"
        },
        "id": {
          "description": "The phone number's ID",
          "type": "string"
        },
        "phone_number": {
          "description": "The phone number in e164 format.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PhoneNumbersJobPendingOperation": {
      "properties": {
        "id": {
          "description": "The phone number's ID",
          "type": "string"
        },
        "phone_number": {
          "description": "The phone number in e164 format.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PhoneNumbersJobPhoneNumber": {
      "properties": {
        "id": {
          "description": "The phone number's ID",
          "type": "string"
        },
        "phone_number": {
          "description": "The phone number in e164 format.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PhoneNumbersJobSuccessfulOperation": {
      "properties": {
        "id": {
          "description": "The phone number's ID",
          "type": "string"
        },
        "phone_number": {
          "description": "The phone number in e164 format.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "numbers_Error": {
      "properties": {
        "code": {
          "type": "string"
        },
        "detail": {
          "type": "string"
        },
        "meta": {
          "properties": {
            "url": {
              "description": "URL with additional information on the error.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "source": {
          "properties": {
            "parameter": {
              "description": "Indicates which query parameter caused the error.",
              "type": "string"
            },
            "pointer": {
              "description": "JSON pointer (RFC6901) to the offending entity.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "title": {
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}