PhoneNumberCampaign

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-phone-number-campaign-schema.json",
  "title": "PhoneNumberCampaign",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-phone-number-campaigns-api-openapi.yml#/components/schemas/PhoneNumberCampaign",
  "properties": {
    "assignmentStatus": {
      "description": "The assignment status of the number.",
      "enum": [
        "FAILED_ASSIGNMENT",
        "PENDING_ASSIGNMENT",
        "ASSIGNED",
        "PENDING_UNASSIGNMENT",
        "FAILED_UNASSIGNMENT"
      ],
      "title": "AssignmentStatus",
      "type": "string"
    },
    "brandId": {
      "description": "Brand ID. Empty if the number is associated to a shared campaign.",
      "title": "BrandId",
      "type": "string"
    },
    "campaignId": {
      "description": "For shared campaigns, this is the TCR campaign ID, otherwise it is the campaign ID ",
      "title": "Campaignid",
      "type": "string"
    },
    "createdAt": {
      "title": "Createdat",
      "type": "string"
    },
    "failureReasons": {
      "description": "Extra info about a failure to assign/unassign a number. Relevant only if the assignmentStatus is either FAILED_ASSIGNMENT or FAILED_UNASSIGNMENT",
      "type": "string"
    },
    "phoneNumber": {
      "title": "Phonenumber",
      "type": "string"
    },
    "tcrBrandId": {
      "description": "TCR's alphanumeric ID for the brand.",
      "title": "TcrBrandId",
      "type": "string"
    },
    "tcrCampaignId": {
      "description": "TCR's alphanumeric ID for the campaign.",
      "title": "TcrCampaignid",
      "type": "string"
    },
    "telnyxCampaignId": {
      "description": "Campaign ID. Empty if the number is associated to a shared campaign.",
      "title": "Telnyxcampaignid",
      "type": "string"
    },
    "updatedAt": {
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "phoneNumber",
    "campaignId",
    "createdAt",
    "updatedAt"
  ],
  "type": "object"
}