Telephone object representation

The telephone object representation and fields are described below.

telephone was introduced in API version V1

telephone has not been marked for deprecation

Endpoint usages

Telephone

Description

Representation of a telephone number

Example create representation

{
  "number" : "+447789012345",
  "type" : "Work mobile",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1",
    "addresses" : [ ]
  }
}

Example response representation

{
  "urn" : "9b6b78e0-d9e4-45c2-bc9d-4b507c506679",
  "url" : "/n/v1/telephone/9b6b78e0-d9e4-45c2-bc9d-4b507c506679",
  "number" : "+447789012345",
  "type" : "Work mobile",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1",
    "addresses" : [ ]
  }
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN for the telephone number
url	URL represented as a string	The URL for accessing the telephone number
number	String formatted telephone number.	The telephone number for the identity / person	Required on create.
type	String literal	Descriptive type for the telephone number	Optional.
identity	Identity	The identity associated with this telephone number	Required on create.