Webex Cloud Calling
The Webex Cloud Calling APIs enable comprehensive management of cloud-based calling services, including user provisioning, device assignment, call routing,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Webex Cloud Calling APIs enable comprehensive management of cloud-based calling services, including user provisioning, device assignment, call routing, feature configuration, and number management. These APIs facilitate integration with enterprise directories, automation of telephony workflows, and centralized management of global calling infrastructure. Use cases include automated onboarding, self-service portals, integration with CRM/ERP systems, and real-time monitoring of call quality and usage.
Endpoints 400
AI Receptionist for Webex Calling
- GETList AI Receptionists
/telephony/config/aiReceptionistsGet list of AI Receptionists. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.… - POSTValidate Country for AI Receptionist
/telephony/config/aiReceptionists/actions/validateCountry/invokeValidates if country passed in the request supports AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and… - GETList AI Receptionist Templates
/telephony/config/aiReceptionists/templatesGet AI Receptionist template list. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Templates help… - GETGet AI Receptionist Template Details
/telephony/config/aiReceptionists/templates/:templateIdGet AI Receptionist template details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Use templates to… - POSTValidate AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/actions/validate/invokeValidates AI Receptionist name at location level and max limit at org level. AI Receptionist is a Webex Calling feature that uses AI to greet callers and… - GETList Available Numbers for AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/availableNumbersList and search numbers that can be assigned as AI Receptionist number. AI Receptionist is a Webex Calling feature that uses AI to greet callers and… - POSTCreate an AI Receptionist
/telephony/config/locations/:locationId/aiReceptionistsCreate a new AI Receptionist for a location. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people… - GETGet AI Receptionist Details
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistIdGet AI Receptionist details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.… - PUTUpdate an AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistIdUpdate an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This… - DELETEDelete an AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistIdDelete an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This… - GETGet AI Receptionist Voices
/telephony/config/locations/:locationId/aiReceptionists/voicesGet list of available AI Receptionist voices. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API… - GETList AI Receptionist Intents
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/intentsGet list of AI Receptionist Intents. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent… - POSTCreate AI Receptionist Intent
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/intentsCreate a new AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent… - GETGet AI Receptionist Intent
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/intents/:intentIdGet details of a specific AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls.… - PUTModify AI Receptionist Intent
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/intents/:intentIdModify an existing AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents… - DELETEDelete AI Receptionist Intent
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/intents/:intentIdDelete an AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent… - GETList Knowledge Bases
/telephony/config/knowledgeBasesGet list of Knowledge Bases for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API… - POSTCreate a Knowledge Base
/telephony/config/knowledgeBasesCreate a new Knowledge Base for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API… - GETGet Knowledge Base Details
/telephony/config/knowledgeBases/:knowledgeBaseIdGet details of a specific Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API… - PUTModify a Knowledge Base
/telephony/config/knowledgeBases/:knowledgeBaseIdModify an existing Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a… - DELETEDelete a Knowledge Base
/telephony/config/knowledgeBases/:knowledgeBaseIdDelete a Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full… - GETList Knowledge Base Documents
/telephony/config/knowledgeBases/:knowledgeBaseId/documentsGet list of documents in a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API… - POSTCreate Knowledge Base Document
/telephony/config/knowledgeBases/:knowledgeBaseId/documentsCreate a new document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API… - POSTUpload Knowledge Base Document
/telephony/config/knowledgeBases/:knowledgeBaseId/documents/actions/upload/invokeUpload a document to a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. Supported file… - GETGet Knowledge Base Document Details
/telephony/config/knowledgeBases/:knowledgeBaseId/documents/:documentIdGet details of a specific document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries.… - PUTModify Knowledge Base Document
/telephony/config/knowledgeBases/:knowledgeBaseId/documents/:documentIdModify a document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API allows… - DELETEDelete Knowledge Base Document
/telephony/config/knowledgeBases/:knowledgeBaseId/documents/:documentIdDelete a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API… - POSTDownload Knowledge Base Document
/telephony/config/knowledgeBases/:knowledgeBaseId/documents/:documentId/actions/download/invokeDownload a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. The response… - GETGet Call Recording Settings for an AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/callRecordingsRetrieve Call Recording settings for an AI Receptionist. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the… - PUTUpdate Call Recording Settings for an AI Receptionist
/telephony/config/locations/:locationId/aiReceptionists/:aiReceptionistId/callRecordingsUpdate Call Recording settings for an AI Receptionist. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the…
External Voicemail
- POSTSet or Clear Message Waiting Indicator (MWI) Status
/telephony/externalVoicemail/mwi?id=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=Enables an external voicemail service to SET or CLEAR the Message Waiting Indicator (MWI) for a person or workspace. Invoke the API using a bearer token from… - POSTSet or Clear Message Waiting Indicator (MWI) Status by Member ID
/telephony/externalVoicemail/members/:memberId/mwiEnables an external voicemail service to SET or CLEAR the Message Waiting Indicator (MWI) for a person or workspace. Invoke the API using a bearer token from…
Calling Metrics
- GETWebex Calling Call Quality Stats
/v1/analytics/callQualityStatsReturns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality…
Export Schedule Usage Jobs
- GETList Export Schedule Usage Jobs
/telephony/config/jobs/schedules/exportUsageLists the jobs that export the people and services using a business hours or holiday schedule. Each job runs asynchronously and produces a CSV when it… - POSTCreate Export Schedule Usage Job
/telephony/config/jobs/schedules/exportUsageStarts an export job for a business hours or holiday schedule and returns the job details. Use the job status API to check its progress and retrieve the CSV… - GETGet Export Schedule Usage Job Status
/telephony/config/jobs/schedules/exportUsage/:jobIdGets the current status of a job that exports the people and services using a business hours or holiday schedule. Use the encoded job ID returned when the… - POSTPause Export Schedule Usage Job
/telephony/config/jobs/schedules/exportUsage/:jobId/actions/pause/invokePauses a job that exports the people and services using a business hours or holiday schedule. Use the encoded job ID returned when the export job was created.… - POSTResume Export Schedule Usage Job
/telephony/config/jobs/schedules/exportUsage/:jobId/actions/resume/invokeResumes a paused job that exports the people and services using a business hours or holiday schedule. Use the encoded job ID returned when the export job was… - GETList Export Schedule Usage Job Errors
/telephony/config/jobs/schedules/exportUsage/:jobId/errorsReturns itemized errors reported while exporting schedule usage for an organization. Clients can use these errors to identify schedule records that could not…
Features: Call Recording
- GETGet Call Recording Settings
/telephony/config/callRecordingRetrieve call recording settings for the organization. The Call Recording feature enables authorized agents to record any active call that Webex Contact… - PUTUpdate Call Recording Settings
/telephony/config/callRecordingUpdate call recording settings for the organization. The Call Recording feature enables authorized agents to record any active call that Webex Contact Center… - GETGet Call Recording Terms of Service Settings
/telephony/config/callRecording/vendors/:vendorId/termsOfServiceRetrieve call recording terms of service settings for the organization. The Call Recording feature enables authorized agents to record any active call that… - PUTUpdate Call Recording Terms of Service Settings
/telephony/config/callRecording/vendors/:vendorId/termsOfServiceUpdate call recording terms of service settings for the given vendor. The Call Recording feature enables authorized agents to record any active call that… - GETGet Details for the Organization Compliance Announcement Setting
/telephony/config/callRecording/complianceAnnouncementRetrieve the organization compliance announcement settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with… - PUTUpdate the Organization Compliance Announcement
/telephony/config/callRecording/complianceAnnouncementUpdate the organization compliance announcement. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback… - GETGet Details of Call Recording Compliance Announcement for the Location
/telephony/config/locations/:locationId/callRecording/complianceAnnouncementRetrieve the location compliance announcement settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the… - PUTUpdate Call Recording Compliance Announcement for the Location
/telephony/config/locations/:locationId/callRecording/complianceAnnouncementUpdate the location compliance announcement. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of… - GETGet Call Recording Regions
/telephony/config/callRecording/regionsRetrieve all the call recording regions that are available for an organization. The Call Recording feature supports multiple third-party call recording… - GETGet Call Recording Vendor Users
/telephony/config/callRecording/vendorUsersRetrieve call recording vendor users of an organization. This API is used to get the list of users who are assigned to the default call-recording vendor of… - PUTSet Call Recording Vendor for a Location
/telephony/config/locations/:locationId/callRecording/vendorAssign a call recording vendor to a location of an organization. Response will be 204 if the changes can be applied immediatley otherwise 200 with a job ID is… - GETGet Location Call Recording Vendors
/telephony/config/locations/:locationId/callRecording/vendorsRetrieve details of the call recording vendor that the location is assigned and also a list of vendors. The Call Recording feature supports multiple… - GETGet Call Recording Vendor Users for a Location
/telephony/config/locations/:locationId/callRecording/vendorUsersRetrieve call recording vendor users of a location. This API is used to get the list of users assigned to the call recording vendor of the location. The Call… - GETList Call Recording Jobs
/telephony/config/jobs/callRecordingGet the list of all call recording jobs in an organization. The Call Recording feature supports multiple third-party call recording providers, or vendors, to… - GETGet the Job Status of a Call Recording Job
/telephony/config/jobs/callRecording/:jobIdGet the details of a call recording job by its job ID. The Call Recording feature supports multiple third-party call recording providers, or vendors, to… - GETGet Job Errors for a Call Recording Job
/telephony/config/jobs/callRecording/:jobId/errorsGet errors for a call recording job in an organization. The Call Recording feature supports multiple third-party call recording providers, or vendors, to… - GETGet Organization Call Recording Vendors
/telephony/config/callRecording/vendorsReturns what the current vendor is as well as a list of all the available vendors. The Call Recording feature supports multiple third-party call recording… - PUTSet Organization Call Recording Vendor
/telephony/config/callRecording/vendorReturns a Job ID that you can use to get the status of the job. The Call Recording feature supports multiple third-party call recording providers, or vendors,… - GETGet Organization Call Recording Announcement Settings
/telephony/config/callRecording/announcementsRetrieve the organization call recording announcements setting. The call recording Announcement feature interacts with the Call Recording feature,… - PUTUpdate Organization Call Recording Announcement Settings
/telephony/config/callRecording/announcementsUpdate Organization Call Recording Announcement Settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the… - GETGet Location Call Recording Announcement Settings
/telephony/config/locations/:locationId/callRecording/announcementsRetrieve the location call recording announcements setting. The Compliance Announcement feature interacts with the Call Recording feature, specifically with… - PUTUpdate Location Call Recording Announcement Settings
/telephony/config/locations/:locationId/callRecording/announcementsUpdate Location Call Recording Announcement Settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the…
Org-Wide Schedules
- GETList Organization and Location Schedules
/telephony/config/schedulesLists organization-level and Location-level schedules. Results can be filtered by name, type, level, and location, and pagination. A time schedule establishes… - POSTCreate an Organization-Level Schedule
/telephony/config/schedulesCreates an organization-level schedule without events and returns its identifier. A time schedule establishes a set of times during the day or holidays in the… - GETGet an Organization Schedule
/telephony/config/schedules/:scheduleType/:scheduleIdReturns an organization-level schedule and its event details. A time schedule establishes a set of times during the day or holidays in the year in which a… - PUTUpdate an Organization Schedule
/telephony/config/schedules/:scheduleType/:scheduleIdRenames an organization-level schedule and returns its updated identifier. A time schedule establishes a set of times during the day or holidays in the year… - DELETEDelete an Organization Schedule
/telephony/config/schedules/:scheduleType/:scheduleIdDeletes an organization-level schedule. A successful deletion returns no response body. A time schedule establishes a set of times during the day or holidays… - GETList People and Features Using a Schedule
/telephony/config/schedules/:scheduleType/:scheduleId/usageLists people and calling feature instances that use the specified organization schedule. Results can be filtered by location and are returned with pagination.… - POSTValidate an Organization Schedule Name
/telephony/config/schedules/actions/validate/invokeValidates whether an organization schedule name and type are available without saving a schedule. The response is empty when the name is available. A time… - POSTValidate an Organization Schedule Event Name
/telephony/config/schedules/:scheduleType/:scheduleId/events/actions/validate/invokeChecks whether an event name is available in the specified organization schedule without creating or changing an event. A time schedule establishes a set of… - GETGet an Organization Schedule Event
/telephony/config/schedules/:scheduleType/:scheduleId/events/:eventIdReturns an event from an organization-level schedule. A time schedule establishes a set of times during the day or holidays in the year in which a Webex… - PUTUpdate an Organization Schedule Event
/telephony/config/schedules/:scheduleType/:scheduleId/events/:eventIdUpdates an event in an organization-level schedule and returns its identifier. Omitted fields are left unchanged. A time schedule establishes a set of times… - DELETEDelete an Organization Schedule Event
/telephony/config/schedules/:scheduleType/:scheduleId/events/:eventIdDeletes an event from an organization-level schedule. A successful deletion returns no response body. A time schedule establishes a set of times during the… - POSTCreate an Event in an Organization Schedule
/telephony/config/schedules/:scheduleType/:scheduleId/eventsCreates an event in an organization-level schedule and returns its identifier. A time schedule establishes a set of times during the day or holidays in the…
User Call Settings (2/2)
- GETRetrieve a person's Application Services Settings New
/people/:personId/features/applicationsDeprecated. Gets mobile and PC applications settings for a user. Application services let you determine the ringing behavior for calls made to people in… - GETList Move Users Jobs
/telephony/config/jobs/person/moveLocationLists all the Move Users jobs for the given organization in order of most recent job to oldest job irrespective of its status. This API requires a full or… - POSTValidate or Initiate Move Users Job
/telephony/config/jobs/person/moveLocationThis API allows the user to perform one of the following operations: * Setting the validate attribute to true validates the user move. * Setting the validate… - GETGet Move Users Job Status
/telephony/config/jobs/person/moveLocation/:jobIdReturns the status and other details of the job. This API requires a full or read-only administrator auth token with a scope of… - POSTPause the Move Users Job
/telephony/config/jobs/person/moveLocation/:jobId/actions/pause/invokePause the running Move Users Job. A paused job can be resumed. This API requires a full administrator auth token with a scope of… - POSTResume the Move Users Job
/telephony/config/jobs/person/moveLocation/:jobId/actions/resume/invokeResume the paused Move Users Job that is in paused status. This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write. - GETList Move Users Job errors
/telephony/config/jobs/person/moveLocation/:jobId/errorsLists all error details of Move Users job. This will not list any errors if exitCode is COMPLETED. If the status is COMPLETED_WITH_ERRORS then this lists the… - GETRetrieve Music On Hold Settings for a Person
/telephony/config/people/:personId/musicOnHoldRetrieve the person's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving a person's music on hold… - PUTConfigure Music On Hold Settings for a Person
/telephony/config/people/:personId/musicOnHoldConfigure a person's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold settings… - GETRetrieve Access Codes for a Person
/telephony/config/people/:personId/outgoingPermission/accessCodesRetrieve the person's access codes. Access codes are used to bypass permissions. This API requires a full, user, or read-only administrator or location… - PUTModify Access Codes for a Person
/telephony/config/people/:personId/outgoingPermission/accessCodesModify a person's access codes. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth… - POSTCreate Access Codes for a Person
/telephony/config/people/:personId/outgoingPermission/accessCodesCreate new Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator… - DELETEDelete Access Codes for a Person
/telephony/config/people/:personId/outgoingPermission/accessCodesDeletes all Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator… - GETRetrieve Transfer Numbers for a Person
/telephony/config/people/:personId/outgoingPermission/autoTransferNumbersRetrieve the person's transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person… - PUTModify Transfer Numbers for a Person
/telephony/config/people/:personId/outgoingPermission/autoTransferNumbersModify a person's transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person assigned… - GETRetrieve Digit Patterns for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatternsRetrieve the person's digit patterns. Digit patterns are used to bypass permissions. Retrieving digit patterns requires a full or user or read-only… - PUTModify the Digit Pattern Category Control Settings for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatternsModifies whether this user uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires… - POSTCreate Digit Patterns for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatternsCreate a new digit pattern for the given person. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full or user or location… - DELETEDelete all Digit Patterns for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatternsDelete all digit patterns for a Person. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full or user or location… - GETRetrieve Digit Pattern Details for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternIdRetrieve the digit pattern details for a person. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full or user… - PUTModify a Digit Pattern for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternIdModify a digit pattern for a Person. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full or user or location… - DELETEDelete a Digit Pattern for a Person
/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternIdDelete a digit pattern for a Person. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full or user or location… - PUTAssign or Unassign numbers to a person
/telephony/config/people/:personId/numbersAssign or unassign alternate phone numbers to a person. Each location has a set of phone numbers that can be assigned to people, workspaces, or features.… - GETGet Preferred Answer Endpoint
/telephony/config/people/:personId/preferredAnswerEndpointGet the person's preferred answer endpoint and the list of endpoints available for selection. The preferred answer endpoint is null if one has not been… - PUTModify Preferred Answer Endpoint
/telephony/config/people/:personId/preferredAnswerEndpointSets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the preferredAnswerEndpointId attribute must be set to null.<br>… - GETSearch Shared-Line Appearance Members
/telephony/config/people/:personId/applications/:applicationId/availableMembersDeprecated. Retrieve members available for shared-line assignment to a Webex Calling Apps Desktop device. This API requires a full, user, or location… - GETGet Shared-Line Appearance Members
/telephony/config/people/:personId/applications/:applicationId/membersDeprecated. Retrieve primary and secondary members assigned to a shared line on a Webex Calling Apps Desktop device. This API requires a full, user, or… - PUTPut Shared-Line Appearance Members
/telephony/config/people/:personId/applications/:applicationId/membersDeprecated. Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps Desktop device. This API requires a full or user… - PUTModify a person's voicemail passcode
/telephony/config/people/:personId/voicemail/passcodeModify a person's voicemail passcode. Modifying a person's voicemail passcode requires a full administrator, user administrator or location administrator auth… - GETGet Message Summary
/telephony/voiceMessages/summaryGet a summary of the voicemail messages for the user. - GETList Messages
/telephony/voiceMessagesGet the list of all voicemail messages for the user. - DELETEDelete Message
/telephony/voiceMessages/:messageIdDelete a specfic voicemail message for the user. - POSTMark As Read
/telephony/voiceMessages/markAsReadUpdate the voicemail message(s) as read for the user. If the messageId is provided, then only mark that message as read. Otherwise, all messages for the user… - POSTMark As Unread
/telephony/voiceMessages/markAsUnreadUpdate the voicemail message(s) as unread for the user. If the messageId is provided, then only mark that message as unread. Otherwise, all messages for the… - GETRetrieve Agent's List of Available Caller IDs
/telephony/config/people/:personId/agent/availableCallerIdsGet the list of call queues and hunt groups available for caller ID use by this person as an agent. This API requires a full, user, or read-only administrator… - GETRetrieve Agent's Caller ID Information
/telephony/config/people/:personId/agent/callerIdRetrieve the Agent's Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller… - PUTModify Agent's Caller ID Information
/telephony/config/people/:personId/agent/callerIdModify Agent's Caller ID Information. Each Agent will be able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or Hunt Group's… - GETRead Call Bridge Settings for a Person
/telephony/config/people/:personId/features/callBridgeRetrieve a person's Call Bridge settings. This API requires a full, user or read-only administrator or location administrator auth token with a scope of… - PUTConfigure Call Bridge Settings for a Person
/telephony/config/people/:personId/features/callBridgeConfigure a person's Call Bridge settings. This API requires a full or user administrator or location administrator auth token with the… - GETGet Person Secondary Available Phone Numbers
/telephony/config/people/:personId/secondary/availableNumbersList standard numbers that are available to be assigned as a person's secondary phone number. These numbers are associated with the location of the person… - GETGet Person Fax Message Available Phone Numbers
/telephony/config/people/:personId/faxMessage/availableNumbersList standard numbers that are available to be assigned as a person's FAX message number. These numbers are associated with the location of the person… - GETGet Person Call Forward Available Phone Numbers
/telephony/config/people/:personId/callForwarding/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a person's call forward number. These numbers are associated with the location… - GETGet Person Primary Available Phone Numbers
/telephony/config/people/primary/availableNumbersList numbers that are available to be assigned as a person's primary phone number. By default, this API returns standard and mobile numbers from all locations… - GETGet Person ECBN Available Phone Numbers
/telephony/config/people/:personId/emergencyCallbackNumber/availableNumbersList standard numbers that are available to be assigned as a person's emergency callback number. These numbers are associated with the location of the person… - GETGet Person Call Intercept Available Phone Numbers
/telephony/config/people/:personId/callIntercept/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a person's call intercept number. These numbers are associated with the… - GETRetrieve a Person's MS Teams Settings
/telephony/config/people/:personId/settings/msTeams<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div> Retrieve a person's MS Teams settings. At a person level, MS… - PUTConfigure a Person's MS Teams Setting
/telephony/config/people/:personId/settings/msTeams<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div> Configure a Person's MS Teams setting. MS Teams settings can be… - GETGet Personal Assistant
/telephony/config/people/:personId/features/personalAssistantRetrieve Personal Assistant details for a specific user. Personal Assistant is used to manage a user's incoming calls when they are away. Retrieving Personal… - PUTUpdate Personal Assistant
/telephony/config/people/:personId/features/personalAssistantUpdate Personal Assistant details for a specific user. Personal Assistant is used to manage a user's incoming calls when they are away. Updating Personal… - GETRetrieve the List of Available Features
/telephony/config/people/:personId/modeManagement/availableFeaturesRetrieve a list of feature identifiers that can be assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto… - GETRetrieve the List of Features Assigned to a User for Mode Management
/telephony/config/people/:personId/modeManagement/featuresRetrieve a list of feature identifiers that are already assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto… - PUTAssign a List of Features to a User for Mode Management
/telephony/config/people/:personId/modeManagement/featuresAssign a user a list of feature identifiers for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt… - GETGet the User’s Selective Call Accept Criteria List
/telephony/config/people/:personId/selectiveAcceptRetrieve selective call accept criteria list for a user. With the selective call accept feature, you can create different rules to accept specific calls based… - PUTUpdate User’s Selective Call Accept Criteria
/telephony/config/people/:personId/selectiveAcceptModify selective call accept setting for a user. With the Selective Call accept feature, you can create different rules to accept specific calls based on the… - POSTCreate a Criteria to the User’s Selective Call Accept Service
/telephony/config/people/:personId/selectiveAccept/criteriaAdd a criteria to the user's selective call accept service. With the Selective Call accept feature, you can create different rules to accept specific calls… - GETGet a Criteria for the User’s Selective Call Accept Service
/telephony/config/people/:personId/selectiveAccept/criteria/:idGet the criteria details for the user's selective call accept service. With the Selective Call accept feature, you can create different rules to accept… - PUTModify a Criteria From the User’s Selective Call Accept Service
/telephony/config/people/:personId/selectiveAccept/criteria/:idModify a criteria for the user's selective call accept service. With the Selective Call Accept feature, you can create different rules to accept specific… - DELETEDelete a Criteria From the User’s Selective Call Accept service
/telephony/config/people/:personId/selectiveAccept/criteria/:idDelete a criteria from the user's selective call accept criteria list. With the Selective Call Accept feature, you can create different rules to accept… - GETGet the User’s Selective Call Rejection Criteria Listing
/telephony/config/people/:personId/selectiveRejectRetrieve selective call rejection criteria for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls… - PUTUpdate User’s Selective Call Rejection Criteria List
/telephony/config/people/:personId/selectiveRejectModify selective call rejection setting for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls based… - POSTCreate a Criteria to the User’s Selective Call Rejection Service
/telephony/config/people/:personId/selectiveReject/criteriaAdd a criteria to the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific… - GETGet a Criteria for the User’s Selective Call Rejection Service
/telephony/config/people/:personId/selectiveReject/criteria/:idGet a criteria for the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific… - PUTModify a Criteria for the User’s Selective Call Rejection Service
/telephony/config/people/:personId/selectiveReject/criteria/:idModify a criteria for the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject… - DELETEDelete a Criteria From the User’s Selective Call Rejection Service
/telephony/config/people/:personId/selectiveReject/criteria/:idDelete a criteria from the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject… - GETGet the User’s Selective Call Forwarding
/telephony/config/people/:personId/selectiveForwardRetrieve selective call forwarding criteria for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls… - PUTUpdate User’s Selective Call Forwarding Criteria List
/telephony/config/people/:personId/selectiveForwardModify selective call forwarding setting for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls… - POSTCreate a Criteria to the User’s Selective Call Forwarding Service
/telephony/config/people/:personId/selectiveForward/criteriaAdd a criteria to the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific… - GETGet a Criteria for the User’s Selective Call Forwarding Service
/telephony/config/people/:personId/selectiveForward/criteria/:idGet the criteria details for the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to… - PUTModify a Criteria for the User’s Selective Call Forwarding Service
/telephony/config/people/:personId/selectiveForward/criteria/:idModify a criteria for the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward… - DELETEDelete a Criteria From the User’s Selective Call Forwarding Service
/telephony/config/people/:personId/selectiveForward/criteria/:idDelete a criteria from the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward… - GETSearch Shared-Line Appearance Members New
/telephony/config/people/:personId/applications/availableMembersGet members available for shared-line assignment to a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines… - GETGet Count of Shared-Line Appearance Members
/telephony/config/people/:personId/applications/availableMembers/countGet the count of members available for shared-line assignment to Webex Calling Apps. Shared-line appearance allows multiple devices or applications to share a… - GETGet Shared-Line Appearance Members New
/telephony/config/people/:personId/applications/membersGet primary and secondary members assigned to a shared line on a Webex Calling Apps. Like most hardware devices, applications support assigning additional… - PUTPut Shared-Line Appearance Members New
/telephony/config/people/:personId/applications/membersAdd or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps. Like most hardware devices, applications support assigning… - GETGet the user call captions settings
/telephony/config/people/:personId/callCaptionsRetrieve the user's call captions settings. NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations… - PUTUpdate the user call captions settings
/telephony/config/people/:personId/callCaptionsUpdate the user's call captions settings. NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in… - GETGet Person Executive Call Filtering Settings
/telephony/config/people/:personId/executive/callFilteringRetrieve the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to… - PUTModify Person Executive Call Filtering Settings
/telephony/config/people/:personId/executive/callFilteringUpdate the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to… - GETGet Person Executive Call Filtering Criteria Settings
/telephony/config/people/:personId/executive/callFiltering/criteria/:idRetrieve the executive call filtering criteria settings for the specified person. Executive Call Filtering Criteria in Webex allows you to retrieve the… - PUTModify Person Executive Call Filtering Criteria Settings
/telephony/config/people/:personId/executive/callFiltering/criteria/:idUpdate the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to… - DELETEDelete Person Executive Call Filtering Criteria
/telephony/config/people/:personId/executive/callFiltering/criteria/:idDelete a specific executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to manage… - POSTAdd Person Executive Call Filtering Criteria
/telephony/config/people/:personId/executive/callFiltering/criteriaCreate a new executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to define… - GETGet Person Executive Alert Settings
/telephony/config/people/:personId/executive/alertGet executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants,… - PUTModify Person Executive Alert Settings
/telephony/config/people/:personId/executive/alertUpdate executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants,… - GETGet Person Executive Assigned Assistants
/telephony/config/people/:personId/executive/assignedAssistantsGet list of assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you.… - PUTModify Person Executive Assigned Assistants
/telephony/config/people/:personId/executive/assignedAssistantsUpdate assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can… - GETGet Person Executive Available Assistants
/telephony/config/people/:personId/executive/availableAssistantsRetrieves a list of people available for assignment as executive assistants to the specified person. As an executive, you can add assistants to your executive… - GETGet Person Executive Assistant Settings
/telephony/config/people/:personId/executive/assistantGet executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer, intercept,… - PUTModify Person Executive Assistant Settings
/telephony/config/people/:personId/executive/assistantUpdate executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer,… - GETGet Person Executive Screening Settings
/telephony/config/people/:personId/executive/screeningGet executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based… - PUTModify Person Executive Screening Settings
/telephony/config/people/:personId/executive/screeningUpdate executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted… - GETGet Timezone and Announcement Language Settings of a Person
/telephony/config/people/:personIdRetrieve a person's timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing… - PUTUpdate Timezone and Announcement Language Settings of a Person
/telephony/config/people/:personIdModify a person's timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing… - GETGet Country Calling Configuration
/telephony/config/countries/:countryCodeRetrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones. This…
User Call Settings (3/3)
- GETGet Anonymous Call Rejection Settings for a Person
/telephony/config/people/:personId/anonymousCallRejectGet Anonymous Call Rejection Settings for a person. Anonymous Call Rejection allows people to automatically reject incoming calls from callers who have… - PUTUpdate Anonymous Call Rejection Settings for a Person
/telephony/config/people/:personId/anonymousCallRejectUpdate Anonymous Call Rejection Settings for a person. Configure whether to automatically reject incoming calls from anonymous callers. When Anonymous Call… - GETList Enabled Calling Services for a Person
/telephony/config/people/:personId/servicesRetrieves the list of enabled calling services for a person. Calling services are designed to improve call handling and ensure that people can manage their… - GETRetrieve Simultaneous Ring Settings for a Person
/telephony/config/people/:personId/simultaneousRingRetrieve simultaneous ring settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to… - PUTModify Simultaneous Ring Settings for a Person
/telephony/config/people/:personId/simultaneousRingModifies simultaneous ring settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to… - POSTCreate Simultaneous Ring Criteria for a Person
/telephony/config/people/:personId/simultaneousRing/criteriaCreate simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your… - GETRetrieve Simultaneous Ring Criteria for a Person
/telephony/config/people/:personId/simultaneousRing/criteria/:idRetrieve simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your… - PUTModify Simultaneous Ring Criteria for a Person
/telephony/config/people/:personId/simultaneousRing/criteria/:idModify simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your… - DELETEDelete Simultaneous Ring Criteria for a Person
/telephony/config/people/:personId/simultaneousRing/criteria/:idDelete simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your… - GETRetrieve a Person's Outbound Billing Plan
/telephony/config/people/:personId/outboundBillingPlan<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> Retrieve the Cisco Calling Plan outbound billing plan setting… - PUTModify a Person's Outbound Billing Plan
/telephony/config/people/:personId/outboundBillingPlan<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> Modify the Cisco Calling Plan outbound billing plan setting for… - GETList Voice Message Memberships
/telephony/voiceMessages/membershipsRetrieves the list of shared voicemail memberships for the authenticated user. Each membership represents a group calling feature (Call Queue, Hunt Group, or… - GETGet Answer Settings for a Person
/telephony/config/people/:personId/answerSettingsGet the answer settings for a specific person. Answer settings allow administrators to configure automatic call answering behavior for a person, including… - PUTUpdate Answer Settings for a Person
/telephony/config/people/:personId/answerSettingsModify the answer settings for a specific person. Answer settings allow administrators to configure automatic call answering behavior for a person, including… - GETGet Available Preferred Answer Endpoints for a Person
/telephony/config/people/:personId/availablePreferredAnswerEndpointsGet the list of available preferred answer endpoints for a specific person. This API returns all available endpoints in a single response. A Webex Calling… - GETGet Priority Alert Settings for a Person
/telephony/config/people/:personId/priorityAlertGet Priority Alert Settings for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This is helpful when a person… - PUTModify Priority Alert Settings for a Person
/telephony/config/people/:personId/priorityAlertUpdate Priority Alert Settings for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This is helpful when a… - POSTAdd a Priority Alert Criterion for a Person
/telephony/config/people/:personId/priorityAlert/criteriaCreate a Priority Alert criterion for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This is helpful when a… - GETGet Priority Alert Criterion Settings for a Person
/telephony/config/people/:personId/priorityAlert/criteria/:idGet Priority Alert criterion settings for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This is helpful when… - PUTModify Priority Alert Criterion for a Person
/telephony/config/people/:personId/priorityAlert/criteria/:idModify Priority Alert criterion settings for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This API allows… - DELETEDelete a Priority Alert Criterion for a Person
/telephony/config/people/:personId/priorityAlert/criteria/:idDelete a Priority Alert criterion for a person. Priority alert allows setting up a distinctive ringtone based on predefined criteria. This API removes a… - GETGet Sequential Ring Criteria for a Person
/telephony/config/people/:personId/sequentialRing/criteria/:idRetrieve a criterion from a person’s sequential ring settings. The Sequential Ring feature lets a person configure a list of up to five phone numbers that…
Virtual Line Call Settings
- GETRead the List of Virtual Lines
/telephony/config/virtualLinesList all Virtual Lines for the organization. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex… - POSTCreate a Virtual Line
/telephony/config/virtualLinesCreate new Virtual Line for the given location. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex… - GETRead Call Recording Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callRecordingRetrieve Virtual Line's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier… - PUTConfigure Call Recording Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callRecordingConfigure virtual line's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the… - GETGet Details for a Virtual Line
/telephony/config/virtualLines/:virtualLineIdRetrieve Virtual Line details. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.… - PUTUpdate a Virtual Line
/telephony/config/virtualLines/:virtualLineIdUpdate the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling… - DELETEDelete a Virtual Line
/telephony/config/virtualLines/:virtualLineIdDelete the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling… - GETGet Phone Number Assigned for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/numberGet details on the assigned phone number and extension for the virtual line. Virtual lines can be assigned phone numbers and extensions to enable calling… - PUTUpdate Directory Search for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/directorySearchUpdate the directory search for a designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple… - GETGet List of Devices Assigned for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/devicesRetrieve Device details assigned for a virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to… - GETGet List of DECT Networks Handsets for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/dectNetworks<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div> Retrieve DECT Network details assigned for a virtual line.… - GETRead Caller ID Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callerIdRetrieve a virtual line's Caller ID settings. Caller ID settings control how a virtual line's information is displayed when making outgoing calls. Retrieving… - PUTConfigure Caller ID Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callerIdConfigure a virtual line's Caller ID settings. Caller ID settings control how a virtual line's information is displayed when making outgoing calls. Updating… - GETRead Call Waiting Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callWaitingRetrieve a virtual line's Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled,… - PUTConfigure Call Waiting Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callWaitingConfigure a virtual line's Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When… - GETRead Call Forwarding Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callForwardingRetrieve a virtual line's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination… - PUTConfigure Call Forwarding Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callForwardingConfigure a virtual line's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination… - GETRead Incoming Permission Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/incomingPermissionRetrieve a virtual line's Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different… - PUTConfigure Incoming Permission Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/incomingPermissionConfigure a virtual line's Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different… - GETRetrieve a Virtual Line's Outgoing Calling Permissions Settings
/telephony/config/virtualLines/:virtualLineId/outgoingPermissionRetrieve a virtual line's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and… - PUTModify a Virtual Line's Outgoing Calling Permissions Settings
/telephony/config/virtualLines/:virtualLineId/outgoingPermissionModify a virtual line's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and… - GETRetrieve Access Codes for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodesRetrieve the virtual line's access codes. Access codes are used to bypass permissions. This API requires a full, user, or read-only administrator auth token… - PUTModify Access Codes for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodesModify a virtual line's access codes. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth token with… - POSTCreate Access Codes for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodesCreate a new access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth… - DELETEDelete Access Codes for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodesDeletes all access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth… - GETRetrieve Transfer Numbers for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/autoTransferNumbersRetrieve the virtual line's transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The… - PUTModify Transfer Numbers for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/autoTransferNumbersModify a virtual line's transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The… - GETRetrieve Digit Patterns for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatternsGet list of digit patterns for the virtual profile. Digit patterns are used to bypass permissions. Retrieving this list requires a full, user, or read-only… - PUTModify the Digit Pattern Category Control Settings for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatternsModifies whether this virtual profile uses the specified digit patterns when placing outbound calls or not. Digit patterns allow administrators to create… - POSTCreate Digit Pattern for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatternsCreate a new digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full, user, or location… - DELETEDelete All Digit Patterns for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatternsDelete all digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full, user, or location… - GETRetrieve Specified Digit Pattern Details for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternIdGet the specified digit pattern for the virtual profile. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full,… - PUTModify a Digit Pattern for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternIdModify a digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full, user, or location… - DELETEDelete a Digit Pattern for a Virtual Profile
/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternIdDelete a digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full, user, or location… - GETRead Call Intercept Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/interceptRetrieves Virtual Line's Call Intercept settings. The intercept feature gracefully takes a virtual line's phone out of service, while providing callers with… - PUTConfigure Call Intercept Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/interceptConfigures a virtual line's Call Intercept settings. The intercept feature gracefully takes a virtual line's phone out of service, while providing callers… - POSTConfigure Call Intercept Greeting for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/intercept/actions/announcementUpload/invokeConfigure a virtual line's Call Intercept Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a… - GETRetrieve Agent's List of Available Caller IDs
/telephony/config/virtualLines/:virtualLineId/agent/availableCallerIdsGet the list of call queues and hunt groups available for caller ID use by this virtual line as an agent. When a virtual line is configured as an agent in… - GETRetrieve Agent's Caller ID Information
/telephony/config/virtualLines/:virtualLineId/agent/callerIdRetrieve the Agent's Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller… - PUTModify Agent's Caller ID Information
/telephony/config/virtualLines/:virtualLineId/agent/callerIdModify Agent's Caller ID Information. Each Agent is able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or the Hunt Group's… - GETRead Voicemail Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/voicemailRetrieve a virtual line's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice… - PUTConfigure Voicemail Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/voicemailConfigure a virtual line's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice… - POSTConfigure Busy Voicemail Greeting for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/voicemail/actions/uploadBusyGreeting/invokeConfigure a virtual line's Busy Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a… - POSTConfigure No Answer Voicemail Greeting for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/voicemail/actions/uploadNoAnswerGreeting/invokeConfigure a virtual line's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a… - POSTReset Voicemail PIN for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/voicemail/actions/resetPin/invokeReset a voicemail PIN for a virtual line. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages… - PUTModify a Virtual Line's Voicemail Passcode
/telephony/config/virtualLines/:virtualLineId/voicemail/passcodeModify a virtual line's voicemail passcode. The voicemail passcode is used to secure access to the virtual line's voicemail messages. Administrators can… - GETRetrieve Music on Hold Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/musicOnHoldRetrieve the virtual line's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving the music on hold… - PUTConfigure Music on Hold Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/musicOnHoldConfigure a virtual line's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold… - GETRead Push-to-Talk Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/pushToTalkRetrieve a virtual line's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in… - PUTConfigure Push-to-Talk Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/pushToTalkConfigure a virtual line's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in… - GETRead Call Bridge Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callBridgeRetrieve a virtual line's call bridge settings. Call bridge settings allow administrators to configure warning tones that play when a call is bridged or… - PUTConfigure Call Bridge Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/callBridgeConfigure a virtual line's call bridge settings. Call bridge settings allow administrators to configure warning tones that play when a call is bridged or… - GETRead Barge in Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/bargeInRetrieve a virtual line's barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another… - PUTConfigure Barge in Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/bargeInConfigure a virtual line's barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to… - GETGet a Virtual Line's Privacy Settings
/telephony/config/virtualLines/:virtualLineId/privacyGet a virtual line's privacy settings for the specified virtual line ID. The privacy feature enables the virtual line's line to be monitored by others and… - PUTConfigure a Virtual Line's Privacy Settings
/telephony/config/virtualLines/:virtualLineId/privacyConfigure a virtual line's privacy settings for the specified virtual line ID. The privacy feature enables the virtual line's line to be monitored by others… - GETGet Virtual Line Fax Message Available Phone Numbers
/telephony/config/virtualLines/:virtualLineId/faxMessage/availableNumbersList standard numbers that are available to be assigned as a virtual line's FAX message number. These numbers are associated with the location of the virtual… - GETGet Virtual Line Call Forward Available Phone Numbers
/telephony/config/virtualLines/:virtualLineId/callForwarding/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a virtual line's call forward number. These numbers are associated with the… - GETGet Virtual Line Available Phone Numbers
/telephony/config/virtualLines/availableNumbersList standard numbers that are available to be assigned as a virtual line's phone number. By default, this API returns unassigned numbers from all locations.… - GETGet Virtual Line ECBN Available Phone Numbers
/telephony/config/virtualLines/:virtualLineId/emergencyCallbackNumber/availableNumbersList standard numbers that can be assigned as a virtual line's call forward number. These numbers are associated with the location of the virtual line… - GETGet Virtual Line Call Intercept Available Phone Numbers
/telephony/config/virtualLines/:virtualLineId/callIntercept/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a virtual line's call intercept number. These numbers are associated with the… - GETRetrieve DoNotDisturb Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/doNotDisturbRetrieve DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This… - PUTModify DoNotDisturb Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/doNotDisturbModify DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API… - GETRetrieve a Virtual Line's Outbound Billing Plan
/telephony/config/virtualLines/:virtualLineId/outboundBillingPlan<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> Retrieve the Cisco Calling Plan outbound billing plan setting… - PUTModify a Virtual Line's Outbound Billing Plan
/telephony/config/virtualLines/:virtualLineId/outboundBillingPlan<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> Modify the Cisco Calling Plan outbound billing plan setting for… - GETGet Answer Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/answerSettingsGet the answer settings for a specific virtual line. Answer settings allow administrators to configure automatic call answering behavior for a virtual line,… - PUTUpdate Answer Settings for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/answerSettingsModify the answer settings for a specific virtual line. Answer settings allow administrators to configure automatic call answering behavior for a virtual… - GETGet Available Preferred Answer Endpoints for a Virtual Line
/telephony/config/virtualLines/:virtualLineId/availablePreferredAnswerEndpointsGet the list of available preferred answer endpoints for a specific virtual line. This API returns all available endpoints in a single response. A virtual…
Webhook Interest Registrations
- GETGet Webhook Interest Registration
/telephony/webhookInterestRegistrationsReturns the webhook interest registration associated with the authenticated user and the client derived from the access token, including the list of interests… - POSTCreate a Webhook Interest Registration
/telephony/webhookInterestRegistrationsAdds or updates a webhook interest registration associated with the authenticated user and the client derived from the access token. At least one item in… - DELETEDelete Webhook Interest Registration
/telephony/webhookInterestRegistrationsDeletes the webhook interest registration associated with the authenticated user and the client derived from the access token. The client identifier is not…
Workspace Call Settings (2/2)
- GETRetrieve Music On Hold Settings for a Workspace
/telephony/config/workspaces/:workspaceId/musicOnHoldRetrieve Music On Hold Settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving a workspace's music… - PUTModify Music On Hold Settings for a Workspace
/telephony/config/workspaces/:workspaceId/musicOnHoldModify music on hold settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold setting… - DELETEDelete a Specific Access Code for a Workspace
/telephony/config/workspaces/:workspaceId/features/accessCodes/:accessCodeDeletes a specific access code for the given workspace. Access codes are used to bypass permissions. This API requires a full, device or location… - GETRetrieve all Digit Patterns for a Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatternsRetrieve all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location… - PUTModify the Digit Pattern Category Control Settings for the Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatternsModifies whether this workspace uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings… - POSTCreate Digit Pattern for a Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatternsCreate a new digit pattern for the given workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth… - DELETEDelete all Digit Patterns for a Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatternsDelete all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a… - GETRetrieve a Digit Pattern details for the Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternIdRetrieve the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location… - PUTModify a Digit Pattern for the Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternIdModify the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope… - DELETEDelete a Digit Pattern for the Workspace
/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternIdDelete a digit pattern for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a… - POSTUpload Call Intercept Announcement file for a Workspace
/telephony/config/workspaces/:workspaceId/features/intercept/actions/announcementUpload/invokeUpload call intercept announcement file for a workspace. The upload announcement feature for a call intercept is used to play custom announcements for a… - GETRetrieve Call Recording Settings for a Workspace
/telephony/config/workspaces/:workspaceId/features/callRecordingsRetrieve call recording settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the… - PUTModify Call Recording Settings for a Workspace
/telephony/config/workspaces/:workspaceId/features/callRecordingsModify call forwarding settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier… - GETGet Workspace Available Phone Numbers
/telephony/config/workspaces/availableNumbersList standard numbers that are available to be assigned as a workspace's phone number. By default, this API returns numbers from all locations that are… - GETGet Workspace ECBN Available Phone Numbers
/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber/availableNumbersList standard numbers that are available to be assigned as a workspace's emergency callback number. These numbers are associated with the location of the… - GETGet Workspace Call Forward Available Phone Numbers
/telephony/config/workspaces/:workspaceId/callForwarding/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a workspace's call forward number. These numbers are associated with the… - GETGet Workspace Call Intercept Available Phone Numbers
/telephony/config/workspaces/:workspaceId/callIntercept/availableNumbersList the service and standard PSTN numbers that are available to be assigned as a workspace's call intercept number. These numbers are associated with the… - GETRetrieve Anonymous Call Settings for a Workspace
/telephony/config/workspaces/:workspaceId/anonymousCallRejectRetrieve Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.… - PUTModify Anonymous Call Settings for a Workspace
/telephony/config/workspaces/:workspaceId/anonymousCallRejectModify Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.… - GETRetrieve Barge In Call Settings for a Workspace
/telephony/config/workspaces/:workspaceId/bargeInRetrieve Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone… - PUTModify Barge In Call Settings for a Workspace
/telephony/config/workspaces/:workspaceId/bargeInModify Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone… - GETRetrieve DoNotDisturb Settings for a Workspace
/telephony/config/workspaces/:workspaceId/doNotDisturbRetrieve DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API… - PUTModify DoNotDisturb Settings for a Workspace
/telephony/config/workspaces/:workspaceId/doNotDisturbModify DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API… - GETRetrieve Call Bridge Warning Tone Settings for a Workspace
/telephony/config/workspaces/:workspaceId/callBridgeRetrieve Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users… - PUTModify Call Bridge Warning Tone Settings for a Workspace
/telephony/config/workspaces/:workspaceId/callBridgeModify Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users… - GETRead Push-to-Talk Settings for a Workspace
/telephony/config/workspaces/:workspaceId/pushToTalkRetrieve Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects… - PUTConfigure Push-to-Talk Settings for a Workspace
/telephony/config/workspaces/:workspaceId/pushToTalkConfigure Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects… - GETRetrieve Privacy Settings for a Workspace
/telephony/config/workspaces/:workspaceId/privacyRetrieve Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by… - PUTModify Privacy Settings for a Workspace
/telephony/config/workspaces/:workspaceId/privacyModify Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by… - GETRead Voicemail Settings for a Workspace
/telephony/config/workspaces/:workspaceId/voicemailRetrieve a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via… - PUTConfigure Voicemail Settings for a Workspace
/telephony/config/workspaces/:workspaceId/voicemailConfigure a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages… - PUTModify Voicemail Passcode for a Workspace
/telephony/config/workspaces/:placeId/voicemail/passcodeModify voicemail passcode for a workspace. Modifying the voicemail passcode for a workspace requires a full administrator, device administrator or location… - GETRetrieve Sequential Ring Criteria for a Workspace
/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:idRetrieve sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace… - PUTModify Sequential Ring Criteria for a Workspace
/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:idModify sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace… - DELETEDelete Sequential Ring Criteria for a Workspace
/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:idDelete sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace… - GETRead Call Policy Settings for a Workspace
/telephony/config/workspaces/:workspaceId/callPoliciesRetrieve a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line… - PUTConfigure Call Policy Settings for a Workspace
/telephony/config/workspaces/:workspaceId/callPoliciesConfigure a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line… - POSTConfigure Busy Voicemail Greeting for a Place
/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadBusyGreeting/invokeConfigure a workspace's Busy Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a… - POSTConfigure No Answer Voicemail Greeting for a Place
/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadNoAnswerGreeting/invokeConfigure a workspace's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a… - POSTCreate Sequential Ring Criteria for a Workspace
/telephony/config/workspaces/:workspaceId/sequentialRing/criteriaCreate sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
A bearer token in the Authorization header - Operations
- 1242 operations on 817 pathsGET 570PUT 293POST 273DELETE 105PATCH 1
5 marked deprecated - Main resources
- User Call Settings (2/2) 94Workspace Call Settings (2/2) 80Call Controls 73Virtual Line Call Settings 68Call Settings For Me 65Features: Call Queue 58Call Routing 47Device Call Settings 47User Call Settings (1/2) 47Location Call Settings 38
- Response formats
application/jsonapplication/json;charset=utf-8application/octet-stream- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Webex's published OpenAPI description (webex/webex-openapi-specs) (CC-BY-4.0)
How to test the Webex Cloud Calling in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Cloud Calling collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List AI Receptionists” (GET /telephony/config/aiReceptionists), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Webex Cloud Calling?
The Webex Cloud Calling APIs enable comprehensive management of cloud-based calling services, including user provisioning, device assignment, call routing,… It is listed under Communication and has 1242 endpoints.
Who publishes the Webex Cloud Calling?
It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Webex Cloud Calling?
It accepts 3 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow); A bearer token in the Authorization header.
How many endpoints does the Webex Cloud Calling have?
1242 operations on 817 paths (570 GET, 293 PUT, 273 POST, 105 DELETE, 1 PATCH). The largest groups are User Call Settings (2/2), Workspace Call Settings (2/2), Call Controls, Virtual Line Call Settings. This listing's collection holds the first 400.
Is forking the Webex Cloud Calling free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.