{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Mode Management API", "version": "1.0.0" }, "items": [ { "info": { "name": "Mode Management", "type": "folder" }, "items": [ { "info": { "name": "Get Mode Management Features", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a list of all mode management features (Auto Attendants, Call Queues, and Hunt Groups) for which the authenticated user has been designated as a mode manager. This API returns basic information about each feature including its ID, name, and type.\n\nMode Management allows designated managers to switch features between different operational configurations based on time schedules or manual triggers. This is useful for managing business hours, holidays, and emergency scenarios.\n\nThis API re" }, { "info": { "name": "Get Common Modes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/commonModes", "params": [ { "name": "featureIds", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "query", "description": "List of feature IDs (comma-separated) for auto attendants, call queues, or hunt groups" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a list of common operating mode names that are shared across multiple specified features. This API accepts a list of feature IDs and returns only the mode names that exist in all of the specified features, allowing managers to switch multiple features to the same mode simultaneously.\n\nCommon modes are useful when you need to coordinate operational changes across multiple features. For example, switching an entire office to \"Holiday\" mode across all Auto Attendants and Call Queues at on" }, { "info": { "name": "Switch Mode for Multiple Features", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/actions/switchMode/invoke", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Switches the operating mode for multiple features simultaneously by specifying a common mode name. This API accepts a list of feature IDs and sets all of them to the specified operating mode, provided that mode exists for all features.\n\nThis bulk operation is particularly useful for coordinating operational changes across an organization, such as activating holiday modes, emergency procedures, or after-hours configurations across multiple Auto Attendants, Call Queues, and Hunt Groups at once.\n\nT" }, { "info": { "name": "Get Mode Management Feature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves detailed information about a specific mode management feature including its current operating mode and exception status. This API provides the feature's ID, name, type, current operating mode ID, and whether it is currently in an exception mode.\n\nException mode indicates that the feature has been manually switched to a different mode than what its schedule dictates. This information is critical for mode managers to understand the current state of their features.\n\nThis API requires a us" }, { "info": { "name": "Get Normal Operation Mode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/normalOperationMode", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves the current normal operating mode that the feature is scheduled to be in based on its time schedules. This represents the mode the feature would be in if no manual exceptions or overrides were active.\n\nThe normal operation mode is determined by the feature's configured schedules and may differ from the actual current operating mode if a manual exception has been applied. This API helps managers understand what the scheduled behavior is versus the actual current state.\n\nThis API require" }, { "info": { "name": "Get Operating Mode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/modes/:modeId", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." }, { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzAyZjZlMmI4LTFjZDktNWI3ZS1jOTVjLTczYzZkYzk1MTZjMg==", "type": "path", "description": "Unique identifier for the operating mode." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves detailed information about a specific operating mode for a feature, including the mode's ID and name. This API allows managers to get the details of any operating mode configured for a feature.\n\nOperating modes define different configurations for how a feature behaves (e.g., business hours routing vs. after-hours routing). Each mode has a unique ID and a descriptive name that helps managers identify its purpose.\n\nThis API requires a user auth token with the `spark:telephony_config_read" }, { "info": { "name": "Switch to Normal Operation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/switchToNormalOperation/invoke", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Switches the feature back to its normal scheduled operation mode, removing any manual exceptions or overrides that may be active. This returns the feature to operating according to its configured time schedules.\n\nThis operation is useful when a temporary manual mode change (exception) is no longer needed and you want to restore automatic schedule-based operation. It effectively cancels any active manual mode switches.\n\nThis API requires a user auth token with the `spark:telephony_config_write` s" }, { "info": { "name": "Switch Mode for Single Feature", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/switchMode/invoke", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Switches the operating mode for a single feature to a specified mode, either temporarily or with manual switchback. This API creates an exception to the feature's normal scheduled operation, allowing managers to manually control the feature's behavior.\n\nYou can configure whether the mode switch is temporary (automatically reverts based on schedule) or requires manual switchback. This is useful for handling unexpected situations like emergency closures, special events, or unscheduled breaks.\n\nThi" }, { "info": { "name": "Extend Current Operating Mode Duration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", "params": [ { "name": "featureId", "value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw", "type": "path", "description": "Unique identifier for the feature." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Extends the duration of the current operating mode by adding additional time before it expires or reverts to scheduled operation. This API allows managers to prolong a temporary mode change without having to switch modes again.\n\nExtension time can be specified in 30-minute increments up to 720 minutes (12 hours). If no extension time is provided, the mode is extended with a manual switchback exception, meaning it will remain active until manually changed.\n\nThis API requires a user auth token wit" } ] } ], "bundled": true }