Cisco Webex Wholesale API
The Webex Wholesale API — 18 operations across 10 paths, from Cisco's published OpenAPI definition.
This API exposes 18 operations across 10 paths, organized into 2 resource areas, and defines 271 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against the base URL https://webexapis.com/v1.
18 operations
10 paths
271 schemas
3 DELETE7 GET6 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Webex Wholesale 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 accepts HTTP bearer tokens (JWT) (bearerAuth).
bearer-key— e.g. Bearer YOURAUTHORIZATIONTOKENbearerAuth— e.g. Bearer YOURAUTHORIZATIONTOKEN
Paths & Operations 18
Across 10 paths, the API surfaces 18 operations — 3 DELETE, 7 GET, 6 POST, 2 PUT. They span 2 resource areas: Wholesale Billing Reports, Wholesale Provisioning. Each is listed below with its method, path, parameters, and response codes.
Wholesale Billing Reports 4
GET
/wholesale/billing/reports
List Wholesale Billing Reports
POST
/wholesale/billing/reports
Create a Wholesale Billing Report
GET
/wholesale/billing/reports/{id}
Get a Wholesale Billing Report
DELETE
/wholesale/billing/reports/{id}
Delete a Wholesale Billing Report
Wholesale Provisioning 14
GET
/wholesale/customers
List Wholesale Customers
POST
/wholesale/customers
Provision a Wholesale Customer
GET
/wholesale/customers/{customerId}
Get a Wholesale Customer
PUT
/wholesale/customers/{customerId}
Update a Wholesale Customer
DELETE
/wholesale/customers/{customerId}
Remove a Wholesale Customer
POST
/wholesale/customers/validate
Precheck a Wholesale Customer Provisioning
GET
/wholesale/subPartners
List Wholesale Sub-partners
GET
/wholesale/subscribers
List Wholesale Subscribers
POST
/wholesale/subscribers
Provision a Wholesale Subscriber
GET
/wholesale/subscribers/{subscriberId}
Get a Wholesale Subscriber
PUT
/wholesale/subscribers/{subscriberId}
Update a Wholesale Subscriber
DELETE
/wholesale/subscribers/{subscriberId}
Remove a Wholesale Subscriber
POST
/wholesale/subscribers/validate
Precheck a Wholesale Subscriber Provisioning
POST
/subscribers/{subscriberId}/emails/consentMove
Send Consent User Move Email to Pending Wholesale Subscribers
Schemas 271
The contract defines 271 schemas that model the data the API accepts and returns. The most detailed are mppObjectDevice (48 properties), mppObject (47 properties), DeviceObject (35 properties), MediaSessionQuality (31 properties). Each schema is shown below with its type and property counts.
AcdObject
object
2 properties
2 required
AcdObjectDevice
object
2 properties
2 required
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…
AdminBatchStartJobObjectLocationCustomizations
object
3 properties
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…
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.
AudioCodecPriorityObject
object
4 properties
4 required
AudioCodecPriorityObjectDevice
object
4 properties
4 required
AuthenticationMethodObject
string
NONE - No authentication. EAPFAST - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authenticat…
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.…
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…
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…
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…
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…
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…
BluetoothObject
object
5 properties
2 required
BluetoothObjectDevice
object
2 properties
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…
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…
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…
Compression
string
ON - Minimize data use during compression. OFF - Ignore data use during compression.
CountObject
object
4 properties
4 required
CustomizationDeviceLevelObject
object
3 properties
CustomizationDeviceLevelObjectDevice
object
3 properties
CustomizationObject
object
4 properties
DectAudioCodecPriorityObject
object
4 properties
4 required
DectDeviceList
object
5 properties
2 required
DectVlanObject
object
2 properties
2 required
DefaultLoggingLevelObject
string
STANDARD - Enables standard logging. DEBUGGING - Enables detailed debugging logging.
DeviceActivationStates
string
ACTIVATING - Indicates a device is activating. ACTIVATED - Indicates a device is activated. DEACTIVATED - Indicates a device is deactivated.
DeviceSettingsObject
object
5 properties
5 required
DeviceSettingsObjectForDeviceLevel
object
5 properties
5 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…
DisplayCallqueueAgentSoftkeysObject
string
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…
GetMemberResponse
object
3 properties
2 required
Hoteling
object
3 properties
2 required
UserHotelingRequestPatch
object
1 property
1 required
HotelingRequest
object
3 properties
1 required
HttpProxyObject
object
8 properties
8 required
HttpProxyObjectDevice
object
8 properties
2 required
JobListResponse
object
1 property
1 required
LdapObject
object
9 properties
9 required
LdapObjectDevice
object
9 properties
1 required
LineKeyLEDPattern
string
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…
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…
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…
ListDectDeviceType
object
1 property
1 required
ListDeviceSettingsObject
object
4 properties
4 required
MACAddressResponse
object
2 properties
2 required
MacStatusObject
object
4 properties
2 required
MemberObject
object
21 properties
9 required
MemberType
string
PEOPLE - Indicates the associated member is a person. PLACE - Indicates the associated member is a workspace. VIRTUALLINE - Indicates the associated member is…
MppAudioCodecPriorityObject
object
4 properties
4 required
MppAudioCodecPriorityObjectDevice
object
4 properties
4 required
MppVlanObject
object
3 properties
1 required
MppVlanObjectDevice
object
3 properties
1 required
NoiseCancellationObject
object
2 properties
2 required
PhoneLanguage
string
PERSONLANGUAGE - Indicates a person's announcement language.
PoeMode
string
NORMAL - Use normal power consumption. MAXIMUM - Use maximum power consumption.
PskObject
object
16 properties
2 required
PutDeviceSettingsRequest
object
2 properties
2 required
PutMemberObject
object
10 properties
8 required
PutMembersRequest
object
1 property
ScreenTimeoutObject
object
2 properties
2 required
SearchMemberObject
object
9 properties
4 required
SearchMemberResponse
object
1 property
SelectionType
string
REGIONAL - Indicates the regional selection type for audio codec priority. CUSTOM - Indicates the custom selection type for audio codec priority.
SnmpObject
object
5 properties
5 required
SoftKeyLayoutObject
object
4 properties
4 required
SoftKeyMenuObject
object
14 properties
14 required
StartJobResponse
object
15 properties
13 required
UsbPortsObject
object
3 properties
3 required
ValidateMACRequest
object
1 property
1 required
VlanObject
object
2 properties
2 required
VlanObjectDevice
object
2 properties
2 required
VolumeSettingsObject
object
6 properties
6 required
WebAccessObject
object
2 properties
2 required
WifiAudioCodecPriorityObject
object
4 properties
4 required
WifiAudioCodecPriorityObjectDevice
object
4 properties
4 required
WifiNetworkObject
object
4 properties
4 required
WifiNetworkObjectDevice
object
4 properties
4 required
ataObject
object
10 properties
10 required
ataObjectDevice
object
10 properties
10 required
dectObject
object
9 properties
9 required
deviceList
object
3 properties
3 required
deviceOwner
object
4 properties
2 required
devices
object
11 properties
7 required
DeviceType
string
MPP - Cisco Multiplatform Phone ATA - Analog Telephone Adapters GENERICSIP - GENERIC Session Initiation Protocol ESIM - Esim Supported Webex Go ROOMOS - Cisco…
jobIdResponseObject
object
17 properties
15 required
location
object
2 properties
2 required
mppObject
object
47 properties
45 required
mppObjectDevice
object
48 properties
46 required
placeDeviceList
object
3 properties
3 required
placeDevices
object
10 properties
7 required
wifiObject
object
4 properties
4 required
wifiObjectDevice
object
4 properties
4 required
GetLineKeyTemplateResponse
object
6 properties
6 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…
ApplyLineKeyTemplateJobList
object
1 property
1 required
ApplyLineKeyTemplateJobDetails
object
13 properties
11 required
ApplyLineKeyTemplateJobErrors
object
2 properties
1 required
LineKeyTemplateAdvisoryTypes
object
5 properties
PostApplyLineKeyTemplateRequest
object
7 properties
2 required
PostLineKeyTemplateRequest
object
4 properties
3 required
ProgrammableLineKeys
object
5 properties
3 required
PutLineKeyTemplateRequest
object
2 properties
1 required
lineKeyTemplatesResponse
object
4 properties
4 required
GetThirdPartyDeviceObject
object
11 properties
6 required
PutThirdPartyDevice
object
1 property
1 required
DeviceLayout
object
5 properties
2 required
KEMKeys
object
6 properties
4 required
LayoutMode
string
DEFAULT - Default layout mode when a new device is added. CUSTOM - Enables a device to have its custom layout.
RebuildPhonesPostRequest
object
1 property
1 required
RebuildPhonesList
object
1 property
1 required
RebuildPhonesJob
object
14 properties
10 required
EnhancedMulticastObject
object
2 properties
1 required
MulticastObject
object
3 properties
2 required
listBackgroundImagesObject
object
2 properties
2 required
deleteImageResponseObject
object
2 properties
2 required
deleteImageResponseSuccessObject
object
2 properties
2 required
deleteImageRequestObject
object
2 properties
1 required
userDeviceCount
object
2 properties
2 required
DeviceDynamicSettingsValidationSchemaGet
object
1 property
DeviceDynamicSettingsSettingsGroupsGet
object
2 properties
DeviceTag
object
7 properties
DeviceSettingsGroup
object
5 properties
DeviceSettingsGroupTag
object
1 property
ValidationRule
object
Validation rules and constraints for device setting values.
8 properties
CustomerDeviceDynamicSettingsListPostRequest
object
1 property
CustomerDeviceDynamicSettingsListPostResponse
object
3 properties
CustomerDevicePostTag
object
5 properties
DynamicDeviceSettingsCustomerParentLevel
string
The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response.
LocationDeviceDynamicSettingsListPostRequest
object
1 property
LocationDeviceDynamicSettingsListPostResponse
object
3 properties
LocationDevicePostResponseTag
object
5 properties
LocationParentLevel
string
The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response.
DeviceDynamicSettingsListPostRequest
object
1 property
DeviceDynamicSettingsListPostResponse
object
2 properties
1 required
DeviceDynamicSettingsPutRequest
object
1 property
DevicePostResponseTag
object
5 properties
2 required
DeviceParentLevel
string
The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response.
DevicePutItem
object
3 properties
2 required
Action
string
The action to perform on the setting. When action is SET, tag is updated to specified value. When action is CLEAR, the tag value at device level is removed, an…
PostDynamicDeviceSettingsJobResponse
object
14 properties
12 required
LatestExecutionStatus
string
STARTING - Indicates the job has started. STARTED - Indicates the job is in progress. COMPLETED - Indicates the job has completed. FAILED - Indicates the job h…
JobExecutionStatusObject
object
9 properties
1 required
JobExecutionStatusObject1
object
6 properties
1 required
stepExecutionStatusesObject
object
8 properties
1 required
PostDynamicSettingsUpdateStartJobRequest
object
2 properties
1 required
DynamicSettingsUpdateJobDevicePostItem
object
4 properties
3 required
DynamicDeviceSettingsJobListResponse
object
1 property
1 required
ErrorResponseObject
object
1 property
ItemObject
object
3 properties
ErrorObject
object
Error details object containing error information.
2 properties
ErrorMessageObject
object
3 properties
supportedDevicesObject
object
2 properties
2 required
UpgradeChannelObject
string
DeviceObject
object
35 properties
28 required
TypeObject
string
MPP - Cisco Multiplatform Phone ATA - Analog Telephone Adapters GENERICSIP - GENERIC Session Initiation Protocol ESIM - Esim Supported Webex Go DESKPHONE - Des…
ManagedByObject
string
CISCO - Devices managed by Cisco. CUSTOMER - Devices managed by a customer that are approved by a Cisco account manager to be enabled for provisioning in the c…
ManufacturerObject
string
CISCO - Devices manufactured by Cisco. THIRDPARTY - Devices manufactured by a third-party that are approved by a Cisco account manager to be enabled for provis…
SupportedForObject
string
OnboardingMethodObject
string
SupportsLogCollectionObject
string
NONE - Devices which does not support log collection. CISCOPRT - Devices which supports Cisco PRT log collection. CISCOROOMOS - Devices which supports Cisco Ro…
DeviceSettingsConfigurationObject
string
WEBEXCALLINGDEVICECONFIGURATION - Devices which supports Webex Calling Device Settings Configuration. WEBEXDEVICECONFIGURATION - Devices which supports Webex D…
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…
ActivationCode
object
2 properties
Device
object
29 properties
1 required
DeviceCollectionResponse
object
1 property
NetworkConnectivityType
string
The current network connectivity for the device.
DeviceConnectionStatus
string
The connection status of the device.
DevicePermissions
string
DeviceCapabilities
string
ManagedBy
string
Entity managing the device configuration.
DevicePlatform
string
Device platform
MaintenanceMode
string
The maintenance mode of the device.
Event
object
8 properties
7 required
EventCollectionResponse
object
1 property
EventResourceEnum
string
attachmentActions - State changed on a card attachment businessTexts - A user sent or received a SMS message callrecords - A Webex call was made to/from a user…
EventTypeEnum
string
created - The resource has been created updated - A property on the resource has been updated deleted - The resource has been deleted ended - The meeting has e…
Recipient
object
4 properties
HotDeskSessionsResponse
object
1 property
HotDesk
object
5 properties
Location
object
9 properties
4 required
PutCommonLocationObject
object
4 properties
PostCommonLocationObject
object
8 properties
5 required
LocationsCollectionResponse
object
1 property
Floor
object
4 properties
1 required
FloorUpdated
object
4 properties
1 required
FloorCreationRequest
object
2 properties
1 required
FloorUpdateRequest
object
2 properties
1 required
FloorCollectionResponse
object
1 property
MeetingQualitiesResponse
object
1 property
MediaSessionQuality
object
31 properties
1 required
VideoIn
object
11 properties
VideoOut
object
11 properties
AudioIn
object
11 properties
AudioOut
object
11 properties
ShareIn
object
11 properties
ShareOut
object
11 properties
Resources
object
4 properties
Report
object
10 properties
ReportCollectionResponse
object
1 property
Template
object
7 properties
TemplateCollectionResponse
object
1 property
Person
object
29 properties
PersonCollectionResponse
object
2 properties
RecordingReportSummaryObject
object
7 properties
RecordingReportObject
object
7 properties
RecordingAchriveSummaryObject
object
4 properties
RecordingArchiveReportObject
object
12 properties
MeetingRecordingArchiveParticipant
object
5 properties
MeetingRecordingArchiveChat
object
5 properties
MeetingRecordingArchivePoll
object
4 properties
MeetingRecordingArchivePollQuestion
object
4 properties
MeetingRecordingArchiveUser
object
3 properties
MeetingRecordingArchivePollAnswerSummary
object
4 properties
MeetingRecordingArchivePollRespondent
object
4 properties
MeetingRecordingArchiveQA
object
7 properties
MeetingRecordingArchiveQAAnswer
object
6 properties
MeetingRecordingArchiveSystemInfo
object
2 properties
SystemInfoCatalog
object
19 properties
RecordingObject
object
18 properties
15 required
RecordingObjectForAdminAndCO
object
18 properties
15 required
RecordingObjectWithDirectDownloadLinks
object
19 properties
15 required
DeleteRecordingObject
object
2 properties
BulkSoftDeleteRecordingObject
object
2 properties
1 required
BulkRestoreRecordingObject
object
3 properties
BulkPurgeRecordingObject
object
3 properties
ShareRecordingByIdObject
object
4 properties
ShareRecordingByLinkObject
object
5 properties
Webhook
object
10 properties
WebhookCollectionResponse
object
1 property
WorkspaceLocationsCreationRequest
object
7 properties
5 required
WorkspaceLocationsUpdateRequest
object
8 properties
5 required
WorkspaceLocationsCollectionResponse
object
1 property
WorkspaceLocationFloorsCreationRequest
object
2 properties
1 required
WorkspaceLocationFloorsUpdateRequest
object
2 properties
1 required
WorkspaceLocationFloorsCollectionResponse
object
1 property
WorkspaceMetricsResponse
object
8 properties
2 required
DurationMetric
object
3 properties
WorkspaceDurationMetricsResponse
object
7 properties
1 required
WorkspaceIssue
object
6 properties
Workspace
object
22 properties
WorkspaceCreationRequest
object
15 properties
1 required
WorkspaceUpdateRequest
object
13 properties
WorkspaceCollectionResponse
object
1 property
CapabilityResponse
object
1 property
CapabilityMap
object
The map of workspace capabilities.
7 properties
SupportAndConfiguredInfo
object
Support and configured information for a workspace capability.
2 properties
ListReport
object
6 properties
ReportError
object
2 properties
ReportId
object
5 properties
WholesaleBillingReportsListResponse
object
1 property
WholesalePackagesCustomer
string
commonareacalling - Webex Common Area Calling Package. webexcalling - Webex Calling Package. webexmeetings - Webex Meetings Package. webexsuite - Webex Suite P…
Address
object
6 properties
Customer
object
8 properties
CustomerListResponse
object
1 property
CustomerProvisioningPrecheckResponse
object
2 properties
Error
object
2 properties
Package
object
5 properties
ResourceURL
object
1 property
ResourceDetails
object
1 property
SubPartner
object
5 properties
SubPartnersListResponse
object
1 property
WholesalePackagesSubscriber
string
webexcalling - Calling Basic Package. webexmeetings - Meetings Package. webexsuite - Suite Package. webexvoice - Voice Package. cxessentials - Customer Assist…
Subscriber
object
11 properties
SubscriberListResponse
object
1 property
SubscriberProvisioningPrecheckResponse
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Wholesale
Where this information came from
This is an independent, third-party profile of Cisco Webex Wholesale API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.