Call Controls - Get Call Details | Webex for Developers

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

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

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

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

muteCapable

boolean

Indicates whether the call is capable of using the mute and unmute APIs.

muted

boolean

Indicates whether the call is currently muted.

Response Codes

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

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
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/

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Response

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",
  "muteCapable": false,
  "muted": false
}