Webex Device Call Settings API
The Device Call Settings API from Webex — 33 operation(s) for device call settings.
Webex Device Call Settings API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Device Call Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 47 operations across 33 paths, and defines 134 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
47 operations
33 paths
134 schemas
2 DELETE28 GET8 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Device Call Settings 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 47
Across 33 paths, the API surfaces 47 operations — 2 DELETE, 28 GET, 8 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
Device Call Settings 47
GET
/telephony/config/devices/{deviceId}/members
Get Device Members
PUT
/telephony/config/devices/{deviceId}/members
Update Members on the device
GET
/telephony/config/devices/{deviceId}/availableMembers
Search Members
GET
/telephony/config/devices/{deviceId}/availableMembers/count
Get Count of Members
GET
/telephony/config/devices/availableMembers/count
Get Count of Available Members
POST
/telephony/config/devices/{deviceId}/actions/applyChanges/invoke
Apply Changes for a specific device
GET
/telephony/config/devices/{deviceId}/settings
Get Device Settings
PUT
/telephony/config/devices/{deviceId}/settings
Update device settings
GET
/telephony/config/locations/{locationId}/devices/settings
Get Location Device Settings
GET
/telephony/config/devices/{deviceId}
Get Webex Calling Device Details
PUT
/telephony/config/devices/{deviceId}
Update Third Party Device
GET
/telephony/config/people/{personId}/devices
Get Person Devices
PUT
/telephony/config/people/{personId}/devices/settings/hoteling
Modify Hoteling Settings for a Person's Primary Devices
GET
/telephony/config/workspaces/{workspaceId}/devices
Get Workspace Devices
PUT
/telephony/config/workspaces/{workspaceId}/devices
Modify Workspace Devices
GET
/telephony/config/devices/settings
Read the device override settings for a organization
POST
/telephony/config/devices/lineKeyTemplates
Create a Line Key Template
GET
/telephony/config/devices/lineKeyTemplates
Read the list of Line Key Templates
GET
/telephony/config/devices/lineKeyTemplates/{templateId}
Get details of a Line Key Template
PUT
/telephony/config/devices/lineKeyTemplates/{templateId}
Modify a Line Key Template
DELETE
/telephony/config/devices/lineKeyTemplates/{templateId}
Delete a Line Key Template
POST
/telephony/config/devices/actions/previewApplyLineKeyTemplate/invoke
Preview Apply Line Key Template
POST
/telephony/config/jobs/devices/applyLineKeyTemplate
Apply a Line Key Template
GET
/telephony/config/jobs/devices/applyLineKeyTemplate
Get List of Apply Line Key Template jobs
GET
/telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}
Get the job status of an Apply Line Key Template job
GET
/telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}/errors
Get job errors for an Apply Line Key Template job
GET
/telephony/config/devices/dects/supportedDevices
Read the DECT device type list - Deprecated
GET
/telephony/config/devices/dectNetworks/supportedDevices
Read the DECT device type list
POST
/telephony/config/devices/actions/validateMacs/invoke
Validate a list of MAC address
POST
/telephony/config/jobs/devices/callDeviceSettings
Change Device Settings Across Organization Or Location Job
GET
/telephony/config/jobs/devices/callDeviceSettings
List Change Device Settings Jobs
GET
/telephony/config/jobs/devices/callDeviceSettings/{jobId}
Get Change Device Settings Job Status
GET
/telephony/config/jobs/devices/callDeviceSettings/{jobId}/errors
List Change Device Settings Job Errors
GET
/telephony/config/devices/{deviceId}/layout
Get Device Layout by Device ID
PUT
/telephony/config/devices/{deviceId}/layout
Modify Device Layout by Device ID
POST
/telephony/config/jobs/devices/rebuildPhones
Rebuild Phones Configuration
GET
/telephony/config/jobs/devices/rebuildPhones
List Rebuild Phones Jobs
GET
/telephony/config/jobs/devices/rebuildPhones/{jobId}
Get the Job Status of a Rebuild Phones Job
GET
/telephony/config/jobs/devices/rebuildPhones/{jobId}/errors
Get Job Errors for a Rebuild Phones Job
GET
/telephony/config/people/{personId}/devices/settings
Get Device Settings for a Person
PUT
/telephony/config/people/{personId}/devices/settings
Update Device Settings for a Person
GET
/telephony/config/workspaces/{workspaceId}/devices/settings
Get Device Settings for a Workspace
PUT
/telephony/config/workspaces/{workspaceId}/devices/settings
Update Device Settings for a Workspace
GET
/telephony/config/devices/backgroundImages
Read the List of Background Images
DELETE
/telephony/config/devices/backgroundImages
Delete Device Background Images
POST
/telephony/config/devices/{deviceId}/actions/backgroundImageUpload/invoke
Upload a Device Background Image
GET
/telephony/config/people/{personId}/devices/count
Get User Devices Count
Schemas 134
The contract defines 134 schemas that model the data the API accepts and returns. The most detailed are mppObjectDevice (48 properties), mppObject (47 properties), MemberObject (21 properties), PskObject (16 properties). Each schema is shown below with its type and property counts.
GetMemberResponse
object
3 properties
2 required
devices
object
11 properties
7 required
PutThirdPartyDevice
object
1 property
1 required
DectDeviceList
object
5 properties
2 required
ApplyLineKeyTemplateJobErrors
object
2 properties
1 required
PhoneLanguage
string
PERSONLANGUAGE - Indicates a person's announcement language.
PostApplyLineKeyTemplateRequest
object
7 properties
2 required
UsbPortsObject
object
3 properties
3 required
AuthenticationMethodObject
string
NONE - No authentication. EAPFAST - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authenticat…
lineKeyTemplatesResponse
object
4 properties
4 required
ErrorObject
object
2 properties
VlanObjectDevice
object
2 properties
2 required
CustomizationObject
object
4 properties
HotelingRequest
object
3 properties
1 required
AtaDtmfModeObject
string
STRICT - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm. NORMAL - Normal threshold mode.
PutMemberObject
object
10 properties
8 required
userDeviceCount
object
2 properties
2 required
MppVlanObjectDevice
object
3 properties
1 required
CallHistoryMethod
string
WEBEXUNIFIEDCALLHISTORY - Set call history to use the unified call history from all of the end user's devices. LOCALCALLHISTORY - Set call history to use local…
DeviceSettingsObjectForDeviceLevel
object
5 properties
5 required
WifiNetworkObject
object
4 properties
4 required
HttpProxyObject
object
8 properties
8 required
DectVlanObject
object
2 properties
2 required
AtaDtmfMethodObject
string
INBAND - Sends DTMF by using the audio path. AVT - Audio video transport. Sends DTMF as AVT events. AUTO - Uses InBand or AVT based on the outcome of codec neg…
MacStatusObject
object
4 properties
2 required
BacklightTimer68XX
string
ALWAYSON - Keep the phone's backlight always on. TENSEC - Set the phone's backlight to be on for ten seconds. TWENTYSEC - Set the phone's backlight to be on fo…
SoftKeyMenuObject
object
14 properties
14 required
PoeMode
string
NORMAL - Use normal power consumption. MAXIMUM - Use maximum power consumption.
WifiAudioCodecPriorityObjectDevice
object
4 properties
4 required
RebuildPhonesList
object
1 property
1 required
DirectoryMethod
string
XSIDIRECTORY - Set directory services to use standard XSI query method from the device. WEBEXDIRECTORY - Set directory services to use the Webex Enterprise dir…
MppVlanObject
object
3 properties
1 required
AcdObjectDevice
object
2 properties
2 required
LineKeyTemplateAdvisoryTypes
object
5 properties
listBackgroundImagesObject
object
2 properties
2 required
DeviceType
string
DEVICE - The endpoint is a device. APPLICATION - The endpoint is a application.
KEMKeys
object
6 properties
4 required
CommSecurityType
string
NONE - Sets the LDAP server security protocol to None. SSL - Sets the LDAP server security protocol to SSL. STARTTLS - Sets the LDAP server security protocol t…
ErrorResponseObject
object
1 property
BluetoothObjectDevice
object
2 properties
1 required
DeviceLayout
object
5 properties
2 required
RebuildPhonesPostRequest
object
1 property
1 required
BackgroundImageColor
string
CYANDARK - Indicates that dark cyan background image will be set for the devices. PURPLEDARK - Indicates the dark purple background image will be set for the d…
ScreenTimeoutObject
object
2 properties
2 required
ListDeviceSettingsObject
object
4 properties
4 required
MppAudioCodecPriorityObjectDevice
object
4 properties
4 required
deviceOwner
object
4 properties
4 required
MemberType
string
PEOPLE - Indicates the associated member is a person. PLACE - Indicates the associated member is a workspace.
ApplyLineKeyTemplateJobDetails
object
13 properties
11 required
PostLineKeyTemplateRequest
object
4 properties
3 required
LayoutMode
string
DEFAULT - Default layout mode when a new device is added. CUSTOM - Enables a device to have its custom layout.
ListDectDeviceType
object
1 property
1 required
CallForwardExpandedSoftKey
string
ONLYTHECALLFORWARDALL - Set the default call forward expanded soft key behavior to single option. ALLCALLFORWARDS - Set the default call forward expanded soft…
ActivationStates
string
activating - Device is activating using an activation code. activated - Device has been activated using an activation code. deactivated - Device has not been a…
MppAudioCodecPriorityObject
object
4 properties
4 required
RebuildPhonesJob
object
14 properties
10 required
DisplayCallqueueAgentSoftkeysObject
string
KemModuleType
string
KEM14KEYS - Extension module has 14 line keys that can be configured. KEM18KEYS - Extension module has 18 line keys that can be configured. KEM20KEYS - Extensi…
JobExecutionStatusObject
object
9 properties
5 required
VolumeSettingsObject
object
6 properties
6 required
PutLineKeyTemplateRequest
object
2 properties
1 required
UserHotelingRequestPatch
object
1 property
1 required
SelectionType
string
REGIONAL - Indicates the regional selection type for audio codec priority. CUSTOM - Indicates the custom selection type for audio codec priority.
location
object
2 properties
2 required
ataObjectDevice
object
10 properties
10 required
CountObject
object
5 properties
5 required
ataObject
object
10 properties
10 required
SoftKeyLayoutObject
object
4 properties
4 required
SearchMemberResponse
object
1 property
GetLineKeyTemplateResponse
object
6 properties
6 required
DectAudioCodecPriorityObject
object
4 properties
4 required
placeDeviceList
object
3 properties
3 required
DeviceActivationStates
string
ACTIVATING - Indicates a device is activating. ACTIVATED - Indicates a device is activated. DEACTIVATED - Indicates a device is deactivated.
ValidateMACRequest
object
1 property
1 required
CustomizationDeviceLevelObjectDevice
object
3 properties
PutMembersRequest
object
1 property
Compression
string
ON - Minimize data use during compression. OFF - Ignore data use during compression.
BacklightTimerObject
string
ONEMIN - Set the phone's backlight to be on for one minute. FIVEMIN - Set the phone's backlight to be on for five minutes. THIRTYMIN - Set the phone's backligh…
DeviceSettingsObject
object
5 properties
5 required
stepExecutionStatusesObject
object
8 properties
5 required
WebAccessObject
object
2 properties
2 required
ApplyLineKeyTemplateJobList
object
1 property
1 required
PskObject
object
16 properties
2 required
dectObject
object
9 properties
9 required
NoiseCancellationObject
object
2 properties
2 required
WifiNetworkObjectDevice
object
4 properties
4 required
BacklightTimerObjectDevice
string
ONEMIN - Set the phone's backlight to be on for one minute. FIVEMIN - Set the phone's backlight to be on for five minutes. THIRTYMIN - Set the phone's backligh…
LdapObject
object
9 properties
9 required
SearchMemberObject
object
9 properties
6 required
jobIdResponseObject
object
15 properties
13 required
DefaultLoggingLevelObject
string
STANDARD - Enables standard logging. DEBUGGING - Enables detailed debugging logging.
deleteImageResponseObject
object
2 properties
2 required
MACAddressResponse
object
2 properties
2 required
JobDetailsResponse
object
13 properties
8 required
VlanObject
object
2 properties
2 required
wifiObjectDevice
object
4 properties
4 required
mppObject
object
47 properties
45 required
LdapObjectDevice
object
9 properties
1 required
StartJobResponse
object
15 properties
13 required
BacklightTimer68XXDevice
string
ALWAYSON - Keep the phone's backlight always on. TENSEC - Set the phone's backlight to be on for ten seconds. TWENTYSEC - Set the phone's backlight to be on fo…
mppObjectDevice
object
48 properties
46 required
AudioCodecPriorityObjectDevice
object
4 properties
4 required
DeviceLineType
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…
JobExecutionStatusObject1
object
6 properties
5 required
BackgroundImage
string
NONE - Indicates that there will be no background image set for the devices. DARKBLUE - Indicates that dark blue background image will be set for the devices.…
SnmpObject
object
5 properties
5 required
LineKeyType
string
PRIMARYLINE - PRIMARYLINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified. SHAREDLINE - Shows the a…
GetThirdPartyDeviceObject
object
11 properties
6 required
LineKeyLabelSelection
string
PERSONEXTENSION - This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed. PERSONFIRSTTHENL…
placeDevices
object
10 properties
7 required
LatestExecutionStatus
string
STARTING - Job has started. STARTED - Job is in progress. COMPLETED - Job has been completed. FAILED - Job has failed.
ProgrammableLineKeys
object
5 properties
3 required
deleteImageResponseSuccessObject
object
2 properties
2 required
ItemObject
object
4 properties
LineKeyLEDPattern
string
wifiObject
object
4 properties
4 required
AcdObject
object
2 properties
2 required
PutDeviceSettingsRequest
object
2 properties
2 required
CustomizationDeviceLevelObject
object
3 properties
ErrorMessageObject
object
3 properties
BluetoothObject
object
5 properties
2 required
AdminBatchStartJobObjectLocationCustomizations
object
3 properties
deleteImageRequestObject
object
2 properties
1 required
EnhancedMulticastObject
object
2 properties
1 required
deviceList
object
3 properties
3 required
DisplayNameSelection
string
PERSONNUMBER - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed…
WifiAudioCodecPriorityObject
object
4 properties
4 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…
JobListResponse
object
1 property
1 required
MemberObject
object
21 properties
11 required
AudioCodecPriorityObject
object
4 properties
4 required
MulticastObject
object
3 properties
2 required
HttpProxyObjectDevice
object
8 properties
2 required
Hoteling
object
3 properties
2 required
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
#Device Call Settings