{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book User Call Settings (1/2) API", "version": "1.0.0" }, "items": [ { "info": { "name": "User Call Settings (1/2)", "type": "folder" }, "items": [ { "info": { "name": "Modify a person's Application Services Settings", "type": "http" }, "http": { "method": "PUT", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Application services let you determine the ringing behavior for calls made to users in certain scenarios. You can also specify which devices users can download the Webex Calling app on.\n\nThis API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope." }, { "info": { "name": "Read Barge In Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/bargeIn", "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 Barge In settings.\n\nThe Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their own settings." }, { "info": { "name": "Configure Barge In Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/bargeIn", "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 Barge In settings.\n\nThe Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their own settings." }, { "info": { "name": "Read Forwarding Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/callForwarding", "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 Forwarding settings.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected " }, { "info": { "name": "Configure Call Forwarding Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/callForwarding", "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 Forwarding settings.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected" }, { "info": { "name": "Read Call Intercept Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/intercept", "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": "Retrieves Person's Call Intercept settings.\n\nThe intercept feature gracefully takes a person's phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full, user, or read-only administrator or location" }, { "info": { "name": "Configure Call Intercept Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/intercept", "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": "Configures a person's Call Intercept settings.\n\nThe intercept feature gracefully takes a person's phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full or user administrator or location administ" }, { "info": { "name": "Configure Call Intercept Greeting for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/intercept/actions/announcementUpload/invoke", "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": "Configure a person's Call Intercept Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings." }, { "info": { "name": "Read Call Recording Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/callRecording", "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 Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.\n\n
A person with a Webex Calling Standard license is eligible for the Call Reco" }, { "info": { "name": "Configure Call Recording Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/callRecording", "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 Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.\n\n
A person with a Webex Calling Standard license is eligible for the Call Re" }, { "info": { "name": "Read Call Waiting Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/callWaiting", "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 Waiting settings.\n\nWith this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.\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 Waiting Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/callWaiting", "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 Waiting settings.\n\nWith this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Caller ID Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/callerId", "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 Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\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 Caller ID Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/callerId", "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 Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Person's Calling Behavior", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/callingBehavior", "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": "Retrieves the calling behavior and UC Manager Profile settings for the person which includes overall calling behavior and calling UC Manager Profile ID.\n\nWebex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.\n\nAn organization has an organization-wide default Calling Behavior that may be overridden for individual persons.\n\nUC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Web" }, { "info": { "name": "Configure a person's Calling Behavior", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/callingBehavior", "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": "Modifies the calling behavior settings for the person which includes calling behavior and UC Manager Profile ID.\n\nWebex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.\n\nAn organization has an organization-wide default Calling Behavior that may be overridden for individual persons.\n\nUC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM).\n\nThe UC Manager Profile" }, { "info": { "name": "Read Do Not Disturb Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/doNotDisturb", "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 Do Not Disturb settings.\n\nWhen enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their settings." }, { "info": { "name": "Configure Do Not Disturb Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/doNotDisturb", "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 Do Not Disturb settings.\n\nWhen enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings." }, { "info": { "name": "Retrieve Executive Assistant Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/executiveAssistant", "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 executive assistant settings for the specified `personId`.\n\nPeople with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive's pool.\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": "Modify Executive Assistant Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/executiveAssistant", "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": "Modify the executive assistant settings for the specified personId.\n\nPeople with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive's pool.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Hoteling Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/hoteling", "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 hoteling settings.\n\nAs an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.\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 Hoteling Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/hoteling", "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 hoteling settings.\n\nAs an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Retrieve a person's Monitoring Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/monitoring", "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": "Retrieves the monitoring settings of the person, which shows specified people, places, virtual lines or call park extenions that are being monitored.\nMonitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\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": "Modify a person's Monitoring Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/monitoring", "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": "Modifies the monitoring settings of the person.\nMonitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\n\nThe number of monitored elements is limited to 50.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Incoming Permission Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/incomingPermission", "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 Incoming Permission settings.\n\nYou can change the incoming calling permissions for a person if you want them to be different from your organization's default.\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 Incoming Permission Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/incomingPermission", "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 Incoming Permission settings.\n\nYou can change the incoming calling permissions for a person if you want them to be different from your organization's default.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Retrieve a person's Outgoing Calling Permissions Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/outgoingPermission", "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 a person's Outgoing Calling Permissions settings.\n\nOutgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a person if you want them to be different from your organization's default.\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": "Modify a person's Outgoing Calling Permissions Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/outgoingPermission", "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 Outgoing Calling Permissions settings.\n\nOutgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a person if you want them to be different from your organization's default.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Get a List of Phone Numbers for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/numbers", "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." }, { "name": "preferE164Format", "value": "true", "type": "query", "description": "Return phone numbers in E.164 format." } ] }, "docs": "Get a person's phone numbers including alternate numbers.\n\nA person can have one or more phone numbers and/or extensions via which they can be called.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.\n\n
\n\n
The `preferE164Format` query parameter can be used to get phone numbers either in E.164 format or in their legacy format. The support for getting phone numbers in non-E.164 format in so" }, { "info": { "name": "Get a person's Privacy Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/privacy", "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 a person's privacy settings for the specified person ID.\n\nThe privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read." }, { "info": { "name": "Configure a person's Privacy Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/privacy", "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 privacy settings for the specified person ID.\n\nThe privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope." }, { "info": { "name": "Read Push-to-Talk Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/pushToTalk", "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 Push-to-Talk settings.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.\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 Push-to-Talk Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/pushToTalk", "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 Push-to-Talk settings.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Receptionist Client Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/reception", "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 Receptionist Client settings.\n\nTo help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.\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 Receptionist Client Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/reception", "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 Receptionist Client settings.\n\nTo help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "List of Schedules for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/schedules", "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." }, { "name": "start", "value": "0", "type": "query", "description": "Specifies the 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." }, { "name": "name", "value": "dallas", "type": "query", "description": "Specifies the case insensitive substring to be matched against the schedule names. The maximum length is 40." }, { "name": "type", "value": "businessHours", "type": "query", "description": "Specifies the schedule event type to be matched on the given type." } ] }, "docs": "List schedules for a person in an organization.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Create Schedule for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/schedules", "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": "Create a new schedule for a person.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Get a Schedule Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "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 schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Update a Schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "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": "Modify a schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Delete a Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "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": "Delete a schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Fetch Event for a person's Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow", "type": "path", "description": "Unique identifier for the event." }, { "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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Update an Event for a person's Schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow", "type": "path", "description": "Unique identifier for the event." }, { "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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Delete an Event for a person's Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow", "type": "path", "description": "Unique identifier for the event." }, { "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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Add a New Event for Person's Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the person." }, { "name": "scheduleType", "value": "", "type": "path", "description": "Type of schedule, either `businessHours` or `holidays`." }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "type": "path", "description": "Unique identifier for the schedule." }, { "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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope." }, { "info": { "name": "Read Voicemail Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/:personId/features/voicemail", "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 Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin" }, { "info": { "name": "Configure Voicemail Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/:personId/features/voicemail", "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 Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` sco" }, { "info": { "name": "Configure Busy Voicemail Greeting for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/voicemail/actions/uploadBusyGreeting/invoke", "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": "Configure a person's Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings." }, { "info": { "name": "Configure No Answer Voicemail Greeting for a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/voicemail/actions/uploadNoAnswerGreeting/invoke", "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": "Configure a person's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings." }, { "info": { "name": "Reset Voicemail PIN", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/:personId/features/voicemail/actions/resetPin/invoke", "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": "Reset a voicemail PIN for a person.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.\n\n**NOTE**: This API is expected to have an empty request body and Content-Type header should be set to `application/json`." } ] } ], "bundled": true }