phonenumber.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/phonenumber",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Phone Number",
  "type": "object",
  "meta:extensible": true,
  "description":
    "Information that allows the phone calling of a person. Typically an alphanumeric number, 1-222-333 4444 in North America, but can have a wide range of formats.",
  "definitions": {
    "phonenumber": {
      "properties": {
        "xdm:primary": {
          "title": "Primary",
          "type": "boolean",
          "description":
            "Primary phone number indicator.\n\nUnlike for Address or EmailAddress, there can be multiple primary phone numbers; one per communication channel.\nThe communication channel is defined by the type:\n\n* `textMessaging`: type = `mobile`\n* `phone`: type = `home` | `work` | `unknown`\n* `fax`: type = `fax`\n"
        },
        "xdm:number": {
          "title": "Number",
          "type": "string",
          "description":
            "The phone number. Note the phone number is a string and may include meaningful characters such as brackets (), hyphens - or characters to indicate sub dialing identifiers like extensions x. E.g 1-353(0)18391111 or +613 9403600x1234."
        },
        "xdm:extension": {
          "title": "Extension",
          "type": "string",
          "description":
            "The internal dialing number used to call from a private exchange, operator or switchboard."
        },
        "xdm:status": {
          "title": "Status",
          "type": "string",
          "description":
            "An indication as to the ability to use the phone number.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          }
        },
        "xdm:statusReason": {
          "title": "Status Reason",
          "type": "string",
          "description": "A description of the current status."
        },
        "xdm:validity": {
          "title": "Validity",
          "type": "string",
          "description":
            "A level of technical correctness of the phone number.",
          "meta:enum": {
            "consistent": "Consistent",
            "inconsistent": "Inconsistent",
            "incomplete": "Incomplete",
            "successfullyUsed": "Successfully Used"
          }
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/phonenumber"
    }
  ],
  "meta:status": "stabilizing"
}