ImportedNumber

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sinch/main/json-schema/sinch-imported-number-schema.json",
  "title": "ImportedNumber",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sinch-imported-numbers-hosting-orders-api-openapi.yml#/components/schemas/ImportedNumber",
  "type": "object",
  "properties": {
    "phoneNumber": {
      "type": "string",
      "description": "The phone number in e.164 format with leading +."
    },
    "projectId": {
      "type": "string",
      "description": "The ID of the project resource. You can find your project ID on dashboard.sinch.com."
    },
    "regionCode": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE."
    },
    "displayName": {
      "type": "string",
      "description": "User supplied name for the phone number."
    },
    "smsConfiguration": {
      "$ref": "#/$defs/SmsConfiguration"
    },
    "callbackUrl": {
      "type": "string",
      "description": "The client's callback URL to be called upon finishing the number import."
    }
  },
  "$defs": {
    "ScheduledProvisioning": {
      "readOnly": true,
      "type": "object",
      "properties": {
        "servicePlanId": {
          "type": "string",
          "description": "Service plan of the scheduled provisioning task."
        },
        "status": {
          "type": "integer",
          "description": "Status of the pending change.",
          "format": "enum"
        },
        "lastUpdatedTime": {
          "type": "string",
          "description": "Timestamp when the status was last updated.",
          "format": "date-time"
        },
        "campaignId": {
          "type": "string",
          "description": "The campaign of the scheduled provisioning task."
        },
        "errorCodes": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "enum"
          },
          "description": "A list of error codes, if applicable, for the scheduled provisioning task."
        }
      },
      "description": "Ongoing Provisioning for SMS service"
    },
    "SmsConfiguration": {
      "type": "object",
      "properties": {
        "servicePlanId": {
          "type": "string",
          "description": "The current SMS configuration for this number.\r The `servicePlanId`` can be found when logging into dashboard.sinch.com\r in the SMS>APIs section."
        },
        "scheduledProvisioning": {
          "$ref": "#/$defs/ScheduledProvisioning"
        },
        "campaignId": {
          "type": "string",
          "description": "The current campaign ID assigned to this number."
        },
        "migrateToSinchTmo": {
          "type": "boolean",
          "readOnly": true,
          "description": "Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch."
        }
      },
      "description": "Configuration for SMS"
    }
  }
}