[Index]

Model: device/spark/Number

Model Details: device/spark/Number

Title Description Details
ID
  • Field Name: id
  • Type: String
Phone Number * A unique identifier for the PSTN phone number.
  • Field Name: phoneNumber
  • Type: String
Extension Extension for a PSTN phone number.
  • Field Name: extension
  • Type: String
State * Phone number's state.
  • Field Name: state
  • Type: String
  • Choices: ["ACTIVE", "INACTIVE"]
Phone Number Type Type of phone number.
  • Field Name: phoneNumberType
  • Type: String
Main Number Indicates if the phone number is used as location clid.
  • Field Name: mainNumber
  • Type: Boolean
Toll-Free Number Indicates if a phone number is a toll-free number.
  • Field Name: tollFreeNumber
  • Type: Boolean
Location An object representing the location for the phone number.
  • Field Name: location
  • Type: Object
Location ID * ID of location for phone number.
  • Field Name: location.id
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Location Name Name of the location for phone number.
  • Field Name: location.name
  • Type: String
Owner An object representing the owner to which the PSTN phone number is assigned.
  • Field Name: owner
  • Type: Object
Owner ID ID of the owner to which PSTN Phone number is assigned.
  • Field Name: owner.id
  • Type: String
Owner Type Type of the PSTN phone number's owner.
  • Field Name: owner.type
  • Type: String
Owner First Name First name of the PSTN phone number's owner.
  • Field Name: owner.firstName
  • Type: String
Owner Last Name Last name of the PSTN phone number's owner.
  • Field Name: owner.lastName
  • Type: String