The identity and technical contract details declared by the specification.
CallForwardingPut
object
2 properties
AgentACDStateType
string
SIGNIN - Agent has signed in. SIGNOUT - Agent has signed out. AVAILABLE - Agent is available. UNAVAILABLE - Agent is unavailable. WRAPUP - Agent has wrapped up.
UserDNDWebexGoOverridePatch
object
Request Payload to update the "Mobile User Aware" override setting for Do Not Disturb feature.
1 property
CallPickupGroupMember
object
Represents a member of a call pickup group.
8 properties
6 required
UserCallRecordingGetResponseObject
object
Response object for the user call recording settings.
7 properties
3 required
UserNumber
object
Details of a phone number associated with the user.
6 properties
6 required
endpoints
object
3 properties
3 required
ServicesEnum
string
Anonymous Call Rejection - When enabled, blocks all incoming calls from unidentified or blocked caller IDs. Authentication - Requires the user to enter a passw…
Assistant
object
Details of an executive assistant.
7 properties
3 required
DeviceType
string
DEVICE - The endpoint is a device. APPLICATION - The endpoint is a application.
FeatureAccessCode
object
Details of a feature access code configured for services that are assigned to the authenticated user.
3 properties
2 required
SecondaryLine
object
Details of a secondary line associated with the endpoint.
2 properties
2 required
HostObject
object
HOTDESKINGGUEST endpoints include the host element when the user has an active hotdesking session on a host.
7 properties
4 required
UserDevice
object
Details of a device associated with the user.
7 properties
7 required
CallBlockNumberPost
object
Request object for adding a phone number to the user's call block list.
1 property
1 required
PauseResumeNotifyMethodType
string
Beep - A beep is played when call recording is paused or resumed. Play Announcement - An announcement is played when call recording is paused or resumed.
ExecutiveAvailableAssistantsGet
object
1 property
Location
object
Details of the location for the assigned assistant.
2 properties
2 required
Executive
object
Details of an executive for whom the assistant can manage calls.
6 properties
4 required
MonitoredElementUser
object
9 properties
9 required
CallQueueSettingsPut
object
Request body for modifying call center settings and availability for an agent in one or more call centers.
2 properties
CallQueueGet
object
Details of a call queue that the agent has joined or may join.
7 properties
2 required
OwnerObject
object
Details of the owner of the device.
3 properties
3 required
CallerIdSettingsPut
object
Request Payload to update caller ID settings.
2 properties
CallForwardingInfo
object
2 properties
2 required
GetSingleNumberReachObject
object
3 properties
2 required
ServiceObject
object
Represents a list of services that are assigned to a user.
1 property
1 required
CallPickupGroupSettingsGet
object
Represents the call pickup group settings for a user.
2 properties
2 required
LocationObject
object
2 properties
2 required
ModifyEndpointObject
object
Request Payload to update an endpoint.
1 property
1 required
MonitoredElementCallParkExtension
object
7 properties
5 required
preferredAnswerEndpointInformation
object
Response object for the preferred answer endpoint information.
1 property
1 required
ExecutiveAssistantSettingsGet
object
Settings for an executive assistant.
3 properties
1 required
UserDNDWebexGoOverrideGet
object
Response object for the "Mobile User Aware" override setting for Do Not Disturb feature.
1 property
1 required
ExecutiveAssistantSettingsPut
object
Request Payload to update settings for an executive assistant.
3 properties
SelectedCallerIdSettingsPut
object
Request Payload to update selected caller ID settings.
1 property
1 required
EndpointType
string
CALLINGDEVICE - Endpoint is a calling device. APPLICATION - Endpoint is an application. HOTDESKINGGUEST - Endpoint is a hotdesking guest.
MemberType
string
PEOPLE - Indicates the associated member is a person. PLACE - Indicates the associated member is a workspace.
MonitoringSettingsGetResponseObject
object
Response object containing the monitoring settings for the logged in person.
2 properties
2 required
UserProfileGetResponseObject
object
User profile details for the authenticated user.
14 properties
14 required
RecordingModeType
string
Always - Call recording is always enabled. Never - Call recording is never enabled. On Demand - Call recording is started and stopped manually by the user. Alw…
ExecutiveAssignedAssistantsPatchRequestObject
object
Request object for updating executive assigned assistants.
2 properties
ExecutivePut
object
Details of an executive for whom the assistant can manage calls.
2 properties
2 required
CallerIdType
string
DEFAULTCLID - Caller ID is the default configured caller ID. ADDITIONALCLID - Caller ID is an additional external caller ID phone number available for the user…
AvailableAssistant
object
Details of person available to be assigned as executive assistant.
5 properties
1 required
SingleNumberReachNumber
object
Represents a phone number configured for Single Number Reach.
5 properties
5 required
FeatureAccessCodeListGetObject
object
Response object for the list of feature access codes.
1 property
1 required
MonitoredElementItem
object
2 properties
UserCallParkSettingsGetResponseObject
object
Represents the call park settings for a user.
2 properties
2 required
UserSingleNumberReachPatchRequestObject
object
Represents a request to update Single Number Reach settings for a user.
1 property
SelectedCallerIdSettingsGet
object
Response object for the selected caller ID settings.
1 property
1 required
UserNumberItem
object
6 properties
1 required
CallQueuePut
object
Request body for modifying call center within queues settings for a user.
2 properties
1 required
CallQueueSettingsGetResponseObject
object
Response object containing the call center settings and list of all call centers the logged in user belongs to.
2 properties
CallerIdSettingsGet
object
Response object for the caller ID settings.
2 properties
2 required
VoicemailPut
object
9 properties
2 required
DeviceTypeObject
string
PRIMARY - Primary line for the user. SHAREDCALLAPPEARANCE - Shared line for the user. A shared line allows users to receive and place calls to and from another…
GetUserCallCaptionsObject
object
5 properties
5 required
PostNumberForSingleReachNumber
object
Represents a request to add a phone number for Single Number Reach.
5 properties
3 required
AvailableCallerIdSettingsGet
object
Response object for the available caller ID settings.
1 property
1 required
Endpoint
object
Details of an endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an…
9 properties
6 required
CallParkMember
object
Represents a member of a call park group.
5 properties
3 required
availableCallerIds
object
Details of an available caller ID.
5 properties
2 required
UserBlockGetResponseObject
object
Response object containing the list of blocked phone numbers for a user.
1 property
1 required
preferredAnswerEndpoint
object
Details of the preferred answer endpoint.
3 properties
3 required
ExecutiveAssignedAssistantsGet
object
Response object for the executive assigned assistants.
1 property
VoicemailInfo
object
9 properties
9 required
DeviceActivationState
string
ACTIVATING - Device is activating using an activation code. ACTIVATED - Device has been activated using an activation code. DEACTIVATED - Device has not been a…
Numbers
object
Phone number details in the call block list.
2 properties
2 required
EndpointIdType
object
1 property
1 required
UserBlockStateGetResponseObject
object
Response object containing the call block state for a specific phone number.
1 property
1 required
EndpointListGetObject
object
Response object for the list of endpoints.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Webex publishes across the network.