{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Location Call Settings: Call Handling API", "version": "1.0.0" }, "items": [ { "info": { "name": "Location Call Settings: Call Handling", "type": "folder" }, "items": [ { "info": { "name": "Generate example password for Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/generatePassword/invoke", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Location for which example password has to be generated." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the location belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates an example password using the effective password settings for the location. If you don't specify anything in the `generate` field or don't provide a request body, then you will receive a SIP password by default.\n\nUsed while creating a trunk and shouldn't be used anywhere else.\n\nGenerating an example password requires a full or write-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the Internal Dialing configuration for a location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/internalDialing", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "location for which internal calling configuration is being requested" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List route identities for this organization." } ] }, "docs": "Get current configuration for routing unknown extensions to the Premises as internal calls\n\nIf some users in a location are registered to a PBX, retrieve the setting to route unknown extensions (digits that match the extension length) to the PBX.\n\nRetrieving the internal dialing configuration requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify the Internal Dialing configuration for a location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/internalDialing", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "location for which internal calling configuration is being requested" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List route identities for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify current configuration for routing unknown extensions to the premise as internal calls\n\nIf some users in a location are registered to a PBX, enable the setting to route unknown extensions (digits that match the extension length) to the PBX.\n\nEditing the internal dialing configuration requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Location Intercept", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/intercept", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Retrieve intercept details for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve intercept location details for a customer location." } ] }, "docs": "Retrieve intercept location details for a customer location.\n\nIntercept incoming or outgoing calls for persons in your organization. If this is enabled, calls are either routed to a designated number the person chooses, or to the person's voicemail.\n\nRetrieving intercept location details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Put Location Intercept", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/intercept", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Modifies the intercept details for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modifies the intercept location details for a customer location." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the intercept location details for a customer location.\n\nIntercept incoming or outgoing calls for users in your organization. If this is enabled, calls are either routed to a designated number the user chooses, or to the user's voicemail.\n\nModifying the intercept location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Location Outgoing Permission", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Retrieve outgoing call settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve outgoing call settings for this organization." } ] }, "docs": "Retrieve the location's outgoing call settings.\n\nA location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.\n\nRetrieving a location's outgoing call settings requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read." }, { "info": { "name": "Update Location Outgoing Permission", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Update outgoing call settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update outgoing call settings for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the location's outgoing call settings.\n\nLocation's outgoing call settings allows you to determine the types of calls the people/workspaces at this location are allowed to make and configure the default calling permission for each call type at a location.\n\nUpdating a location's outgoing call settings requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write." }, { "info": { "name": "Get Outgoing Permission Auto Transfer Number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Retrieve auto transfer number for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve auto transfer number for this organization." } ] }, "docs": "Get the transfer numbers for the outbound permission in a location.\n\nOutbound permissions can specify which transfer number an outbound call should transfer to via the `action` field.\n\nRetrieving an auto transfer number requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read." }, { "info": { "name": "Put Outgoing Permission Auto Transfer Number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Updating auto transfer number for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Updating auto transfer number for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the transfer numbers for the outbound permission in a location.\n\nOutbound permissions can specify which transfer number an outbound call should transfer to via the `action` field.\n\nUpdating auto transfer number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Outgoing Permission Location Access Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Retrieve access codes details for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve access codes details for a customer location." } ] }, "docs": "Retrieve access codes details for a customer location.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving access codes details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Outgoing Permission a new access code for a customer location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Add new access code for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Add new access code for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new access code for the given location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nCreating an access code for the given location requires a full or user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write." }, { "info": { "name": "Delete Outgoing Permission Access Code Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Deletes the access code details for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Deletes the access code details for a customer location." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the access code details for a particular location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nModifying the access code location details requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete all Outgoing Permission Access Code for a Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "path", "description": "Deletes all the access codes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Deletes the access codes for a customer location." } ] }, "docs": "Deletes all the access codes for a particular location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting the access codes requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Get Outgoing Permission Digit Pattern for a Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Retrieve the digit patterns for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve the digit patterns for this organization." } ] }, "docs": "Get the digit patterns for the outbound permission in a location.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving digit patterns requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Outgoing Permission a new Digit Pattern for a location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Add a new digit pattern for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Add a new digit pattern for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new digit pattern for the given location for a customer.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nCreating a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete all Outgoing Permission Digit Patterns for a Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Delete the digit patterns for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the digit patterns for this organization." } ] }, "docs": "Deletes all the digit patterns for a particular location for a customer.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting the digit patterns requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Details for a Outgoing Permission Digit Pattern for a Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Retrieve the digit pattern details for this location." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Retrieve the digit pattern with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve the digit pattern details for this organization." } ] }, "docs": "Get the digit pattern details.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving digit pattern details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update a Outgoing Permission Digit Pattern for a Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Update the digit pattern for this location." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Update the digit pattern with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update the digit pattern for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the designated digit pattern.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nUpdating a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Outgoing Permission Digit Pattern for a Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Delete the digit pattern for this location." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Delete the digit pattern with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the digit pattern for this organization." } ] }, "docs": "Delete the designated digit pattern.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." } ] } ], "bundled": true }