{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Features: Operating Modes API", "version": "1.0.0" }, "items": [ { "info": { "name": "Features: Operating Modes", "type": "folder" }, "items": [ { "info": { "name": "Read the List of Operating Modes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/operatingModes", "params": [ { "name": "name", "value": "Day", "type": "query", "description": "List `operating modes` whose name contains this string." }, { "name": "limitToLocationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "query", "description": "Location query parameter to filter the `operating modes` from that location only." }, { "name": "limitToOrgLevelEnabled", "value": "true", "type": "query", "description": "If true, only return `operating modes` defined at the organization level." }, { "name": "max", "value": "", "type": "query", "description": "Maximum number of `operating modes` to return in a single page. `max` must be equal to, or greater than `1`, and equal to or less than `100`." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc", "type": "query", "description": "Sort the list of `operating modes` based on `name`, either asc, or desc." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve `operating modes` list from this organization." } ] }, "docs": "Retrieve `Operating Modes` list defined at location, or organization level. Use query parameters to filter the result set by location or level. The list returned is sorted in ascending order by operating mode name. Long result sets are split into [pages](/docs/basics#pagination).\n\n`Operating modes` help manage calls more efficiently by routing them based on predefined settings.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:tel" }, { "info": { "name": "Get Details for an Operating Mode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Get the `operating mode` with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get the `operating mode` from this organization." } ] }, "docs": "Retrieve an `Operating Mode` by `Operating Mode ID`.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nRetrieving an `operating mode` requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify an Operating Mode", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Modify the `operating mode` with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify the `operating mode` from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the designated `Operating Mode's` configuration.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nModifying an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete an Operating Mode", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Delete the `operating mode` with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the `operating mode` from this organization." } ] }, "docs": "Delete the designated `Operating Mode`.\n\nDeleting an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Create an Operating Mode", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/operatingModes/", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create the `operating mode` for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an `Operating Mode` at an organization, or a location level.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nCreating an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get details for an Operating Mode Holiday", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Get the holiday from this `operating mode` matching ID." }, { "name": "holidayId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ", "type": "path", "description": "Get the `operating mode Holiday` with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get the `operating mode` from this organization." } ] }, "docs": "Retrieve an `Operating Mode Holiday` by ID.\n\nHolidays define a recurring schedule for the `Operating Modes`.\n\nRetrieving an `Operating Mode Holiday` requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify an Operating Mode Holiday", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Modify the holiday from this `operating mode` matching ID." }, { "name": "holidayId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ", "type": "path", "description": "Modify the `Holiday` with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify the `operating mode` from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the designated `Operating Mode Holiday's` configuration.\n\nModifying an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete an Operating Mode Holiday", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Delete the holiday from this `operating mode` matching ID." }, { "name": "holidayId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ", "type": "path", "description": "Delete the holiday with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the `operating mode` from this organization." } ] }, "docs": "Delete the designated `Operating Mode Holiday`.\n\nDeleting an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Create an Operating Mode Holiday", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays", "params": [ { "name": "modeId", "value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg", "type": "path", "description": "Create the holiday for this `operating mode`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create the `operating mode holiday` for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a holiday schedule event for the designated `Operating Mode`.\n\nHolidays define a recurring schedule for the `Operating Modes`. An `Operating Mode` can have a max of 150 holidays.\n\nCreating an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve the List of Available Operating Modes in a Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/operatingModes/availableOperatingModes", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Retrieve `operating modes` list from this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve `operating modes` list from this organization." } ] }, "docs": "Retrieve list of `Operating Modes` which are available to be assigned to a location level feature (`Auto Attendant`, `Call Queue`, or `Hunt Group`). Since each location and an org can have a max of 100 `Operating Modes` defined. The max number of `operating modes` that can be returned is 200.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc. for the `Auto Attendant`, `Call Queue`, and `Hunt Group` features.\n\nRetri" }, { "info": { "name": "Get Operating Mode Call Forward Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/operatingModes/callForwarding/availableNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg", "type": "path", "description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List numbers for this organization." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of phone numbers returned to this maximum count. The default is 2000." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching phone numbers. The default is 0." }, { "name": "phoneNumber", "value": "+12056852221,+12056852222", "type": "query", "description": "Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array." }, { "name": "ownerName", "value": "Test", "type": "query", "description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255." }, { "name": "extension", "value": "1234", "type": "query", "description": "Returns the list of PSTN phone numbers with the given `extension`." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as a operating mode's call forward number.\n\nThese numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location adminis" } ] } ], "bundled": true }