APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person Settings
Workspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Reference
BroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale CustomersWholesale Subscribers
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMeetings Test FileMembershipsMessagesMock API for integration testOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog

Retrieve a Person's Monitoring Settings

Retrieves the monitoring settings of the person, which shows specified people, places or, call park extenions under monitoring. Monitors the line status which indicates if a person or place is on a call and if a call has been parked on that extension.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

GET/v1/people/{personId}/features/monitoring
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. 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.

Response Properties
callParkNotificationEnabled
boolean

Call park notification is enabled or disabled.

monitoredElements
array[GetMonitoredElementsObject]

Settings of monitored elements which can be person, place, or call park extension.

member
object
id
string

The identifier of the monitored person.

lastName
string

The last name of the monitored person or place.

firstName
string

The first name of the monitored person or place.

displayName
string

The display name of the monitored person or place.

type
PeopleOrPlaceType

Indicates whether type is PEOPLE or PLACE.

PEOPLE
string

Indicates a person or list of people.

PLACE
string

Indicates a workspace that is not assigned to a specific person such as for a shared device in a common area.

email
string

The email address of the monitored person or place.

numbers
array[MonitoredNumberObject]

The list of phone numbers of the monitored person or place.

external
string

External phone number of the monitored person or workspace.

extension
string

Extension number of the monitored person or workspace.

primary
boolean

Indicates whether phone number is a primary number.

location
string

The location name where the call park extension is.

locationId
string

The location Id for the location.

cpe
object
id
string

The identifier of the call park extension.

name
string

The name to describle the call park extension.

extension
string

The extension number for this call park extension.

location
string

The location name where the call park extension is.

locationId
string

The location Id for the location.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/people//features/monitoring{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. 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.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/monitoring?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "callParkNotificationEnabled":true,
    "monitoredElements":[{
        "member": {
            "id":"Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY",
            "lastName":"Nelson",
            "firstName":"John",
            "displayName":"John Nelson",
            "type":"PEOPLE",
            "email":"john.nelson@gmail.com",
            "numbers":[{
                "external":"+1-9728138888",
                "extension":"1234",
                "primary":true
            }],
            "location":"Dallas",
            "locationId":"Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1JDRE4"
        },
        "cpe":{
            "id":"Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZTdlZDdiMDEtN2E4Ni00NDEwLWFlODMtOWJmODMzZGEzNzQy",
            "name":"Dallas-Test",
            "extension":"4001",
            "location":"Dallas",
            "locationId":"Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1JDRE4"
        }
    }]
}