DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall Controls
POSTDial
POSTAnswer
POSTReject
POSTHangup
POSTHold
POSTResume
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
LocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall Controls
POSTDial
POSTAnswer
POSTReject
POSTHangup
POSTHold
POSTResume
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
Device ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

List Calls

Get the list of details for all active calls associated with the user.

GET/v1/telephony/calls
Response Properties
items
array[Call]
id
string

The call identifier of the call.

callSessionId
string

The call session identifier of the call session the call belongs to. This can be used to correlate multiple calls that are part of the same call session.

personality
Call Personality Enum

The personality of the call.

originator
string
terminator
string
clickToDial
string
state
Call State Enum

The current state of the call.

connecting
string
alerting
string
connected
string
held
string
remoteHeld
string
disconnected
string
remoteParty
Party Information

The remote party's details. For example, if user A calls user B then B is the remote party in A's outgoing call details and A is the remote party in B's incoming call details.

name
string

The party's name. Only present when the name is available and privacy is not enabled.

number
string

The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, user@company.domain

personId
string

The party's person ID. Only present when the person ID is available and privacy is not enabled.

placeId
string

The party's place ID. Only present when the place ID is available and privacy is not enabled.

privacyEnabled
boolean

Indicates whether privacy is enabled for the name, number and personId/placeId.

callType
Call Type Enum

The call type for the party.

location
string
organization
string
external
string
emergency
string
repair
string
other
string
appearance
number

The appearance value for the call. The appearance value can be used to display the user's calls in an order consistent with the user's devices. Only present when the call has an appearance value assigned.

created
string

The date and time the call was created.

answered
string

The date and time the call was answered. Only present when the call has been answered.

redirections
array[Redirection Information]

The list of details for previous redirections of the incoming call ordered from most recent to least recent. For example, if user B forwards an incoming call to user C, then a redirection entry is present for B's forwarding in C's incoming call details. Only present when there were previous redirections and the incoming call's state is alerting.

reason
Redirection Reason Enum

The reason the incoming call was redirected.

busy
string
noAnswer
string
unavailable
string
unconditional
string
timeOfDay
string
divert
string
followMe
string
huntGroup
string
callQueue
string
unknown
string
redirectingParty
Party Information

The details of a party who redirected the incoming call.

name
string

The party's name. Only present when the name is available and privacy is not enabled.

number
string

The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, user@company.domain

personId
string

The party's person ID. Only present when the person ID is available and privacy is not enabled.

placeId
string

The party's place ID. Only present when the place ID is available and privacy is not enabled.

privacyEnabled
boolean

Indicates whether privacy is enabled for the name, number and personId/placeId.

callType
Call Type Enum

The call type for the party.

location
string
organization
string
external
string
emergency
string
repair
string
other
string
recall
Recall Information

The recall details for the incoming call. Only present when the incoming call is for a recall.

type
Recall Type Enum

The type of recall the incoming call is for. Park is the only type of recall currently supported but additional values may be added in the future.

park
string
party
Party Information

If the type is park, contains the details of where the call was parked. For example, if user A parks a call against user B and A is recalled for the park, then this field contains B's information in A's incoming call details. Only present when the type is park.

name
string

The party's name. Only present when the name is available and privacy is not enabled.

number
string

The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, user@company.domain

personId
string

The party's person ID. Only present when the person ID is available and privacy is not enabled.

placeId
string

The party's place ID. Only present when the place ID is available and privacy is not enabled.

privacyEnabled
boolean

Indicates whether privacy is enabled for the name, number and personId/placeId.

callType
Call Type Enum

The call type for the party.

location
string
organization
string
external
string
emergency
string
repair
string
other
string
recordingState
Recording State Enum

The call's current recording state. Only present when the user's call recording has been invoked during the life of the call.

pending
string
started
string
paused
string
stopped
string
failed
string
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
GET
/v1/telephony/calls
Log in to try the API.
Header
  • Response
200 / OK
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA",
      "callSessionId": "MmFmNThiZjktYWE3Ny00NWE5LThiMDEtYzI4NDMxZWYwNzRm",
      "personality": "originator",
      "state": "connecting",
      "remoteParty": {
        "name": "John Smith",
        "number": "+12223334444",
        "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
        "placeId": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ4MmEyLTRlNjktNTlhYS05ZjJmLWJjYTYzMTAxM2E2OA==",
        "privacyEnabled": false,
        "callType": "location"
      },
      "appearance": 1,
      "created": "2016-04-21T17:00:00.000Z",
      "answered": "2016-04-21T17:00:00.000Z",
      "redirections": [
        {
          "reason": "busy",
          "redirectingParty": {
            "name": "John Smith",
            "number": "+12223334444",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
            "placeId": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ4MmEyLTRlNjktNTlhYS05ZjJmLWJjYTYzMTAxM2E2OA==",
            "privacyEnabled": false,
            "callType": "location"
          }
        }
      ],
      "recall": {
        "type": "park",
        "party": {
          "name": "John Smith",
          "number": "+12223334444",
          "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
          "placeId": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ4MmEyLTRlNjktNTlhYS05ZjJmLWJjYTYzMTAxM2E2OA==",
          "privacyEnabled": false,
          "callType": "location"
        }
      },
      "recordingState": "pending"
    }
  ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

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