Get Call Details

Get the details of the specified active call for the user.

GET/v1/telephony/calls/{callId}
URI Parameters
callId
stringrequired

The call identifier of the call.

Response Properties
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.

state
Call State Enum

The current state of the call.

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.

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

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.

redirectingParty
Party Information

The details of a party who redirected the incoming call.

recall
Recall Information

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

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.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
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.
  1. | 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. | | 404 | Not Found | The 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. | | 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. | | 409 | Conflict | The 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. | | 410 | Gone | The requested resource is no longer available. | | 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. | | 423 | Locked | The 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. | | 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded.
    | 429 | Too Many Requests | Too 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. | | 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. | | 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. | | 503 | Service Unavailable | Server is overloaded with requests. Try again later. | | 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/telephony/calls/
Log in to try the API.
Header
200 / OK
{
  "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"
}