Webex · Schema

GetPersonCallbackNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
selected	object	Selected number type to configure emergency callback.
directLineInfo	object	Data relevant to the ECBN for this user/location/virtual line/hunt group.
locationECBNInfo	object	Data relevant to the ECBN for this user/location/virtual line/hunt group.
locationMemberInfo	object	Data relevant to the ECBN for this user/location/virtual line/hunt group.
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 person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of their devices.
elinForWebexAppEnabled	boolean	Indicates whether this person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made using Webex App.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPersonCallbackNumberObject",
  "title": "GetPersonCallbackNumberObject",
  "type": "object",
  "properties": {
    "selected": {
      "$ref": "#/components/schemas/ECBNSelectionType",
      "description": "Selected number type to configure emergency callback."
    },
    "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": "User1",
          "description": "First name of the user."
        },
        "lastName": {
          "type": "string",
          "example": "User1LastName",
          "description": "Last name of the 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": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "firstName": {
          "type": "string",
          "example": "group1",
          "description": "First name of the user or location member or group name."
        },
        "lastName": {
          "type": "string",
          "example": ".",
          "description": "Last name of the user or location member or `.`."
        },
        "phoneNumber": {
          "type": "string",
          "example": "18164196066",
          "description": "The callback phone number that is associated with the location's ECBN configuration."
        },
        "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": "18164196066",
          "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."
    },
    "locationMemberInfo": {
      "type": "object",
      "required": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "example": "18164196067",
          "description": "The callback phone number that is associated with member configured for the location ECBN."
        },
        "firstName": {
          "type": "string",
          "example": "workspace1",
          "description": "First name of the user."
        },
        "lastName": {
          "type": "string",
          "example": ".",
          "description": "Last name of the user or `.`."
        },
        "memberId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg",
          "description": "Member ID of user/place/virtual line/hunt group within the location"
        },
        "memberType": {
          "$ref": "#/components/schemas/MemberType",
          "description": "Type of the member."
        },
        "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": "18164196067",
          "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."
    },
    "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 person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of their devices."
    },
    "elinForWebexAppEnabled": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether this person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made using Webex App."
    }
  }
}