{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book User Call Settings (2/2) API", "version": "1.0.0" }, "items": [ { "info": { "name": "User Call Settings (2/2)", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a person's Application Services Settings New", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/applications", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Gets mobile and PC applications settings for a user.\n\nApplication services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app.\n\nRequires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "List Move Users Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM", "type": "query", "description": "Retrieve list of Move Users jobs for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of jobs. Default is 0." }, { "name": "max", "value": "2000", "type": "query", "description": "Limit the number of jobs returned to this maximum count. Default is 2000." } ] }, "docs": "Lists all the Move Users jobs for the given organization in order of most recent job to oldest job irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Validate or Initiate Move Users Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM", "type": "query", "description": "Create Move Users job for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API allows the user to perform one of the following operations:\n\n* Setting the `validate` attribute to `true` validates the user move.\n\n* Setting the `validate` attribute to `false` performs the user move.\n\n
\n\nNotes:\n\n* A maximum of `100` users can be moved at a time.\n\n* Setting the `validate` attribute to `true` only allowed for calling user.\n\n* When a single non calling user is moved, it will be moved synchronously without creating any job.\n\n
\n\nErrors occurring during the initial " }, { "info": { "name": "Get Move Users Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE", "type": "path", "description": "Retrieve job details for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM", "type": "query", "description": "Retrieve job details for this organization." } ] }, "docs": "Returns the status and other details of the job.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Pause the Move Users Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/actions/pause/invoke", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Pause the Move Users job for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk", "type": "query", "description": "Pause the Move Users job for this organization." } ] }, "docs": "Pause the running Move Users Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Resume the Move Users Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/actions/resume/invoke", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Resume the Move Users job for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk", "type": "query", "description": "Resume the Move Users job for this organization." } ] }, "docs": "Resume the paused Move Users Job that is in paused status.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "List Move Users Job errors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc", "type": "path", "description": "Retrieve the error details for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM", "type": "query", "description": "Retrieve list of jobs for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Specifies the error offset from the first result that you want to fetch." }, { "name": "max", "value": "100", "type": "query", "description": "Specifies the maximum number of records that you want to fetch." } ] }, "docs": "Lists all error details of Move Users job. This will not list any errors if `exitCode` is `COMPLETED`. If the status is `COMPLETED_WITH_ERRORS` then this lists the cause of failures.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Retrieve Music On Hold Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/musicOnHold", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve the person's music on hold settings.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nRetrieving a person's music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Music On Hold Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/musicOnHold", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a person's music on hold settings.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nTo configure music on hold settings for a person, music on hold setting must be enabled for this location.\n\nUpdating a person's music on hold settings requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Access Codes for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 the person's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API 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 Access Codes for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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": "Create new Access codes for the person.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Modify Access Codes for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 a person's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Delete Access Codes for a Person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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": "Deletes all Access codes for the person.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve Transfer Numbers for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 the person's transfer numbers.\n\nWhen calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Transfer Numbers for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 a person's transfer numbers.\n\nWhen calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve Digit Patterns for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "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 the person's digit patterns.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving digit patterns requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Digit Patterns for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "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": "Create a new digit pattern for the given person.\n\nDigit patterns are used to bypass permissions.\n\nCreating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Modify the Digit Pattern Category Control Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "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": "Modifies whether this user uses the specified digit patterns when placing outbound calls or not.\n\nUpdating the digit pattern category control settings requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete all Digit Patterns for a Person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "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": "Delete all digit patterns for a Person.\n\nDigit patterns are used to bypass permissions.\n\nDeleting the digit patterns requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Digit Pattern Details for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "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 the digit pattern details for a person.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving the digit pattern details requires a full or user 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 a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "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 a digit pattern for a Person.\n\nDigit patterns are used to bypass permissions.\n\nUpdating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Digit Pattern for a Person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw", "type": "path", "description": "Unique identifier for the person." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "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": "Delete a digit pattern for a Person.\n\nDigit patterns are used to bypass permissions.\n\nDeleting the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Assign or Unassign numbers to a person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/numbers", "params": [ { "name": "personId", "value": "'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iNTcwZGY3ZC00MjBkLTQ4NGYtYWE5OS1kMzcxOGZjNDUxZDA='", "type": "path", "description": "Unique identitfier of the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization of the Route Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign or unassign alternate phone numbers to a person.\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\nAssigning or unassigning an alternate phone number to a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_con" }, { "info": { "name": "Get Preferred Answer Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/preferredAnswerEndpoint", "params": [ { "name": "personId", "value": "Y2lzY29z...", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get the person's preferred answer endpoint and the list of endpoints available for selection. The preferred answer endpoint is null if one has not been selected. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality. These endpoints can be used by the following Call Control API's that allow the person to specify an endpointId to use for the call:
\n\n+ [/v1/telephony/calls/dial](/docs/api/v1/call-controls/dial)
\n\n+ [/" }, { "info": { "name": "Modify Preferred Answer Endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/preferredAnswerEndpoint", "params": [ { "name": "personId", "value": "Y2lzY29z...", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `preferredAnswerEndpointId` attribute must be set to null.
\nThis API requires `spark:telephony_config_write` or `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Search Shared-Line Appearance Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/availableMembers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "applicationId", "value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA", "type": "path", "description": "A unique identifier for the application." }, { "name": "max", "value": "0", "type": "query", "description": "Number of records per page." }, { "name": "start", "value": "0", "type": "query", "description": "Page number." }, { "name": "location", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "query", "description": "Location ID for the user." }, { "name": "name", "value": "john", "type": "query", "description": "Search for users with names that match the query." }, { "name": "number", "value": "1234567890", "type": "query", "description": "Search for users with numbers that match the query." }, { "name": "order", "value": "fname", "type": "query", "description": "Sort by first name (`fname`) or last name (`lname`)." }, { "name": "extension", "value": "1111", "type": "query", "description": "Search for users with extensions that match the query." } ] }, "docs": "Get members available for shared-line assignment to a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope." }, { "info": { "name": "Get Shared-Line Appearance Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/members", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "applicationId", "value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA", "type": "path", "description": "A unique identifier for the application." } ] }, "docs": "Get primary and secondary members assigned to a shared line on a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope." }, { "info": { "name": "Put Shared-Line Appearance Members", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/members", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "applicationId", "value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA", "type": "path", "description": "A unique identifier for the application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Modify a person's voicemail passcode", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/voicemail/passcode", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTu+/vQ", "type": "path", "description": "Modify voicemail passcode for this person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify voicemail passcode for a person in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a person's voicemail passcode.\n\nModifying a person's voicemail passcode requires a full administrator, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Message Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/voiceMessages/summary" }, "docs": "Get a summary of the voicemail messages for the user." }, { "info": { "name": "List Messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/voiceMessages", "params": [ { "name": "lineOwnerId", "value": "Y2lzY29z...", "type": "query", "description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API." } ] }, "docs": "Get the list of all voicemail messages for the user." }, { "info": { "name": "Delete Message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/voiceMessages/:messageId", "params": [ { "name": "messageId", "value": "", "type": "path", "description": "The message identifer of the voicemail message to delete" } ] }, "docs": "Delete a specfic voicemail message for the user." }, { "info": { "name": "Mark As Read", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/voiceMessages/markAsRead", "body": { "type": "json", "data": "{}" } }, "docs": "Update the voicemail message(s) as read for the user.\n\nIf the `messageId` is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read." }, { "info": { "name": "Mark As Unread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/voiceMessages/markAsUnread", "body": { "type": "json", "data": "{}" } }, "docs": "Update the voicemail message(s) as unread for the user.\n\nIf the `messageId` is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread." }, { "info": { "name": "Retrieve Agent's List of Available Caller IDs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/agent/availableCallerIds", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get the list of call queues and hunt groups available for caller ID use by this person as an agent.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Retrieve Agent's Caller ID Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/agent/callerId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q", "type": "path", "description": "Unique identifier for the person." } ] }, "docs": "Retrieve the Agent's Caller ID Information.\n\nEach agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller ID or their own configured Caller ID.\n\nThis API requires a full admin or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Agent's Caller ID Information", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/agent/callerId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q", "type": "path", "description": "Unique identifier for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Agent's Caller ID Information.\n\nEach Agent will be able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or Hunt Group's Caller ID or their own configured Caller ID\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Read Call Bridge Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/features/callBridge", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a person's Call Bridge settings.\n\nThis API requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Configure Call Bridge Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/features/callBridge", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a person's Call Bridge settings.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Get Person Secondary Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/secondary/availableNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 person's secondary phone number.\nThese numbers are associated with the location of the person 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 " }, { "info": { "name": "Get Person Fax Message Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/faxMessage/availableNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 person's FAX message number.\nThese numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are unassigned.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location administrator auth token with a scope of `" }, { "info": { "name": "Get Person Call Forward Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/callForwarding/availableNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 person's call forward number.\nThese numbers are associated with the location of the person 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 ad" }, { "info": { "name": "Get Person Primary Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/primary/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." }, { "name": "licenseType", "value": "Webex Calling Professional", "type": "query", "description": "Used to search numbers according to the person's `licenseType` to which the number will be assigned." } ] }, "docs": "List numbers that are available to be assigned as a person's primary phone number.\nBy default, this API returns standard and mobile numbers from all locations that are unassigned. The parameters `licenseType` and `locationId` must align with the person's settings to determine the appropriate number for assignment.\nFailure to provide these parameters may result in the unsuccessful assignment of the returned number.\n\nThe available numbers APIs help identify candidate numbers and their owning entit" }, { "info": { "name": "Get Person ECBN Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/emergencyCallbackNumber/availableNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 person's emergency callback number.\nThese numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are assigned to an owning entity.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location administrator aut" }, { "info": { "name": "Get Person Call Intercept Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/callIntercept/availableNumbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 person's call intercept number.\nThese numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location administrator " }, { "info": { "name": "Retrieve a Person's MS Teams Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/settings/msTeams", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 since the default is the same organization as the token used to access the API." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
\n\nRetrieve a person's MS Teams settings.\n\nAt a person level, MS Teams settings allow access to retrieving the `HIDE WEBEX APP` and `PRESENCE SYNC` settings.\n\nTo retrieve a person's MS Teams settings requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure a Person's MS Teams Setting", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/settings/msTeams", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "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 since the default is the same organization as the token used to access the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Not supported for Webex for Government (FedRAMP)
\n\nConfigure a Person's MS Teams setting.\n\nMS Teams settings can be configured at the person level.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Personal Assistant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/features/personalAssistant", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get Personal Assistant details for the organization." } ] }, "docs": "Retrieve Personal Assistant details for a specific user.\n\nPersonal Assistant is used to manage a user's incoming calls when they are away.\n\nRetrieving Personal Assistant details requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Personal Assistant", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/features/personalAssistant", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update Personal Assistant details for the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Personal Assistant details for a specific user.\n\nPersonal Assistant is used to manage a user's incoming calls when they are away.\n\nUpdating Personal Assistant details requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve the List of Available Features", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/availableFeatures", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI", "type": "path", "description": "A unique identifier for the user." }, { "name": "name", "value": "Day", "type": "query", "description": "List features whose `name` contains this string." }, { "name": "phoneNumber", "value": "+35391884653", "type": "query", "description": "List features whose phoneNumber contains this matching string." }, { "name": "extension", "value": "1234", "type": "query", "description": "List features whose `extension` contains this matching string." }, { "name": "max", "value": "", "type": "query", "description": "Maximum number of features to return in a single page." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc", "type": "query", "description": "Sort the list of features based on `name`, `phoneNumber`, or `extension`, either `asc`, or `desc`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve features list from this organization." } ] }, "docs": "Retrieve a list of feature identifiers that can be assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\n\nFeatures with mode-based call forwarding enabled can be assigned to a user for `Mode Management`.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Retrieve the List of Features Assigned to a User for Mode Management", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/features", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI", "type": "path", "description": "A unique identifier for the user." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve features list from this organization." } ] }, "docs": "Retrieve a list of feature identifiers that are already assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\nA maximum of 50 features can be assigned to a user for `Mode Management`.\n\nFeatures with mode-based call forwarding enabled can be assigned to a user for `Mode Management`.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telepho" }, { "info": { "name": "Assign a List of Features to a User for Mode Management", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/features", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI", "type": "path", "description": "A unique identifier for the user." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve features list from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign a user a list of feature identifiers for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\nA maximum of 50 features can be assigned to a user for `Mode Management`.\n\nUpdating mode management settings for a user requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the User’s Selective Call Accept Criteria List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Retrieve selective call accept criteria list for a user.\n\nWith the selective call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update User’s Selective Call Accept Criteria", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify selective call accept setting for a user.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Create a Criteria to the User’s Selective Call Accept Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a criteria to the user's selective call accept service.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Criteria for the User’s Selective Call Accept Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Get the criteria details for the user's selective call accept service.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Criteria From the User’s Selective Call Accept Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a criteria for the user's selective call accept service.\n\nWith the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Criteria From the User’s Selective Call Accept service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Delete a criteria from the user's selective call accept criteria list.\n\nWith the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the User’s Selective Call Rejection Criteria Listing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Retrieve selective call rejection criteria for a user.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update User’s Selective Call Rejection Criteria List", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify selective call rejection setting for a user.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Create a Criteria to the User’s Selective Call Rejection Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a criteria to the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Criteria for the User’s Selective Call Rejection Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Get a criteria for the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Criteria for the User’s Selective Call Rejection Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a criteria for the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Criteria From the User’s Selective Call Rejection Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Delete a criteria from the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the User’s Selective Call Forwarding", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Retrieve selective call forwarding criteria for a user.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update User’s Selective Call Forwarding Criteria List", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify selective call forwarding setting for a user.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Create a Criteria to the User’s Selective Call Forwarding Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a criteria to the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Criteria for the User’s Selective Call Forwarding Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Get the criteria details for the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Criteria for the User’s Selective Call Forwarding Service", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a criteria for the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Criteria From the User’s Selective Call Forwarding Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI", "type": "path", "description": "Criteria ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the user resides." } ] }, "docs": "Delete a criteria from the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Search Shared-Line Appearance Members New", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/availableMembers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "number-asc|number-desc", "type": "query", "description": "Order the Route Lists according to number, ascending or descending." }, { "name": "location", "value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy", "type": "query", "description": "Location ID for the user." }, { "name": "name", "value": "abcd", "type": "query", "description": "Search for users with names that match the query." }, { "name": "phoneNumber", "value": "1234567890", "type": "query", "description": "Search for users with numbers that match the query." }, { "name": "extension", "value": "8765", "type": "query", "description": "Search for users with extensions that match the query." } ] }, "docs": "Get members available for shared-line assignment to a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope." }, { "info": { "name": "Get Count of Shared-Line Appearance Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/availableMembers/count", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2ViYTgzY2VjLThiMDUtNDMxNS1iNzJlLTQ1MTUyYTg1ZWE0Yw", "type": "query", "description": "Location ID for the person." }, { "name": "memberName", "value": "john", "type": "query", "description": "Search for people with names that match the query." }, { "name": "phoneNumber", "value": "1234567890", "type": "query", "description": "Search for people with numbers that match the query." }, { "name": "extension", "value": "1111", "type": "query", "description": "Search for people with extensions that match the query." } ] }, "docs": "Get the count of members available for shared-line assignment to Webex Calling Apps.\n\nShared-line appearance allows multiple devices or applications to share a single line for call handling.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope." }, { "info": { "name": "Get Shared-Line Appearance Members New", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/members", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." } ] }, "docs": "Get primary and secondary members assigned to a shared line on a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope." }, { "info": { "name": "Put Shared-Line Appearance Members New", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/applications/members", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Get the user call captions settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/callCaptions", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the organization." } ] }, "docs": "Retrieve the user's call captions settings.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:te" }, { "info": { "name": "Update the user call captions settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/callCaptions", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the user's call captions settings.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config" }, { "info": { "name": "Get Person Executive Call Filtering Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ] }, "docs": "Retrieve the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`" }, { "info": { "name": "Modify Person Executive Call Filtering Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Executive Call Filtering Criteria Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "Unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0", "type": "path", "description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ] }, "docs": "Retrieve the executive call filtering criteria settings for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to retrieve the detailed configuration for a specific filter rule. This includes schedule settings, phone number filters, and call routing preferences for executive call filtering.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Person Executive Call Filtering Criteria Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0", "type": "path", "description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete Person Executive Call Filtering Criteria", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0", "type": "path", "description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ] }, "docs": "Delete a specific executive call filtering criteria configuration for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Add Person Executive Call Filtering Criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new executive call filtering criteria configuration for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls. This API creates a new filter rule with the specified configuration, including schedule, phone numbers, and call routing preferences.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Executive Alert Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/alert", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ] }, "docs": "Get executive alert settings for the specified person.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Person Executive Alert Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/alert", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update executive alert settings for the specified person.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Executive Assigned Assistants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/assignedAssistants", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ] }, "docs": "Get list of assigned executive assistants for the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Person Executive Assigned Assistants", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/assignedAssistants", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update assigned executive assistants for the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Executive Available Assistants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/availableAssistants", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "2", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "name", "value": "Mathew - Test", "type": "query", "description": "Only return people with the matching name (person's first and last name combination)." }, { "name": "phoneNumber", "value": "9705550028", "type": "query", "description": "Only return people with the matching phone number or extension." } ] }, "docs": "Retrieves a list of people available for assignment as executive assistants to the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Person Executive Assistant Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/assistant", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ] }, "docs": "Get executive assistant settings for the specified person when person is configured as executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Person Executive Assistant Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/assistant", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update executive assistant settings for the specified person when person is configured as executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Executive Screening Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/screening", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ] }, "docs": "Get executive screening settings for the specified person.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Person Executive Screening Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/executive/screening", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ", "type": "path", "description": "A unique identifier for the person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update executive screening settings for the specified person.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Timezone and Announcement Language Settings of a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY", "type": "path", "description": "Retrieve timezone and announcement language settings of this person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID. If not specified, uses the organization from the OAuth token." } ] }, "docs": "Retrieve a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Timezone and Announcement Language Settings of a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY", "type": "path", "description": "Modify timezone and announcement language settings of this person." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID. If not specified, uses the organization from the OAuth token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Country Calling Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/countries/:countryCode", "params": [ { "name": "countryCode", "value": "US", "type": "path", "description": "The ISO country code to retrieve configuration for." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization ID. If not specified, uses the organization from the OAuth token." } ] }, "docs": "Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones.\n\nThis information helps administrators configure user settings with valid timezone and location data for a specific country.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." } ] } ], "bundled": true }