Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Call Controls API

The Call Controls API from Webex — 29 operation(s) for call controls.

Webex Call Controls API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Call Controls. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 29 operations across 29 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

29 operations 29 paths 13 schemas 5 GET24 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Call Controls API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 29

Across 29 paths, the API surfaces 29 operations — 5 GET, 24 POST. Each is listed below with its method, path, parameters, and response codes.

Call Controls 29
POST
/telephony/calls/dial
Dial
dial body → 201400401403404405409410
POST
/telephony/calls/answer
Answer
answer body → 204400401403404405409410
POST
/telephony/calls/reject
Reject
reject body → 204400401403404405409410
POST
/telephony/calls/hangup
Hangup
hangup body → 204400401403404405409410
POST
/telephony/calls/hold
Hold
hold body → 204400401403404405409410
POST
/telephony/calls/resume
Resume
resume body → 204400401403404405409410
POST
/telephony/calls/mute
Mute
mute body → 204400401403404405409410
POST
/telephony/calls/unmute
Unmute
unmute body → 204400401403404405409410
POST
/telephony/calls/divert
Divert
divert body → 204400401403404405409410
POST
/telephony/calls/transfer
Transfer
transfer body → 201204400401403404405409
POST
/telephony/calls/park
Park
park body → 200400401403404405409410
POST
/telephony/calls/retrieve
Retrieve
retrieve body → 201400401403404405409410
POST
/telephony/calls/startRecording
Start Recording
startrecording body → 204400401403404405409410
POST
/telephony/calls/stopRecording
Stop Recording
stoprecording body → 204400401403404405409410
POST
/telephony/calls/pauseRecording
Pause Recording
pauserecording body → 204400401403404405409410
POST
/telephony/calls/resumeRecording
Resume Recording
resumerecording body → 204400401403404405409410
POST
/telephony/calls/transmitDtmf
Transmit DTMF
transmitdtmf body → 204400401403404405409410
POST
/telephony/calls/push
Push
push body → 204400401403404405409410
POST
/telephony/calls/pickup
Pickup
pickup body → 201400401403404405409410
POST
/telephony/calls/bargeIn
Barge In
bargein body → 201400401403404405409410
GET
/telephony/calls
List Calls
listcalls 1 param → 200400401403404405409410
GET
/telephony/calls/{callId}
Get Call Details
getcalldetails 2 params → 200400401403404405409410
GET
/telephony/calls/history
List Call History
listcallhistory 1 param → 200400401403404405409410
POST
/telephony/calls/pull
Pull
pull body → 201400401403404405409410
POST
/telephony/calls/members/{memberId}/dial
Dial by Member ID
dialByMemberId 2 params body → 201400401403404405409410
POST
/telephony/calls/members/{memberId}/answer
Answer by Member ID
answerByMemberId 2 params body → 204400401403404405409410
POST
/telephony/calls/members/{memberId}/hangup
Hangup by Member ID
hangupByMemberId 2 params body → 204400401403404405409410
GET
/telephony/calls/members/{memberId}/calls
List Calls by Member ID
listCallsByMemberId 2 params → 200400401403404405409410
GET
/telephony/calls/members/{memberId}/calls/{callId}
Get Call Details by Member ID
getCallDetailsByMemberId 3 params → 200400401403404405409410

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Call (13 properties), PartyInformation (6 properties), CallHistoryRecord (5 properties), RedirectionInformation (2 properties). Each schema is shown below with its type and property counts.

RedirectionReasonEnum
string
busy - The call was redirected on a busy condition. For example, the call was forwarded by Call Forwarding Busy. noAnswer - The call was redirected on a no ans…
RecallTypeEnum
string
park - The user is being recalled for a call park they initiated.
PartyInformation
object
6 properties 2 required
CallTypeEnum
string
location - The party is within the same location. organization - The party is within the same organization but not within the same location. external - The par…
RedirectionInformation
object
2 properties 2 required
Call
object
13 properties 8 required
CallStateEnum
string
connecting - The remote party is being alerted. alerting - The user's devices are alerting for the incoming or Click to Dial call. connected - The call is conn…
RecallInformation
object
2 properties 1 required
RejectActionEnum
string
busy - Send the call to busy. temporarilyUnavailable - Send the call to temporarily unavailable. ignore - Ignore the call by continuing ringback to the caller…
CallPersonalityEnum
string
originator - An outgoing call originated by the user. terminator - An incoming call received by the user. clickToDial - A call that is alerting the user's devi…
CallHistoryRecordTypeEnum
string
placed - A call history record for an outgoing call placed by the user. missed - A call history record for an incoming call to the user that was not answered.…
RecordingStateEnum
string
pending - Recording has been requested for the call but has not yet started. started - Recording is active for the call. paused - Recording has been paused for…
CallHistoryRecord
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-call-controls-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API