Skip to content

phonenumber.schema.md

Latest commit

 

History

History
174 lines (98 loc) · 3.84 KB

phonenumber.schema.md

File metadata and controls

174 lines (98 loc) · 3.84 KB
Raw

Phone number Schema

https://ns.adobe.com/xdm/context/phonenumber

Information that enables the contact of a person with a phone. Typically an alphanumeric number, 1-222-333-4444 in North America, but can have a wide range of formats.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/phonenumber.schema.json

Schema Hierarchy

  • Phone number https://ns.adobe.com/xdm/context/phonenumber

Phone number Example

{
  "xdm:primary": true,
  "xdm:number": "1-408-888-8888",
  "xdm:status": "active"
}

Phone number Properties

Property Type Required Default Defined by
xdm:extension string Optional Phone number (this schema)
xdm:number string Optional Phone number (this schema)
xdm:primary boolean Optional Phone number (this schema)
xdm:status string Optional "active" Phone number (this schema)
xdm:statusReason string Optional Phone number (this schema)
xdm:validity string Optional Phone number (this schema)
* any Additional this schema allows additional properties

xdm:extension

Extension

The internal dialing number used to call from a private exchange, operator, or switchboard.

xdm:extension

  • is optional
  • type: string
  • defined in this schema

xdm:extension Type

string

xdm:number

Number

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' for example, 1-353(0)18391111 or +613 9403600x1234.

xdm:number

  • is optional
  • type: string
  • defined in this schema

xdm:number Type

string

xdm:primary

Primary

Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: textMessaging, mobile, phone, home, work, unknown, and fax.

xdm:primary

  • is optional
  • type: boolean
  • defined in this schema

xdm:primary Type

boolean

xdm:status

Status

An indication as to the ability to use the phone number.

xdm:status

  • is optional
  • type: string
  • default: "active"
  • defined in this schema

xdm:status Type

string

xdm:status Known Values

Value Description
active Active
incomplete Incomplete
blacklisted Blacklisted
blocked Blocked

xdm:statusReason

Status reason

A description of the current status.

xdm:statusReason

  • is optional
  • type: string
  • defined in this schema

xdm:statusReason Type

string

xdm:validity

Validity

A level of technical correctness of the phone number.

xdm:validity

  • is optional
  • type: string
  • defined in this schema

xdm:validity Type

string

xdm:validity Known Values

Value Description
consistent Consistent
inconsistent Inconsistent
incomplete Incomplete
successfullyUsed Successfully used