Webex · Schema

GetWorkspaceCallbackNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
selected object Selected number type to configure emergency call back.
directLineInfo object Data relevant to the ECBN for this user/location/virtual line/hunt group.
locationECBNInfo object Data relevant to the user/place/virtual line/hunt group selected for ECBN for this location.
locationMemberInfo object Data relevant to the user/place/virtual line/hunt group selected for ECBN.
defaultInfo object Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene.
elinEnabled boolean Indicates whether this workspace is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of its devices.
View JSON Schema on GitHub

JSON Schema

webex-getworkspacecallbacknumberobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetWorkspaceCallbackNumberObject",
  "title": "GetWorkspaceCallbackNumberObject",
  "type": "object",
  "properties": {
    "selected": {
      "$ref": "#/components/schemas/ECBNSelectionType",
      "description": "Selected number type to configure emergency call back."
    },
    "directLineInfo": {
      "type": "object",
      "required": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "example": "18164196065",
          "description": "The callback phone number that is associated with the direct line."
        },
        "firstName": {
          "type": "string",
          "example": "backUpworkspace",
          "description": "First name of a user."
        },
        "lastName": {
          "type": "string",
          "example": ".",
          "description": "Last name of a user."
        },
        "effectiveLevel": {
          "$ref": "#/components/schemas/ECBNDirectLineEffectiveLevelType",
          "description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary."
        },
        "effectiveValue": {
          "type": "string",
          "example": "18164196065",
          "description": "The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable."
        },
        "quality": {
          "$ref": "#/components/schemas/ECBNQualityType",
          "description": "Used to represent whether a number is a recommended ECBN."
        }
      },
      "description": "Data relevant to the ECBN for this user/location/virtual line/hunt group."
    },
    "locationECBNInfo": {
      "type": "object",
      "required": [
        "lastName",
        "firstName"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "example": "18164196065",
          "description": "The callback phone number that is associated with the location's ECBN configuration."
        },
        "lastName": {
          "type": "string",
          "example": ".",
          "description": "Last name of the user or location member or `.`."
        },
        "effectiveLevel": {
          "$ref": "#/components/schemas/ECBNDirectLineEffectiveLevelType",
          "description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary."
        },
        "effectiveValue": {
          "type": "string",
          "example": "18164196065",
          "description": "The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable."
        },
        "quality": {
          "$ref": "#/components/schemas/ECBNQualityType",
          "description": "Used to represent whether a number is a recommended ECBN."
        },
        "firstName": {
          "type": "string",
          "example": "backUpworkspace",
          "description": "First name of the user or location member or group name."
        }
      },
      "description": "Data relevant to the user/place/virtual line/hunt group selected for ECBN for this location."
    },
    "locationMemberInfo": {
      "type": "object",
      "required": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "example": "18164196065",
          "description": "The callback phone number that is associated with member configured for the location ECBN."
        },
        "firstName": {
          "type": "string",
          "example": "backUpworkspace",
          "description": "First name of a user."
        },
        "lastName": {
          "type": "string",
          "example": ".",
          "description": "Last name of the user or location member or `.`."
        },
        "memberId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8wY2VlYjFmYy04ZmEyLTQ5OGEtYWM3Ni02N2MyZGQ3MGQ2ZGY=",
          "description": "Member ID of user/place/virtual line/hunt group within the location."
        },
        "effectiveLevel": {
          "$ref": "#/components/schemas/LocationMemberInfoEffectiveLevelType",
          "description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary."
        },
        "effectiveValue": {
          "type": "string",
          "example": "18164196065",
          "description": "The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable."
        },
        "quality": {
          "$ref": "#/components/schemas/ECBNQualityType",
          "description": "Used to represent whether a number is a recommended ECBN."
        },
        "memberType": {
          "$ref": "#/components/schemas/MemberType",
          "description": "Type of the member."
        }
      },
      "description": "Data relevant to the user/place/virtual line/hunt group selected for ECBN."
    },
    "defaultInfo": {
      "type": "object",
      "properties": {
        "effectiveValue": {
          "type": "string",
          "example": "18164196068",
          "description": "The field contains the ECBN number."
        },
        "quality": {
          "$ref": "#/components/schemas/ECBNQualityType",
          "description": "Used to represent whether a number is a recommended ECBN."
        }
      },
      "description": "Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene."
    },
    "elinEnabled": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether this workspace is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of its devices."
    }
  }
}