The phone number object

{
    "id": "phonenumber-001",
    "phoneNumber": "[phone]",
    "phoneType": "spouse",
    "lineType": "mobile",
    "lineStatus": "active",
    "note": "This is the spouse phone number"
}

Attributes

• id (string): A unique identifier for the phone number

• phoneNumber (string) : The phone number, in E.164 format

• phoneType (string) : The phone type (aka label) for the phone number (e.g work, spouse, relative)

• lineType (string, enum) : The line type of the phone number. Posible values are:

  • landline

  • mobile

  • voip

  • personal

  • tollFree

  • premium

  • sharedCost

  • uan (Universal Access Number)

  • voicemail

  • pager

  • unknown

• lineStatus (string, enum) : The current line status. Possible values are:

  • active

  • inactive

  • reachable

  • unreachable

  • unknown

• note (string) : A note attached to the phone number. Useful for adding more context.