Phone

A phone number and a collection of phone numbers.

Phone

A phone number.

Property	Type	Required	Description
countryCode	string	Yes	The international country code (e.g., "+1" for US/Canada).
number	string	Yes	The local phone number without the country code.
extension	string	No	Optional extension number for the phone line.
isMobile	boolean	No	Indicates whether this is a mobile/cell phone number.

Example

{
  "countryCode": "+1",
  "number": "555-123-4567",
  "extension": "123",
  "isMobile": false
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: Phone.yaml
type: object
properties:
  countryCode:
    type: string
    pattern: ^\+[1-9][0-9]{0,3}$
    description: The international country code (e.g., "+1" for US/Canada).
  number:
    type: string
    description: The local phone number without the country code.
  extension:
    type: string
    description: Optional extension number for the phone line.
  isMobile:
    type: boolean
    default: false
    description: Indicates whether this is a mobile/cell phone number.
required:
  - countryCode
  - number
examples:
  - countryCode: "+1"
    number: 555-123-4567
    extension: "123"
    isMobile: false
  - countryCode: "+1"
    number: 444-456-1230
    isMobile: true
description: A phone number.

TypeSpec

/** A phone number. */
@example(Examples.Phone.mobile)
@example(Examples.Phone.withExtension)
@Versioning.added(Versions.v0_1)
model Phone {
  /** The international country code (e.g., "+1" for US/Canada). */
  @pattern("^\\+[1-9][0-9]{0,3}$")
  countryCode: string;

  /** The local phone number without the country code. */
  number: string;

  /** Optional extension number for the phone line. */
  extension?: string;

  /** Indicates whether this is a mobile/cell phone number. */
  isMobile?: boolean = false;
}

PhoneCollection

A collection of phone numbers for a person.

Property	Type	Required	Description
primary	Phone	Yes	The person's primary phone number.
fax	Phone	No	The person's fax number, if applicable.
otherPhones	RecordPhone	No	Additional phone numbers not covered by the standard fields.

Example

{
  "primary": {
    "countryCode": "+1",
    "number": "444-456-1230",
    "isMobile": true
  },
  "fax": {
    "countryCode": "+1",
    "number": "555-123-4567",
    "extension": "123",
    "isMobile": false
  },
  "otherPhones": {
    "support": {
      "countryCode": "+1",
      "number": "333-456-1230",
      "isMobile": false
    },
    "marketing": {
      "countryCode": "+1",
      "number": "444-456-1230",
      "isMobile": true
    }
  }
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: PhoneCollection.yaml
type: object
properties:
  primary:
    $ref: Phone.yaml
    description: The person's primary phone number.
  fax:
    $ref: Phone.yaml
    description: The person's fax number, if applicable.
  otherPhones:
    $ref: "#/$defs/RecordPhone"
    description: Additional phone numbers not covered by the standard fields.
required:
  - primary
examples:
  - primary:
      countryCode: "+1"
      number: 444-456-1230
      isMobile: true
    fax:
      countryCode: "+1"
      number: 555-123-4567
      extension: "123"
      isMobile: false
    otherPhones:
      support:
        countryCode: "+1"
        number: 333-456-1230
        isMobile: false
      marketing:
        countryCode: "+1"
        number: 444-456-1230
        isMobile: true
  - primary:
      countryCode: "+1"
      number: 444-456-1230
      isMobile: true
    otherPhones:
      home:
        countryCode: "+1"
        number: 333-456-1230
        isMobile: false
description: A collection of phone numbers for a person.
$defs:
  RecordPhone:
    type: object
    properties: {}
    unevaluatedProperties:
      $ref: Phone.yaml

TypeSpec

/** A collection of phone numbers for a person. */
@example(Examples.Phone.personalCollection)
@example(Examples.Phone.orgCollection)
@Versioning.added(Versions.v0_1)
model PhoneCollection {
  /** The person's primary phone number. */
  primary: Fields.Phone;

  /** The person's fax number, if applicable. */
  fax?: Fields.Phone;

  /** Additional phone numbers not covered by the standard fields. */
  otherPhones?: Record<Fields.Phone>;
}