Webex for UCM
Webex for Unified CM (UCM) API for managing on-premises Cisco Unified Communications Manager integration with Webex cloud services. Supports hybrid calling configurations.
OpenAPI Specification
{
"openapi": "3.0.0",
"info": {
"title": "Webex for UCM",
"version": "1.0.0",
"description": "The Webex for UCM APIs provide integration points for Cisco Unified Communications Manager (UCM) environments, enabling hybrid calling, user management, device provisioning, and migration to the Webex cloud. These APIs support seamless connectivity between on-premises UCM and Webex cloud services, allowing organizations to extend calling capabilities, automate provisioning, synchronize user data, and enable advanced collaboration features. The APIs are ideal for hybrid deployments and gradual cloud migration strategies."
},
"tags": [],
"paths": {
"/telephony/config/callingProfiles": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"callingProfiles"
],
"properties": {
"callingProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetManagerProfileObject"
},
"description": "Array of manager profiles."
}
}
},
"example": {
"callingProfiles": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS8zMDg3ZmVhMC02MGM3LTQyZmEtODNjYi0zNTZjNDA3ZDYwZGU",
"name": "UC Profile1"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9mNDU2YzMxYy0yZTdkLTExZWItYjIwZS02MzBmNTA1NzliNzE",
"name": "UC Profile2"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Read the List of UC Manager Profiles",
"operationId": "Read the List of UC Manager Profiles",
"description": "List all calling UC Manager Profiles for the organization.\n\nUC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM).\n\nThe UC Manager Profile has an organization-wide default and may be overridden for individual persons, although currently only setting at a user level is supported by Webex APIs.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:people_read` as this API is designed to be used in conjunction with calling behavior at the user level.",
"tags": [
"UCM Profile"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List manager profiles in this organization.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"AcdObject": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"AcdObjectDevice": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"ActivationStates": {
"type": "string",
"enum": [
"activating",
"activated",
"deactivated"
],
"description": " * `activating` - Device is activating using an activation code.\n * `activated` - Device has been activated using an activation code.\n * `deactivated` - Device has not been activated using an activation code.\n"
},
"AdminBatchStartJobObjectLocationCustomizations": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA'",
"description": "Location within an organization where changes of device setings will be applied to all the devices within it."
},
"locationCustomizationsEnabled": {
"type": "boolean",
"description": "Indicates if all the devices within this location will be customized with new requested customizations(if set to `true`) or will be overridden with the one at organization level (if set to `false` or any other value). This field has no effect when the job is being triggered at organization level."
},
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Indicates the settings for ATA devices, DECT devices and MPP devices."
}
}
},
"AtaDtmfMethodObject": {
"type": "string",
"enum": [
"INBAND",
"AVT",
"AUTO"
],
"description": " * `INBAND` - Sends DTMF by using the audio path.\n * `AVT` - Audio video transport. Sends DTMF as AVT events.\n * `AUTO` - Uses InBand or AVT based on the outcome of codec negotiation.\n"
},
"AtaDtmfModeObject": {
"type": "string",
"enum": [
"STRICT",
"NORMAL"
],
"description": " * `STRICT` - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.\n * `NORMAL` - Normal threshold mode.\n"
},
"AudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AuthenticationMethodObject": {
"type": "string",
"enum": [
"NONE",
"EAP_FAST",
"PEAP_GTC",
"PEAP_MSCHAPV2",
"PSK",
"WEP"
],
"description": " * `NONE` - No authentication.\n * `EAP_FAST` - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.\n * `PEAP_GTC` - Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.\n * `PEAP_MSCHAPV2` - Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.\n * `PSK` - Pre-Shared Key. Requires shared passphrase for authentication.\n * `WEP` - Wired Equivalent Privacy. Requires encryption key for authentication.\n"
},
"BackgroundImage": {
"type": "string",
"enum": [
"NONE",
"DARK_BLUE",
"CISCO_DARK_BLUE",
"WEBEX_DARK_BLUE",
"CUSTOM_BACKGROUND"
],
"description": " * `NONE` - Indicates that there will be no background image set for the devices.\n * `DARK_BLUE` - Indicates that dark blue background image will be set for the devices.\n * `CISCO_DARK_BLUE` - Indicates that Cisco themed dark blue background image will be set for the devices.\n * `WEBEX_DARK_BLUE` - Indicates that Cisco Webex dark blue background image will be set for the devices.\n * `CUSTOM_BACKGROUND` - Indicates that a custom background image will be set for the devices.\n * `customUrl` - When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.\n"
},
"BackgroundImageColor": {
"type": "string",
"enum": [
"CYAN_DARK",
"PURPLE_DARK",
"BLUE_DARK",
"VIOLET_DARK",
"BLUE_LIGHT",
"VIOLET_LIGHT"
],
"description": " * `CYAN_DARK` - Indicates that dark cyan background image will be set for the devices.\n * `PURPLE_DARK` - Indicates the dark purple background image will be set for the devices.\n * `BLUE_DARK` - Indicates the dark blue background image will be set for the devices.\n * `VIOLET_DARK` - Indicates the dark violet background image will be set for the devices.\n * `BLUE_LIGHT` - Indicates the light blue background image will be set for the devices.\n * `VIOLET_LIGHT` - Indicates the light violet background image will be set for the devices.\n"
},
"BacklightTimer68XX": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimer68XXDevice": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimerObject": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BacklightTimerObjectDevice": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BluetoothObject": {
"type": "object",
"required": [
"enabled",
"mode"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Select a Bluetooth mode."
},
"PHONE": {
"type": "string"
},
"HANDS_FREE": {
"type": "string"
},
"BOTH": {
"type": "string"
}
}
},
"BluetoothObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE",
"HANDS_FREE",
"BOTH"
],
"description": "Select a Bluetooth mode."
}
}
},
"CallForwardExpandedSoftKey": {
"type": "string",
"enum": [
"ONLY_THE_CALL_FORWARD_ALL",
"ALL_CALL_FORWARDS"
],
"description": " * `ONLY_THE_CALL_FORWARD_ALL` - Set the default call forward expanded soft key behavior to single option.\n * `ALL_CALL_FORWARDS` - Set the default call forward expanded soft key behavior to multiple menu option.\n"
},
"CallHistoryMethod": {
"type": "string",
"enum": [
"WEBEX_UNIFIED_CALL_HISTORY",
"LOCAL_CALL_HISTORY"
],
"description": " * `WEBEX_UNIFIED_CALL_HISTORY` - Set call history to use the unified call history from all of the end user's devices.\n * `LOCAL_CALL_HISTORY` - Set call history to use local device information only.\n"
},
"CommSecurityType": {
"type": "string",
"enum": [
"NONE",
"SSL",
"STARTTLS"
],
"description": " * `NONE` - Sets the LDAP server security protocol to None.\n * `SSL` - Sets the LDAP server security protocol to SSL.\n * `STARTTLS` - Sets the LDAP server security protocol to STARTTLS.\n"
},
"Compression": {
"type": "string",
"enum": [
"ON",
"OFF"
],
"description": " * `ON` - Minimize data use during compression.\n * `OFF` - Ignore data use during compression.\n"
},
"CountObject": {
"type": "object",
"required": [
"totalNumbers",
"numbersDeleted",
"numbersMoved",
"numbersFailed"
],
"properties": {
"totalNumbers": {
"type": "number",
"description": "Indicates the total number of phone numbers requested to be moved."
},
"numbersDeleted": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully deleted."
},
"numbersMoved": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully moved."
},
"numbersFailed": {
"type": "number",
"description": "Indicates the total number of phone numbers failed."
}
}
},
"CustomizationDeviceLevelObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationDeviceLevelObjectDevice": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObjectDevice",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObjectDevice",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObjectDevice",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Settings that are applicable to ATA devices."
},
"dect": {
"$ref": "#/components/schemas/dectObject",
"description": "Settings that are applicable to DECT devices."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Settings that are applicable to MPP devices."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Settings that are applicable to WiFi."
}
}
},
"DectAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G729",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G711a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"DectDeviceList": {
"type": "object",
"required": [
"model",
"displayName"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco DBS110",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "Cisco DECT 210 Base",
"description": "Display name of the device."
},
"numberOfBaseStations": {
"type": "number",
"example": 250,
"description": "Indicates number of base stations."
},
"numberOfLinePorts": {
"type": "number",
"example": 1000,
"description": "Indicates number of port lines,"
},
"numberOfRegistrationsSupported": {
"type": "number",
"example": 30,
"description": "Indicates number of supported registrations."
}
}
},
"DectVlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the VLAN object of DECT is enabled."
},
"value": {
"type": "number",
"description": "Value of the VLAN Object of DECT."
}
}
},
"DefaultLoggingLevelObject": {
"type": "string",
"enum": [
"STANDARD",
"DEBUGGING"
],
"description": " * `STANDARD` - Enables standard logging.\n * `DEBUGGING` - Enables detailed debugging logging.\n"
},
"DeviceActivationStates": {
"type": "string",
"enum": [
"ACTIVATING",
"ACTIVATED",
"DEACTIVATED"
],
"description": " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n"
},
"DeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObject",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a location level. If `true`, customized at a location level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DeviceSettingsObjectForDeviceLevel": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If `true`, customized at a device level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DirectoryMethod": {
"type": "string",
"enum": [
"XSI_DIRECTORY",
"WEBEX_DIRECTORY"
],
"description": " * `XSI_DIRECTORY` - Set directory services to use standard XSI query method from the device.\n * `WEBEX_DIRECTORY` - Set directory services to use the Webex Enterprise directory.\n"
},
"DisplayCallqueueAgentSoftkeysObject": {
"type": "string",
"enum": [
"FRONT_PAGE",
"LAST_PAGE"
]
},
"DisplayNameSelection": {
"type": "string",
"enum": [
"PERSON_NUMBER",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_NUMBER` - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"GetMemberResponse": {
"type": "object",
"required": [
"model",
"maxLineCount"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco 192",
"description": "Model type of the device."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberObject"
},
"description": "List of members that appear on the device."
},
"maxLineCount": {
"type": "number",
"example": 10,
"description": "Maximum number of lines available for the device."
}
}
},
"Hoteling": {
"type": "object",
"required": [
"enabled",
"limitGuestUse"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"UserHotelingRequestPatch": {
"type": "object",
"required": [
"hoteling"
],
"properties": {
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Modify person Device Hoteling Setting."
}
}
},
"HotelingRequest": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"HttpProxyObject": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled",
"host",
"port",
"packUrl",
"authSettingsEnabled",
"username",
"password"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example"
# --- truncated at 32 KB (360 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-ucm-openapi.json