MemberObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MemberObject",
  "title": "MemberObject",
  "type": "object",
  "required": [
    "id",
    "firstName",
    "lastName",
    "primaryOwner",
    "port",
    "lineType",
    "lineWeight",
    "hotlineEnabled",
    "hotlineDestination",
    "allowCallDeclineEnabled",
    "memberType"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
      "description": "Unique identifier for the member."
    },
    "firstName": {
      "type": "string",
      "example": "John",
      "description": "First name of a person or workspace."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name of a person or workspace."
    },
    "phoneNumber": {
      "type": "string",
      "example": "2055552221",
      "description": "Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update."
    },
    "extension": {
      "type": "string",
      "example": "000",
      "description": "Extension of a person or workspace."
    },
    "routingPrefix": {
      "type": "string",
      "example": "1234",
      "description": "Routing prefix of location."
    },
    "esn": {
      "type": "string",
      "example": "1234000",
      "description": "Routing prefix + extension of a person or workspace."
    },
    "primaryOwner": {
      "type": "boolean",
      "example": true,
      "description": "This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
    },
    "port": {
      "type": "number",
      "example": 1,
      "description": "Port number assigned to person or workspace."
    },
    "t38FaxCompressionEnabled": {
      "type": "boolean",
      "description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
    },
    "lineType": {
      "$ref": "#/components/schemas/LineType",
      "description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
    },
    "lineWeight": {
      "type": "number",
      "example": 1,
      "description": "Number of lines that have been configured for the person on the device."
    },
    "hostIP": {
      "type": "string",
      "example": "10.0.0.45",
      "description": "Registration Host IP address for the line port."
    },
    "remoteIP": {
      "type": "string",
      "example": "192.102.12.84",
      "description": "Registration Remote IP address for the line port."
    },
    "hotlineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
    },
    "hotlineDestination": {
      "type": "string",
      "example": "+12055552222",
      "description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
    },
    "allowCallDeclineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
    },
    "lineLabel": {
      "type": "string",
      "example": "share line label",
      "description": "Device line label."
    },
    "linePort": {
      "type": "string",
      "example": "evypzco5ds@55552222.int10.bcld.webex.com",
      "description": "SIP username used in SIP signaling, for example, in registration."
    },
    "memberType": {
      "$ref": "#/components/schemas/MemberType",
      "description": "Indicates if the member is of type `PEOPLE` or `PLACE`."
    },
    "location": {
      "$ref": "#/components/schemas/location",
      "description": "Location object having a unique identifier for the location and its name."
    }
  }
}