{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Workspace Call Settings (2/2) API", "version": "1.0.0" }, "items": [ { "info": { "name": "Workspace Call Settings (2/2)", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Music On Hold Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/musicOnHold", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 the API." } ] }, "docs": "Retrieve Music On Hold Settings for a Workspace.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nRetrieving a workspace's music on hold settings requires a full, device or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Music On Hold Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/musicOnHold", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify music on hold settings for a Workspace.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nTo configure music on hold setting for a workspace, music on hold setting must be enabled for this location.\n\nThis API requires a full or device administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Delete a Specific Access Code for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/accessCodes/:accessCode", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." }, { "name": "accessCode", "value": "1234", "type": "path", "description": "Access code for outgoing calls." } ] }, "docs": "Deletes a specific access code for the given workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full, device or location administrator auth token with the scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve all Digit Patterns for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve all digit patterns for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Digit Pattern for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new digit pattern for the given workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Modify the Digit Pattern Category Control Settings for the Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies whether this workspace uses the specified digit patterns when placing outbound calls or not.\n\nUpdating the digit pattern category control settings requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete all Digit Patterns for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete all digit patterns for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve a Digit Pattern details for the Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve the designated digit pattern.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Digit Pattern for the Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the designated digit pattern.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Digit Pattern for the Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete a digit pattern for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Upload Call Intercept Announcement file for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/intercept/actions/announcementUpload/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create an announcement in this organization." }, { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." } ] }, "docs": "Upload call intercept announcement file for a workspace.\n\nThe upload announcement feature for a call intercept is used to play custom announcements for a workspace.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full, device or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Call Recording Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/callRecordings", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve call recording settings for a workspace.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full, read-only, device or location administrator auth token with the `spark-admin:telephony_config_read` scope." }, { "info": { "name": "Modify Call Recording Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/callRecordings", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify call forwarding settings for a workspace.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThe vendor's terms of service have to be accepted to enable call recording. Vendor details along with the terms of service URL are shared when the vendor's terms of service are not accepted yet.\n\nThis API requires a full, device" }, { "info": { "name": "Get Workspace Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/availableNumbers", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List numbers for this organization." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg", "type": "query", "description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36." }, { "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 a workspace's phone number.\nBy default, this API returns numbers from all locations that are unassigned. To select the suitable number for assignment, ensure the workspace's location ID is provided as the `locationId` request parameter.\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 fu" }, { "info": { "name": "Get Workspace ECBN Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber/availableNumbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 a workspace's emergency callback number.\nThese numbers are associated with the location of the workspace 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 administrat" }, { "info": { "name": "Get Workspace Call Forward Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callForwarding/availableNumbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 workspace's call forward number.\nThese numbers are associated with the location of the workspace 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 locat" }, { "info": { "name": "Get Workspace Call Intercept Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callIntercept/availableNumbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 workspace's call intercept number.\nThese numbers are associated with the location of the workspace 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 loc" }, { "info": { "name": "Retrieve Anonymous Call Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/anonymousCallReject", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Anonymous Call Settings for a Workspace.\n\nAnonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Modify Anonymous Call Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/anonymousCallReject", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Anonymous Call Settings for a Workspace.\n\nAnonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Retrieve Barge In Call Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/bargeIn", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Barge In Call Settings for a Workspace.\n\nBarge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed wo" }, { "info": { "name": "Modify Barge In Call Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/bargeIn", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Barge In Call Settings for a Workspace.\n\nBarge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed worksp" }, { "info": { "name": "Retrieve DoNotDisturb Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/doNotDisturb", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve DoNotDisturb Settings for a Workspace.\n\nSilence incoming calls with the Do Not Disturb feature.\nWhen enabled, callers hear the busy signal.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is available for professional and common area licensed workspaces." }, { "info": { "name": "Modify DoNotDisturb Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/doNotDisturb", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify DoNotDisturb Settings for a Workspace.\n\nSilence incoming calls with the Do Not Disturb feature.\nWhen enabled, callers hear the busy signal.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional and common area licensed workspaces." }, { "info": { "name": "Retrieve Call Bridge Warning Tone Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callBridge", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Call Bridge Warning Tone Settings for a Workspace.\n\nCall Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for profes" }, { "info": { "name": "Modify Call Bridge Warning Tone Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callBridge", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Call Bridge Warning Tone Settings for a Workspace.\n\nCall Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Read Push-to-Talk Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/pushToTalk", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ] }, "docs": "Retrieve Push-to-Talk settings for a workspace.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Configure Push-to-Talk Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/pushToTalk", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure Push-to-Talk settings for a workspace.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Retrieve Privacy Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/privacy", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Privacy Settings for a Workspace.\n\nThe privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` scope to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Modify Privacy Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/privacy", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Privacy Settings for a Workspace.\n\nThe privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Read Voicemail Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ] }, "docs": "Retrieve a workspace Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:works" }, { "info": { "name": "Configure Voicemail Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a workspace Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write" }, { "info": { "name": "Modify Voicemail Passcode for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:placeId/voicemail/passcode", "params": [ { "name": "placeId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzU2ZGIyNGQzLTdhN2EtNDBhMi05YWM5LWIyMzMyNzc5MjFO77+9", "type": "path", "description": "Modify voicemail passcode for this workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify voicemail passcode for a workspace in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify voicemail passcode for a workspace.\n\nModifying the voicemail passcode for a workspace requires a full administrator, device administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Sequential Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**N" }, { "info": { "name": "Modify Sequential Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This" }, { "info": { "name": "Delete Sequential Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**NOT" }, { "info": { "name": "Read Call Policy Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callPolicies", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ] }, "docs": "Retrieve a workspace Call Policies settings.\n\nThe call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Configure Call Policy Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callPolicies", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a workspace Call Policies settings.\n\nThe call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Configure Busy Voicemail Greeting for a Place", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadBusyGreeting/invoke", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Configure a workspace's Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Configure No Answer Voicemail Greeting for a Place", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadNoAnswerGreeting/invoke", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Configure a workspace's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Create Sequential Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This" }, { "info": { "name": "Retrieve Sequential Ring Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve sequential ring settings for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Modify Sequential Ring Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify sequential ring settings for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Retrieve Simultaneous Ring Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Simultaneous Ring Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSchedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOT" }, { "info": { "name": "Modify Simultaneous Ring Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Simultaneous Ring Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure the workspace phones of your choice to ring simultaneously.\nSchedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is o" }, { "info": { "name": "Retrieve Simultaneous Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_re" }, { "info": { "name": "Modify Simultaneous Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to" }, { "info": { "name": "Delete Simultaneous Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete simultaneous ring criteria Settings for a workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to" }, { "info": { "name": "Create Simultaneous Ring Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to" }, { "info": { "name": "Retrieve Selective Reject Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Reject Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read w" }, { "info": { "name": "Modify Selective Reject Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Reject Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update works" }, { "info": { "name": "Retrieve Selective Reject Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` " }, { "info": { "name": "Modify Selective Reject Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd" }, { "info": { "name": "Delete Selective Reject Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete Selective Reject criteria Settings for a workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd" }, { "info": { "name": "Create Selective Reject Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd" }, { "info": { "name": "Assign or Unassign numbers associated with a specific workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/numbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign or unassign alternate phone numbers associated with a specific workspace.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**" }, { "info": { "name": "Retrieve Selective Accept Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Accept Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for " }, { "info": { "name": "Modify Selective Accept Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Accept Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for prof" }, { "info": { "name": "Retrieve Selective Accept Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only avail" }, { "info": { "name": "Modify Selective Accept Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available " }, { "info": { "name": "Delete Selective Accept Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete Selective Accept criteria Settings for a workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available" }, { "info": { "name": "Create Selective Accept Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd" }, { "info": { "name": "Retrieve Priority Alert Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Priority Alert Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Configure Priority Alert Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a workspace Priority Alert Settings.\n\nThe priority alert feature enables administrator to configure priority alert settings for a professional workspace.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope that can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces." }, { "info": { "name": "Retrieve Priority Alert Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspac" }, { "info": { "name": "Modify Priority Alert Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa" }, { "info": { "name": "Delete Priority Alert Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete Priority Alert criteria Settings for a workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa" }, { "info": { "name": "Create Priority Alert Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa" }, { "info": { "name": "Retrieve Selective Forward Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Forward Call Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read wo" }, { "info": { "name": "Modify Selective Forward Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Forward Call Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update worksp" }, { "info": { "name": "Retrieve Selective Forward Criteria for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Retrieve Selective Forward Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to rea" }, { "info": { "name": "Modify Selective Forward Criteria for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Forward Call Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda" }, { "info": { "name": "Delete Selective Forward Criteria for a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ", "type": "path", "description": "Unique identifier for the criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ] }, "docs": "Delete Selective Forward Call criteria Settings for a workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda" }, { "info": { "name": "Create Selective Forward Criteria for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the workspace 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 the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Selective Forward Call Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda" }, { "info": { "name": "Get Workspace Fax Message Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/faxMessage/availableNumbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 a workspace's FAX message number.\nThese numbers are associated with the location of the workspace 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 scop" }, { "info": { "name": "Get Workspace Secondary Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/secondary/availableNumbers", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the workspace." }, { "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 a workspace's secondary number.\nThese numbers are associated with the location of the workspace 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 " } ] } ], "bundled": true }