Amazon Pinpoint · Schema

NumberValidateResponse

Provides information about a phone number.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Carrier object
City object
CleansedPhoneNumberE164 object
CleansedPhoneNumberNational object
Country object
CountryCodeIso2 object
CountryCodeNumeric object
County object
OriginalCountryCodeIso2 object
OriginalPhoneNumber object
PhoneType object
PhoneTypeCode object
Timezone object
ZipCode object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-number-validate-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-number-validate-response-schema.json",
  "title": "NumberValidateResponse",
  "description": "Provides information about a phone number.",
  "type": "object",
  "properties": {
    "Carrier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with."
        }
      ]
    },
    "City": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the city where the phone number was originally registered."
        }
      ]
    },
    "CleansedPhoneNumberE164": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The cleansed phone number, in E.164 format, for the location where the phone number was originally registered."
        }
      ]
    },
    "CleansedPhoneNumberNational": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The cleansed phone number, in the format for the location where the phone number was originally registered."
        }
      ]
    },
    "Country": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the country or region where the phone number was originally registered."
        }
      ]
    },
    "CountryCodeIso2": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered."
        }
      ]
    },
    "CountryCodeNumeric": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The numeric code for the country or region where the phone number was originally registered."
        }
      ]
    },
    "County": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the county where the phone number was originally registered."
        }
      ]
    },
    "OriginalCountryCodeIso2": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body."
        }
      ]
    },
    "OriginalPhoneNumber": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The phone number that was sent in the request body."
        }
      ]
    },
    "PhoneType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,\n                  INVALID, PREPAID, and OTHER."
        }
      ]
    },
    "PhoneTypeCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid)."
        }
      ]
    },
    "Timezone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The time zone for the location where the phone number was originally registered."
        }
      ]
    },
    "ZipCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The postal or ZIP code for the location where the phone number was originally registered."
        }
      ]
    }
  }
}