Webex · Schema

ApplicationsSetting

Application services settings for a user. Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
ringDevicesForClickToDialCallsEnabled	boolean	When `true`, indicates to ring devices for outbound Click to Dial calls.
ringDevicesForGroupPageEnabled	boolean	When `true`, indicates to ring devices for inbound Group Pages.
ringDevicesForCallParkEnabled	boolean	When `true`, indicates to ring devices for Call Park recalled.
browserClientEnabled	boolean	Indicates that the browser Webex Calling application is enabled for use.
browserClientId	string	Device ID of WebRTC client. Returns only if `browserClientEnabled` is true.
desktopClientEnabled	boolean	Indicates that the desktop Webex Calling application is enabled for use.
desktopClientId	string	Device ID of Desktop client. Returns only if `desktopClientEnabled` is true.
tabletClientEnabled	boolean	Indicates that the tablet Webex Calling application is enabled for use.
tabletClientId	string	Device ID of Tablet client. Returns only if `tabletClientEnabled` is true.
mobileClientEnabled	boolean	Indicates that the mobile Webex Calling application is enabled for use.
mobileClientId	string	Device ID of Mobile client. Returns only if `mobileClientEnabled` is true.
availableLineCount	number	Number of available device licenses for assigning devices/apps.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApplicationsSetting",
  "title": "ApplicationsSetting",
  "type": "object",
  "required": [
    "ringDevicesForClickToDialCallsEnabled",
    "ringDevicesForGroupPageEnabled",
    "ringDevicesForCallParkEnabled",
    "browserClientEnabled",
    "desktopClientEnabled",
    "tabletClientEnabled",
    "mobileClientEnabled",
    "availableLineCount"
  ],
  "properties": {
    "ringDevicesForClickToDialCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, indicates to ring devices for outbound Click to Dial calls."
    },
    "ringDevicesForGroupPageEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, indicates to ring devices for inbound Group Pages."
    },
    "ringDevicesForCallParkEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, indicates to ring devices for Call Park recalled."
    },
    "browserClientEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates that the browser Webex Calling application is enabled for use."
    },
    "browserClientId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQyNDM3YzY5LTBlNmYtNGMxZS1iMTJhLTFjNGYxZTk5NDRjMA",
      "description": "Device ID of WebRTC client. Returns only if `browserClientEnabled` is true."
    },
    "desktopClientEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates that the desktop Webex Calling application is enabled for use."
    },
    "desktopClientId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg",
      "description": "Device ID of Desktop client. Returns only if `desktopClientEnabled` is true."
    },
    "tabletClientEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates that the tablet Webex Calling application is enabled for use."
    },
    "tabletClientId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg",
      "description": "Device ID of Tablet client. Returns only if `tabletClientEnabled` is true."
    },
    "mobileClientEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates that the mobile Webex Calling application is enabled for use."
    },
    "mobileClientId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg",
      "description": "Device ID of Mobile client. Returns only if `mobileClientEnabled` is true."
    },
    "availableLineCount": {
      "type": "number",
      "example": 35,
      "description": "Number of available device licenses for assigning devices/apps."
    }
  },
  "description": "Application services settings for a user. Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app."
}