{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Location Call Settings API", "version": "1.0.0" }, "items": [ { "info": { "name": "Location Call Settings", "type": "folder" }, "items": [ { "info": { "name": "Read the List of Dial Patterns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId/dialPatterns", "params": [ { "name": "dialPlanId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the dial plan." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization to which the dial patterns belong." }, { "name": "dialPattern", "value": "+5555", "type": "query", "description": "An enterprise dial pattern is represented by a sequence of digits (1-9), followed by optional wildcard characters.\nValid wildcard characters are `!` (matches any sequence of digits) and `X` (matches a single digit, 0-9).\nThe `!` wildcard can only occur once at the end and only in an E.164 pattern\n" }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "dialPattern-desc", "type": "query", "description": "Order the dial patterns according to the designated fields. Available sort fields: `dialPattern`." } ] }, "docs": "List all Dial Patterns for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `" }, { "info": { "name": "List Locations Webex Calling Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List locations for this organization." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of locations in the response." }, { "name": "start", "value": "0", "type": "query", "description": "Specify the offset from the first result that you want to fetch." }, { "name": "name", "value": "Denver", "type": "query", "description": "List locations whose name contains this string." }, { "name": "order", "value": "name-asc", "type": "query", "description": "Sort the list of locations based on `name`, either asc or desc." } ] }, "docs": "Lists Webex Calling locations for an organization with Webex Calling details.\n\nSearching and viewing locations with Webex Calling details in your\norganization require an administrator auth token with the\n`spark-admin:telephony_config_read` scope." }, { "info": { "name": "Enable a Location for Webex Calling", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable a location by adding it to Webex Calling. This add Webex Calling support to a\nlocation created created using the POST /v1/locations API.\n\nLocations are used to support calling features which can be defined at the location level.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Location Webex Calling Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Retrieve Webex Calling location attributes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve Webex Calling location attributes for this organization." } ] }, "docs": "Shows Webex Calling details for a location, by ID.\n\nSpecifies the location ID in the locationId parameter in the URI.\n\nSearching and viewing locations in your organization requires an administrator auth token with the spark-admin:telephony_config_read scope." }, { "info": { "name": "Update Location Webex Calling Details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Updating Webex Calling location attributes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Updating Webex Calling location attributes for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Webex Calling details for a location, by ID.\n\nSpecifies the location ID in the `locationId` parameter in the URI.\n\nModifying the `connection` via API is only supported for the local PSTN types of `TRUNK` and `ROUTE_GROUP`.\n\nUpdating a location in your organization requires an administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Get a List of Update Routing Prefix jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of update routing prefix jobs in this organization." } ] }, "docs": "Get the list of all update routing prefix jobs in an organization.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to retrieve all the update routing prefix jobs in an organization.\n\nRetrieving the list of update routing prefix jobs in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get the job status of Update Routing Prefix job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI", "type": "path", "description": "Retrieve job status for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Check update routing prefix job status in this organization." } ] }, "docs": "Get the status of the update routing prefix job by its job ID.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to check the status of update routing prefix job by job ID in an organization.\n\nChecking the status of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get job errors for update routing prefix job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI", "type": "path", "description": "Retrieve job errors for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of errors for update routing prefix job in this organization." } ] }, "docs": "GET job errors for the update routing prefix job in an organization.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to retrieve all the errors of the update routing prefix job by job ID in an organization.\n\nRetrieving all the errors of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Change Announcement Language", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/modifyAnnouncementLanguage/invoke", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Change announcement language for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Change announcement language for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change announcement language for the given location.\n\nChange announcement language for current people/workspaces and/or existing feature configurations. This does not change the default announcement language which is applied to new users/workspaces and new feature configurations.\n\nChanging the announcement language for the given location requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Location Emergency callback number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/features/emergencyCallbackNumber", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Update location attributes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update location attributes for this organization." } ] }, "docs": "Get location emergency callback number.\n\n* To retrieve location callback number requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update a Location Emergency callback number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/features/emergencyCallbackNumber", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Update location attributes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update location attributes for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details for a location emergency callback number.\n\n* Updating a location callback number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Validate the List of Extensions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/actions/validateExtensions/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Validate Extension for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates the list of Extensions provided by the customer at the organization level. It checks the extension meets the current extension length limits and does not conflict with the extensions of organization-level entities and settings. To check for extension use across all locations, use the [Get Phone Numbers](/v1/telephony/config/numbers) API. To validate an extension and check for conflicts for a specific location, use the [Validate Extensions](/docs/api/v1/location-call-settings/validate-e" }, { "info": { "name": "Validate Extensions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/validateExtensions/invoke", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Validate extensions for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Validate extensions for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate extensions for a specific location.\n\nValidating extensions requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Music On Hold", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/musicOnHold", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0fetchcllrjjejgghbruudtlknjbcleukhihhgFUSU9OLzMxMTYx", "type": "path", "description": "Retrieve music on hold settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve music on hold settings for this organization." } ] }, "docs": "Retrieve the location's music on hold settings.\n\nLocation music on hold settings allows you to play music when a call is placed on hold or parked.\n\nRetrieving a location's music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Music On Hold", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/musicOnHold", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Update music on hold settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update music on hold settings for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the location's music on hold settings.\n\nLocation music on hold settings allows you to play music when a call is placed on hold or parked.\n\nUpdating a location's music on hold settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Private Network Connect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/privateNetworkConnect", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Retrieve the network connection type for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve the network connection type for this organization." } ] }, "docs": "Retrieve the location's network connection type.\n\nNetwork Connection Type determines if the location's network connection is public or private.\n\nRetrieving a location's network connection type requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Private Network Connect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/privateNetworkConnect", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Update the network connection type for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update network connection type for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the location's network connection type.\n\nNetwork Connection Type determines if the location's network connection is public or private.\n\nUpdating a location's network connection type requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the List of Routing Choices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/routeChoices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List route identities for this organization." }, { "name": "routeGroupName", "value": "routeGroupName", "type": "query", "description": "Return the list of route identities matching the Route group name." }, { "name": "trunkName", "value": "trunkName", "type": "query", "description": "Return the list of route identities matching the Trunk name." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "my_test_trunk-asc|ROUTE_GROUP-desc", "type": "query", "description": "Order the route identities according to the designated fields. Available sort fields: `routeName`, `routeType`." } ] }, "docs": "List all Routes for the organization.\n\nTrunk and Route Group qualify as Route. Trunks and Route Groups provide you the ability to configure Webex Calling to manage calls between Webex Calling hosted users and premises PBX users. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get the List of Phone Numbers Available for External Caller ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/externalCallerId/availableNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw", "type": "path", "description": "Retrieve available external caller ID numbers for this location." }, { "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 provided list 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": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw", "type": "query", "description": "Retrieve available external caller ID numbers for this person. If `personId` is not provided it may result in the unsuccessful assignment of the returned number. This parameter has no effect when workspace or virtual line ID is used." } ] }, "docs": "Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a person, virtual line, or workspace) within the specified location.\nNumbers from the specified location are returned and cross location numbers are returned as well where the number's location has the same country, PSTN provider, and zone (only applicable for India locations) as the specified location.\nWhen `personId` is specified, and the person belongs to a cisco PSTN location, has a mobile" }, { "info": { "name": "Get Available Phone Numbers for a Location with Given Criteria", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/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." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as the location's main number.\nThese numbers are associated with the location specified in the request URL and can be active/inactive and assigned to an owning entity or unassigned.\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 or read-only administrator or loca" }, { "info": { "name": "Get Webex Go Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/webexGo/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." } ] }, "docs": "List standard numbers that are available to be assigned as the webex go phone number.\nThese numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.\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 administrator auth token with a scope of `spark-admin:teleph" }, { "info": { "name": "Get Location ECBN Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/emergencyCallbackNumber/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." } ] }, "docs": "List standard numbers that are available to be assigned as the location's emergency callback number.\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 administrator auth token wi" }, { "info": { "name": "Get Location Call Intercept Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callIntercept/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 phone numbers with the given `extension`." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as the location's call intercept number.\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 or read-only administrator or loc" }, { "info": { "name": "Read list of Receptionist Contact Directories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "List Receptionist Contact Directories for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List Receptionist Contact Directories for this organization." } ] }, "docs": "List all Receptionist Contact Directories for a location.\n\nReceptionist Contact Directories can be used to create named directories of users.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create a Receptionist Contact Directory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Add a Receptionist Contact Directory to this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Add a Receptionist Contact Directory to this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Receptionist Contact Directory for a location.\n\nReceptionist Contact Directories can be used to create named directories of users and/or location features (Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group).\n\nAdding a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get details for a Receptionist Contact Directory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Get a Receptionist Contact Directory from this location." }, { "name": "directoryId", "value": "Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh", "type": "path", "description": "Get details for the Receptionist Contact Directory with this identifier." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get a Receptionist Contact Directory from this organization." }, { "name": "searchCriteriaModeOr", "value": "true", "type": "query", "description": "When `true`, results matching any one of the search criteria are included. The value can only be `true` or not included in the request. Specifying `searchCriteriaModeOr` without any search criteria, or setting it to `false` results in an `ErrorResponse`. If no search criteria is specified, all results are returned." }, { "name": "firstName", "value": "John", "type": "query", "description": "Search for directories that contain people with the indicated first name." }, { "name": "lastName", "value": "Doe", "type": "query", "description": "Search for directories that contain people with the indicated last name." }, { "name": "phoneNumber", "value": "+12225555309", "type": "query", "description": "Search for directories that contain people with the indicated phone number." }, { "name": "extension", "value": "5309", "type": "query", "description": "Search for directories that contain people with the indicated extension." }, { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU", "type": "query", "description": "Search for directories that contain people with the indicated person ID." } ] }, "docs": "Get details for a specific Receptionist Contact Directory from a location.\n\nReceptionist Contact Directories are uniquely named per location and contain directories of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups.\n\nThis API is currently supported for Webex calling organizations with fewer than 2000 users or location-based calling features. For organizations with more than 2000 users or location features, the API will throw an error 25395.\n\nRetrievi" }, { "info": { "name": "Modify a Receptionist Contact Directory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Modify list of Receptionist Contact Directories for this location." }, { "name": "directoryId", "value": "Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh", "type": "path", "description": "Get details for the Receptionist Contact Directory with this identifier." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify list of Receptionist Contact Directories for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Receptionist Contact Directories attached to a location. This modification will replace the existing list of contacts with the new incoming contacts list from the request body. The API does not support incremental updates.\n\nReceptionist Contact Directories can be used to create named groups of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups.\n\nModifying a directory requires a full or write-only administrator auth token with a scope of `spark-adm" }, { "info": { "name": "Delete a Receptionist Contact Directory", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Delete a Receptionist Contact Directory from this location." }, { "name": "directoryId", "value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvUkdseVpXTjBiM0o1VkdWemREY3lNRGMxOjJiOTQzMWIzLWMyYWUtNDhhYi1iMDQxLWE2ZThiMjY1NjJjOQ", "type": "path", "description": "Delete the Receptionist Contact Directory ID with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete a Receptionist Contact Directory from this organization." } ] }, "docs": "Delete a Receptionist Contact Directory from a location.\n\nReceptionist Contact Directories can be used to create named directories of users.\n\nDeleting a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Available Charge Numbers for a Location with Given Criteria", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/chargeNumber/availableNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg", "type": "path", "description": "Return the list of available charge 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." } ] }, "docs": "List the numbers that are available to be assigned as the location's charge number.\n\nThese numbers are non-toll-free and non-mobile numbers assigned to the location specified in the request URL.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get a List of Disable Calling Location Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List disable calling location jobs for this organization." }, { "name": "max", "value": "", "type": "query", "description": "Maximum number of jobs to return." }, { "name": "start", "value": "", "type": "query", "description": "Offset to start returning records from." } ] }, "docs": "Get a List of Disable Calling Location Jobs for the organization.\n\nRetrieving the list of disable calling location jobs requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Disable a Location for Webex Calling", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for disabling the location for Webex Calling." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable a Location for Webex Calling.\n\nInitiating a disable calling location job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\nThe API returns a jobId that can be used with other job-related APIs to track the status and progress of the disable operation." }, { "info": { "name": "Safe Delete Check Before Disabling a Location for Webex Calling", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/precheckForDeletion/invoke", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ", "type": "path", "description": "Unique identifier for the location to be checked." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for which the safe delete check operation is being performed." } ] }, "docs": "Performs a safe delete check operation to identify any issues that would prevent the calling location from being disabled. This API helps identify resources that need to be addressed before a calling location can be successfully disabled.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Pause a Disable Calling Location Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/actions/pause/invoke", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0", "type": "path", "description": "Unique identifier for the job to pause." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for which to pause the job." } ] }, "docs": "Pause an in-progress disable calling location job. The job must be in the PROCESSING state to be paused.\n\nPausing a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Resume a Paused Disable Calling Location Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/actions/resume/invoke", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0", "type": "path", "description": "Unique identifier for the job to resume." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for which to resume the job." } ] }, "docs": "Resume a previously paused disable calling location job. The job must be in the PAUSED state to be resumed.\n\nResuming a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Errors for a Disable Calling Location Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0", "type": "path", "description": "Unique identifier for the job to get errors for." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for disable calling location job." } ] }, "docs": "Retrieve detailed error information for a disable calling location job. This is particularly useful for jobs that have failed or encountered errors during processing.\n\nRetrieving job errors requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\nPossible error codes include:\n* `BATCH-1012002` - Unable to delete calling location from Broadworks.\n* `BATCH-1012004` - Safe delete checks failed.\n* `BATCH-1012005` - Failed to perform safe delete checks.\n* `BATCH-" }, { "info": { "name": "Get Disable Calling Location Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0", "type": "path", "description": "Unique identifier for the job." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for which to retrieve the job status." } ] }, "docs": "Get the status and details of a specific disable calling location job.\n\nRetrieving job status requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get the location call captions settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callCaptions", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the organization." } ] }, "docs": "Retrieve the location's call captions settings.\n\n**NOTE**: The call captions feature is not supported for locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update the location call captions settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callCaptions", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the location's call captions settings.\n\n**NOTE**: The call captions feature is not supported for locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." } ] } ], "bundled": true }