Documentation
Log in
Log in
Build
Platform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick Start
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService Apps G2GWidgetsLogin with WebexDeveloper SandboxBeta ProgramSupport PolicyFAQs
APIs
API Behavior ChangesXML API DeprecationAccess the APIREST API BasicsComplianceWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksBYODSService Apps G2GReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call Controls
POSTDial
POSTAnswer
POSTReject
POSTHangup
POSTHold
POSTResume
POSTMute
POSTUnmute
POSTDivert
POSTTransfer
POSTPark
POSTRetrieve
POSTStart Recording
POSTStop Recording
POSTPause Recording
POSTResume Recording
POSTTransmit DTMF
POSTPush
POSTPickup
POSTBarge In
GETList Calls
GETGet Call Details
GETList Call History
Call RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks Subscribers
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Contact Center
Overview
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Identity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksBYODSService Apps G2GWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksBYODSService Apps G2GButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks SubscribersCall Controls
POSTDial
POSTAnswer
POSTReject
POSTHangup
POSTHold
POSTResume
POSTMute
POSTUnmute
POSTDivert
POSTTransfer
POSTPark
POSTRetrieve
POSTStart Recording
POSTStop Recording
POSTPause Recording
POSTResume Recording
POSTTransmit DTMF
POSTPush
POSTPickup
POSTBarge In
GETList Calls
GETGet Call Details
GETList Call History
Call RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDevice Call SettingsDevice ConfigurationsDevicesEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsHybrid ClustersHybrid ConnectorsIdentity OrganizationLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganizationsPSTNPeopleRecording ReportRecordingsReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowser
Developer CommunityCertifications

Call Controls

Call Control APIs in support of Webex Calling. All GET commands require the spark:calls_read scope while all other commands require the spark:calls_write scope.

Notes:

  • These APIs support 3rd Party Call Control only.

  • The Call Control APIs are only for use by Webex Calling Multi Tenant users and not applicable for users hosted on UCM, including Dedicated Instance users.

Method
Description
POSThttps://api-usgov.webex.com/v1/telephony/calls/dial
Dial
https://api-usgov.webex.com/v1/telephony/calls/dial
POSTDial
POSThttps://api-usgov.webex.com/v1/telephony/calls/answer
Answer
https://api-usgov.webex.com/v1/telephony/calls/answer
POSTAnswer
POSThttps://api-usgov.webex.com/v1/telephony/calls/reject
Reject
https://api-usgov.webex.com/v1/telephony/calls/reject
POSTReject
POSThttps://api-usgov.webex.com/v1/telephony/calls/hangup
Hangup
https://api-usgov.webex.com/v1/telephony/calls/hangup
POSTHangup
POSThttps://api-usgov.webex.com/v1/telephony/calls/hold
Hold
https://api-usgov.webex.com/v1/telephony/calls/hold
POSTHold
POSThttps://api-usgov.webex.com/v1/telephony/calls/resume
Resume
https://api-usgov.webex.com/v1/telephony/calls/resume
POSTResume
POSThttps://api-usgov.webex.com/v1/telephony/calls/mute
Mute
https://api-usgov.webex.com/v1/telephony/calls/mute
POSTMute
POSThttps://api-usgov.webex.com/v1/telephony/calls/unmute
Unmute
https://api-usgov.webex.com/v1/telephony/calls/unmute
POSTUnmute
POSThttps://api-usgov.webex.com/v1/telephony/calls/divert
Divert
https://api-usgov.webex.com/v1/telephony/calls/divert
POSTDivert
POSThttps://api-usgov.webex.com/v1/telephony/calls/transfer
Transfer
https://api-usgov.webex.com/v1/telephony/calls/transfer
POSTTransfer
POSThttps://api-usgov.webex.com/v1/telephony/calls/park
Park
https://api-usgov.webex.com/v1/telephony/calls/park
POSTPark
POSThttps://api-usgov.webex.com/v1/telephony/calls/retrieve
Retrieve
https://api-usgov.webex.com/v1/telephony/calls/retrieve
POSTRetrieve
POSThttps://api-usgov.webex.com/v1/telephony/calls/startRecording
Start Recording
https://api-usgov.webex.com/v1/telephony/calls/startRecording
POSTStart Recording
POSThttps://api-usgov.webex.com/v1/telephony/calls/stopRecording
Stop Recording
https://api-usgov.webex.com/v1/telephony/calls/stopRecording
POSTStop Recording
POSThttps://api-usgov.webex.com/v1/telephony/calls/pauseRecording
Pause Recording
https://api-usgov.webex.com/v1/telephony/calls/pauseRecording
POSTPause Recording
POSThttps://api-usgov.webex.com/v1/telephony/calls/resumeRecording
Resume Recording
https://api-usgov.webex.com/v1/telephony/calls/resumeRecording
POSTResume Recording
POSThttps://api-usgov.webex.com/v1/telephony/calls/transmitDtmf
Transmit DTMF
https://api-usgov.webex.com/v1/telephony/calls/transmitDtmf
POSTTransmit DTMF
POSThttps://api-usgov.webex.com/v1/telephony/calls/push
Push
https://api-usgov.webex.com/v1/telephony/calls/push
POSTPush
POSThttps://api-usgov.webex.com/v1/telephony/calls/pickup
Pickup
https://api-usgov.webex.com/v1/telephony/calls/pickup
POSTPickup
POSThttps://api-usgov.webex.com/v1/telephony/calls/bargeIn
Barge In
https://api-usgov.webex.com/v1/telephony/calls/bargeIn
POSTBarge In
GEThttps://api-usgov.webex.com/v1/telephony/calls
List Calls
https://api-usgov.webex.com/v1/telephony/calls
GETList Calls
GEThttps://api-usgov.webex.com/v1/telephony/calls/{callId}
Get Call Details
https://api-usgov.webex.com/v1/telephony/calls/{callId}
GETGet Call Details
GEThttps://api-usgov.webex.com/v1/telephony/calls/history
List Call History
https://api-usgov.webex.com/v1/telephony/calls/history
GETList Call History

Connect

Contact Sales

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2024 Cisco and/or its affiliates. All rights reserved.