Webex User Call Settings (2/2) API
APIs for managing user call settings including music on hold, access codes, transfer numbers, digit patterns, and more.
Webex User Call Settings (2/2) API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Call Settings (2/2). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 94 operations across 57 paths, and defines 145 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
94 operations
57 paths
145 schemas
8 DELETE46 GET11 POST29 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex User Call Settings (2/2) API declares
3 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
It accepts HTTP bearer tokens (JWT) (bearer-key).
It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.
bearer-key— e.g. Bearer YOURAUTHORIZATIONTOKENbearerAuth— OAuth 2.0 Bearer token authentication
Paths & Operations 94
Across 57 paths, the API surfaces 94 operations — 8 DELETE, 46 GET, 11 POST, 29 PUT. Each is listed below with its method, path, parameters, and response codes.
User Call Settings (2/2) 94
APIs for managing user call settings including music on hold, access codes, transfer numbers, digit patterns, and more.
GET
/people/{personId}/features/applicationsdeprecated
Retrieve a person's Application Services Settings New
POST
/telephony/config/jobs/person/moveLocation
Validate or Initiate Move Users Job
GET
/telephony/config/jobs/person/moveLocation
List Move Users Jobs
GET
/telephony/config/jobs/person/moveLocation/{jobId}
Get Move Users Job Status
POST
/telephony/config/jobs/person/moveLocation/{jobId}/actions/pause/invoke
Pause the Move Users Job
POST
/telephony/config/jobs/person/moveLocation/{jobId}/actions/resume/invoke
Resume the Move Users Job
GET
/telephony/config/jobs/person/moveLocation/{jobId}/errors
List Move Users Job errors
GET
/telephony/config/people/{personId}/musicOnHold
Retrieve Music On Hold Settings for a Person
PUT
/telephony/config/people/{personId}/musicOnHold
Configure Music On Hold Settings for a Person
GET
/telephony/config/people/{personId}/outgoingPermission/accessCodes
Retrieve Access Codes for a Person
PUT
/telephony/config/people/{personId}/outgoingPermission/accessCodes
Modify Access Codes for a Person
POST
/telephony/config/people/{personId}/outgoingPermission/accessCodes
Create Access Codes for a Person
DELETE
/telephony/config/people/{personId}/outgoingPermission/accessCodes
Delete Access Codes for a Person
GET
/telephony/config/people/{personId}/outgoingPermission/autoTransferNumbers
Retrieve Transfer Numbers for a Person
PUT
/telephony/config/people/{personId}/outgoingPermission/autoTransferNumbers
Modify Transfer Numbers for a Person
GET
/telephony/config/people/{personId}/outgoingPermission/digitPatterns
Retrieve Digit Patterns for a Person
POST
/telephony/config/people/{personId}/outgoingPermission/digitPatterns
Create Digit Patterns for a Person
PUT
/telephony/config/people/{personId}/outgoingPermission/digitPatterns
Modify the Digit Pattern Category Control Settings for a Person
DELETE
/telephony/config/people/{personId}/outgoingPermission/digitPatterns
Delete all Digit Patterns for a Person
GET
/telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId}
Retrieve Digit Pattern Details for a Person
PUT
/telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId}
Modify a Digit Pattern for a Person
DELETE
/telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId}
Delete a Digit Pattern for a Person
PUT
/telephony/config/people/{personId}/numbers
Assign or Unassign numbers to a person
GET
/telephony/config/people/{personId}/preferredAnswerEndpoint
Get Preferred Answer Endpoint
PUT
/telephony/config/people/{personId}/preferredAnswerEndpoint
Modify Preferred Answer Endpoint
GET
/telephony/config/people/{personId}/applications/{applicationId}/availableMembersdeprecated
Search Shared-Line Appearance Members
GET
/telephony/config/people/{personId}/applications/{applicationId}/membersdeprecated
Get Shared-Line Appearance Members
PUT
/telephony/config/people/{personId}/applications/{applicationId}/membersdeprecated
Put Shared-Line Appearance Members
PUT
/telephony/config/people/{personId}/voicemail/passcode
Modify a person's voicemail passcode
GET
/telephony/voiceMessages/summary
Get Message Summary
GET
/telephony/voiceMessages
List Messages
DELETE
/telephony/voiceMessages/{messageId}
Delete Message
POST
/telephony/voiceMessages/markAsRead
Mark As Read
POST
/telephony/voiceMessages/markAsUnread
Mark As Unread
GET
/telephony/config/people/{personId}/agent/availableCallerIds
Retrieve Agent's List of Available Caller IDs
GET
/telephony/config/people/{personId}/agent/callerId
Retrieve Agent's Caller ID Information
PUT
/telephony/config/people/{personId}/agent/callerId
Modify Agent's Caller ID Information
GET
/telephony/config/people/{personId}/features/callBridge
Read Call Bridge Settings for a Person
PUT
/telephony/config/people/{personId}/features/callBridge
Configure Call Bridge Settings for a Person
GET
/telephony/config/people/{personId}/secondary/availableNumbers
Get Person Secondary Available Phone Numbers
GET
/telephony/config/people/{personId}/faxMessage/availableNumbers
Get Person Fax Message Available Phone Numbers
GET
/telephony/config/people/{personId}/callForwarding/availableNumbers
Get Person Call Forward Available Phone Numbers
GET
/telephony/config/people/primary/availableNumbers
Get Person Primary Available Phone Numbers
GET
/telephony/config/people/{personId}/emergencyCallbackNumber/availableNumbers
Get Person ECBN Available Phone Numbers
GET
/telephony/config/people/{personId}/callIntercept/availableNumbers
Get Person Call Intercept Available Phone Numbers
GET
/telephony/config/people/{personId}/settings/msTeams
Retrieve a Person's MS Teams Settings
PUT
/telephony/config/people/{personId}/settings/msTeams
Configure a Person's MS Teams Setting
GET
/telephony/config/people/{personId}/features/personalAssistant
Get Personal Assistant
PUT
/telephony/config/people/{personId}/features/personalAssistant
Update Personal Assistant
GET
/telephony/config/people/{personId}/modeManagement/availableFeatures
Retrieve the List of Available Features
GET
/telephony/config/people/{personId}/modeManagement/features
Retrieve the List of Features Assigned to a User for Mode Management
PUT
/telephony/config/people/{personId}/modeManagement/features
Assign a List of Features to a User for Mode Management
GET
/telephony/config/people/{personId}/selectiveAccept
Get the User’s Selective Call Accept Criteria List
PUT
/telephony/config/people/{personId}/selectiveAccept
Update User’s Selective Call Accept Criteria
POST
/telephony/config/people/{personId}/selectiveAccept/criteria
Create a Criteria to the User’s Selective Call Accept Service
GET
/telephony/config/people/{personId}/selectiveAccept/criteria/{id}
Get a Criteria for the User’s Selective Call Accept Service
PUT
/telephony/config/people/{personId}/selectiveAccept/criteria/{id}
Modify a Criteria From the User’s Selective Call Accept Service
DELETE
/telephony/config/people/{personId}/selectiveAccept/criteria/{id}
Delete a Criteria From the User’s Selective Call Accept service
GET
/telephony/config/people/{personId}/selectiveReject
Get the User’s Selective Call Rejection Criteria Listing
PUT
/telephony/config/people/{personId}/selectiveReject
Update User’s Selective Call Rejection Criteria List
POST
/telephony/config/people/{personId}/selectiveReject/criteria
Create a Criteria to the User’s Selective Call Rejection Service
GET
/telephony/config/people/{personId}/selectiveReject/criteria/{id}
Get a Criteria for the User’s Selective Call Rejection Service
PUT
/telephony/config/people/{personId}/selectiveReject/criteria/{id}
Modify a Criteria for the User’s Selective Call Rejection Service
DELETE
/telephony/config/people/{personId}/selectiveReject/criteria/{id}
Delete a Criteria From the User’s Selective Call Rejection Service
GET
/telephony/config/people/{personId}/selectiveForward
Get the User’s Selective Call Forwarding
PUT
/telephony/config/people/{personId}/selectiveForward
Update User’s Selective Call Forwarding Criteria List
POST
/telephony/config/people/{personId}/selectiveForward/criteria
Create a Criteria to the User’s Selective Call Forwarding Service
GET
/telephony/config/people/{personId}/selectiveForward/criteria/{id}
Get a Criteria for the User’s Selective Call Forwarding Service
PUT
/telephony/config/people/{personId}/selectiveForward/criteria/{id}
Modify a Criteria for the User’s Selective Call Forwarding Service
DELETE
/telephony/config/people/{personId}/selectiveForward/criteria/{id}
Delete a Criteria From the User’s Selective Call Forwarding Service
GET
/telephony/config/people/{personId}/applications/availableMembers
Search Shared-Line Appearance Members New
GET
/telephony/config/people/{personId}/applications/availableMembers/count
Get Count of Shared-Line Appearance Members
GET
/telephony/config/people/{personId}/applications/members
Get Shared-Line Appearance Members New
PUT
/telephony/config/people/{personId}/applications/members
Put Shared-Line Appearance Members New
GET
/telephony/config/people/{personId}/callCaptions
Get the user call captions settings
PUT
/telephony/config/people/{personId}/callCaptions
Update the user call captions settings
GET
/telephony/config/people/{personId}/executive/callFiltering
Get Person Executive Call Filtering Settings
PUT
/telephony/config/people/{personId}/executive/callFiltering
Modify Person Executive Call Filtering Settings
GET
/telephony/config/people/{personId}/executive/callFiltering/criteria/{id}
Get Person Executive Call Filtering Criteria Settings
PUT
/telephony/config/people/{personId}/executive/callFiltering/criteria/{id}
Modify Person Executive Call Filtering Criteria Settings
DELETE
/telephony/config/people/{personId}/executive/callFiltering/criteria/{id}
Delete Person Executive Call Filtering Criteria
POST
/telephony/config/people/{personId}/executive/callFiltering/criteria
Add Person Executive Call Filtering Criteria
GET
/telephony/config/people/{personId}/executive/alert
Get Person Executive Alert Settings
PUT
/telephony/config/people/{personId}/executive/alert
Modify Person Executive Alert Settings
GET
/telephony/config/people/{personId}/executive/assignedAssistants
Get Person Executive Assigned Assistants
PUT
/telephony/config/people/{personId}/executive/assignedAssistants
Modify Person Executive Assigned Assistants
GET
/telephony/config/people/{personId}/executive/availableAssistants
Get Person Executive Available Assistants
GET
/telephony/config/people/{personId}/executive/assistant
Get Person Executive Assistant Settings
PUT
/telephony/config/people/{personId}/executive/assistant
Modify Person Executive Assistant Settings
GET
/telephony/config/people/{personId}/executive/screening
Get Person Executive Screening Settings
PUT
/telephony/config/people/{personId}/executive/screening
Modify Person Executive Screening Settings
GET
/telephony/config/people/{personId}
Get Timezone and Announcement Language Settings of a Person
PUT
/telephony/config/people/{personId}
Update Timezone and Announcement Language Settings of a Person
GET
/telephony/config/countries/{countryCode}
Get Country Calling Configuration
Schemas 145
The contract defines 145 schemas that model the data the API accepts and returns. The most detailed are GetSharedLineMemberItem (20 properties), JobDetailsResponseById (15 properties), JobDetailsResponse (13 properties), ApplicationsSetting (12 properties). Each schema is shown below with its type and property counts.
PersonFaxMessageAvailableNumberObject
object
5 properties
5 required
Assistant
object
Details of an executive assistant.
7 properties
3 required
PutMusicOnHoldObject
object
3 properties
ExecutiveScreeningGet
object
Executive screening settings response object containing configuration for call screening and alert preferences.
5 properties
5 required
SourceForSelectiveForward
string
ALLNUMBERS - Criteria applies to all incoming numbers. SPECIFICNUMBERS - Criteria applies only for specific incoming numbers. ANYINTERNAL - Criteria applies to…
PutSharedLineMemberList
object
1 property
VoiceMailPartyInformation
object
5 properties
1 required
UserOutgoingPermissionDigitPatternGetListObject
object
2 properties
2 required
SelectiveAcceptCallGet
object
2 properties
1 required
PutSharedLineMemberItem
object
10 properties
8 required
ErrorObject
object
2 properties
GetSharedLineMemberList
object
3 properties
2 required
ModifyUserMSTeamsSettingsObject
object
2 properties
2 required
GetPersonDetailsObject
object
2 properties
2 required
SelectiveRejectCallSettingPatch
object
1 property
1 required
UserOutgoingPermissionDigitPatternCategoryControlPatchObject
object
1 property
AvailableSharedLineMemberList
object
1 property
PersonECBNAvailableNumberObject
object
7 properties
6 required
PersonalAssistantPatch
object
7 properties
SelectiveAcceptCallCriteriaPatch
object
8 properties
2 required
UsersListItem
object
3 properties
3 required
ExecutiveCallFilteringGet
object
Executive call filtering settings response object that contains the filter configuration and criteria.
3 properties
2 required
MoveUsersValidationResponse
object
1 property
1 required
ExecutiveCallFilteringCriteriaPost
object
Executive call filtering criteria settings request object for updating detailed filter rules and routing configuration.
10 properties
3 required
PersonCallForwardAvailableNumberObject
object
8 properties
5 required
StartJobExecutionStatusObject
object
7 properties
4 required
UserType
string
PEOPLE - The associated member is a person. PLACE - The associated member is a workspace. VIRTUALLINE - The associated member is a virtual line.
EndpointIdType
object
1 property
1 required
ErrorOrImpactItem
object
2 properties
2 required
DeviceType
string
DEVICE - The endpoint is a device. APPLICATION - The endpoint is a application.
NumberOwnerType
string
PLACE - PSTN phone number's owner is a workspace. PEOPLE - PSTN phone number's owner is a person. VIRTUALLINE - PSTN phone number's owner is a Virtual Profile.…
UserModeManagementFeatureObject
object
11 properties
5 required
GetMusicOnHoldObject
object
4 properties
3 required
UserOutgoingPermissionDigitPatternPatchObject
object
4 properties
StartJobResponseObject
object
11 properties
9 required
SelectiveForwardCallCriteriaPost
object
10 properties
3 required
ErrorResponseObject
object
1 property
UserPlaceAuthorizationCodeListGet
object
1 property
1 required
UserModeManagementAvailableFeaturesObject
object
5 properties
3 required
AudioAnnouncementFileGetObject
object
4 properties
4 required
CallsFrom
string
ANYPHONENUMBER - Criteria apply for any incoming number. SELECTPHONENUMBERS - Criteria only apply for selected incoming numbers. FORWARDED - Criteria only appl…
SelectiveRejectCallCriteriaPost
object
8 properties
2 required
PersonSecondaryAvailableNumberObject
object
5 properties
5 required
AvailableAssistant
object
Details of person available to be assigned as executive assistant.
5 properties
1 required
CallBridgePut
object
1 property
ExecutiveCallFilteringCriteriaPatch
object
Executive call filtering criteria settings request object for updating detailed filter rules and routing configuration.
9 properties
SelectiveRejectCallCriteriaPatch
object
8 properties
2 required
GetUserCallCaptionsObject
object
5 properties
5 required
Action
string
ADD - Add action. DELETE - Delete action.
SelectiveAcceptCallCriteriaPost
object
8 properties
2 required
PersonCallInterceptAvailableNumberObject
object
8 properties
5 required
TransferNumberGet
object
4 properties
1 required
GetUserMSTeamsSettingsObject
object
3 properties
3 required
ScheduleLevel
string
PEOPLE - The schedule level that specifies that criteria is of People level. GROUP - The schedule level that specifies that criteria is of Group level.
JobExecutionStatusObject
object
9 properties
5 required
ExecutiveScreeningPut
object
Executive screening settings request object for updating call screening and alert preferences.
5 properties
ApplicationsSetting
object
Application services settings for a user. Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can al…
12 properties
8 required
ExecutiveAssignedAssistantsGet
object
Response object for the executive assigned assistants.
1 property
location
object
2 properties
2 required
PutPersonDetailsObject
object
2 properties
CallsFromSelectiveReject
string
ANYPHONENUMBER - Criteria apply for any incoming number. SELECTPHONENUMBERS - Criteria only apply for selected incoming numbers. ANYINTERNAL - Criteria only ap…
ApplicationPutSharedLineMemberList
object
List of members to be added or modified for shared-line assignment to a Webex Calling Apps.
1 property
RingPattern
string
NORMAL - Normal incoming ring pattern. LONGLONG - Incoming ring pattern of two long rings. SHORTSHORTLONG - Incoming ring pattern of two short rings, followed…
AvailableSharedLineMemberItem
object
9 properties
4 required
CountObject
object
5 properties
5 required
ExecutiveAssistantSettingsGet
object
Settings for an executive assistant.
3 properties
1 required
ModifyVoicemailPasscode
object
1 property
1 required
ArrayOfFeatureIdsObject
object
1 property
1 required
endpoints
object
3 properties
3 required
PersonSecondaryAvailableNumberListGetObject
object
1 property
1 required
SelectiveAcceptCallSource
string
ALLNUMBERS - Selective accept criteria applies for all incoming numbers. SPECIFICNUMBERS - Selective accept criteria applies for calls from specific numbers. F…
SelectiveForwardCallCriteriaPatch
object
10 properties
3 required
MoveUsersStartJobObject
object
1 property
1 required
SelectiveRejectCallGet
object
2 properties
1 required
SelectiveForwardCallGet
object
5 properties
5 required
SelectiveRejectCallSource
string
ALLNUMBERS - Selective reject criteria applies for all incoming numbers. SPECIFICNUMBERS - Selective reject criteria applies for calls from specific numbers. F…
SelectiveAcceptCallCriteriaGet
object
9 properties
2 required
SelectiveAcceptCallSettingPatch
object
1 property
1 required
AuthorizationCode
object
2 properties
AgentCallerIdType
string
CALLQUEUE - A call queue has been selected for the agent's caller ID. HUNTGROUP - A hunt group has been selected for the agent's caller ID.
Location
object
Details of the location for the assigned assistant.
2 properties
2 required
stepExecutionStatusesObject
object
8 properties
5 required
PersonPrimaryAvailableNumberObject
object
7 properties
5 required
PersonCallInterceptAvailableNumberListGetObject
object
1 property
1 required
UserPlaceAuthorizationCodeListPatch
object
1 property
CallBridgeInfo
object
1 property
1 required
PersonFaxMessageAvailableNumberListGetObject
object
1 property
1 required
MoveUsersStartJobResponse
object
1 property
1 required
PutAgentCallCallerId
object
1 property
1 required
ExecutiveAssistantSettingsPut
object
Request Payload to update settings for an executive assistant.
3 properties
SelectiveRejectCallCriteriaGet
object
9 properties
2 required
MoveUsersErrorResponse
object
1 property
1 required
ExecutivePut
object
Details of an executive for whom the assistant can manage calls.
2 properties
2 required
SelectiveAcceptCallCriteria
object
4 properties
4 required
ExecutiveCallFilteringCriteriaGet
object
Executive call filtering criteria detailed settings response object that contains the schedule, phone numbers, and routing configuration.
11 properties
4 required
CallsFromSelectiveAccept
string
ANYPHONENUMBER - Criteria applies for any incoming number. SELECTPHONENUMBERS - Criteria applies for selected incoming numbers.
UserListItem
object
3 properties
1 required
ScheduleType
string
businessHours - The schedule type that specifies the business or working hours during the day. holidays - The schedule type that specifies the day when your or…
ApplicationAvailableSharedLineMemberList
object
List of members available for shared-line assignment to a Webex Calling Apps.
1 property
ModeManagementFeatureTypeObject
string
AUTOATTENDANT - Specifies the feature is an Auto Attendant. CALLQUEUE - Specifies the feature is a Call Queue. HUNTGROUP - Specifies the feature is a Hunt Grou…
StateGet
object
2 properties
2 required
JobDetailsResponseById
object
15 properties
8 required
ExecutiveAlertPut
object
11 properties
AgentCallerId
object
1 property
1 required
PersonPrimaryAvailableNumberListGetObject
object
1 property
1 required
JobDetailsResponse
object
13 properties
8 required
ExecutiveAssignedAssistantsPutRequestObject
object
Request object for updating assigned assistants to the executive.
1 property
VoiceMessageDetails
object
8 properties
3 required
AvailableCallerIdList
object
1 property
1 required
UserPlaceAuthorizationCodeAdd
object
2 properties
2 required
ApplicationAvailableSharedLineMemberItem
object
Member available for shared-line assignment to a Webex Calling Apps.
9 properties
4 required
UserItem
object
3 properties
1 required
UserNumbersPatch
object
2 properties
1 required
SelectedCallerIdObject
object
5 properties
5 required
ExecutiveCallFilteringPatch
object
Executive call filtering settings request object for updating the filter configuration and criteria activation.
3 properties
UserOutgoingPermissionDigitPatternPostObject
object
4 properties
4 required
UpdateUserCallCaptionsObject
object
3 properties
ExecutiveAvailableAssistantsGet
object
1 property
PersonalAssistantGet
object
7 properties
5 required
PhoneNumber
object
5 properties
3 required
SelectiveForwardCallCriteria
object
4 properties
4 required
Executive
object
Details of an executive for whom the assistant can manage calls.
6 properties
4 required
AudioAnnouncementFileObject
object
4 properties
PersonCallForwardAvailableNumberListGetObject
object
1 property
1 required
ItemObject
object
4 properties
ApplicationPutSharedLineMemberItem
object
Member to be added or modified for shared-line assignment to a Webex Calling Apps.
7 properties
5 required
TransferNumberPatch
object
4 properties
1 required
AvailableCallerIdObject
object
5 properties
3 required
SelectiveForwardCallSettingPatch
object
4 properties
ErrorMessageObject
object
3 properties
ExecutiveAlertGet
object
11 properties
4 required
endpointInformation
object
2 properties
2 required
SettingsObject
object
4 properties
4 required
PersonECBNAvailableNumberListGetObject
object
1 property
1 required
SelectiveForwardCallCriteriaGet
object
11 properties
3 required
LineType
string
PRIMARY - Primary line for the member. SHAREDCALLAPPEARANCE - Shared line for the member. A shared line allows users to receive and place calls to and from ano…
STATE
string
ACTIVE - Phone number is in the active state. INACTIVE - Phone number is in the inactive state.
JobListResponse
object
1 property
1 required
UserDigitPatternObject
object
5 properties
5 required
ExceptionTypeObject
string
MANUALSWITCHBACK - The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manually switches the featur…
GetSharedLineMemberItem
object
20 properties
11 required
ResponseId
object
Response object that contains the unique identifier for the created or updated criteria.
1 property
SelectiveRejectCriteria
object
4 properties
4 required
CountryConfigGet
object
4 properties
4 required
TelephonyType
string
PSTNNUMBER - The object is a PSTN number.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webex 12
Other APIs Webex publishes across the network.
Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
#User Call Settings (2/2)