Get Detailed Call History
Provides Webex Calling Detailed Call History data for your organization.
Results can be filtered with the startTime, endTime and locations request parameters. The startTime and endTime parameters specify the start and end of the time period for the Detailed Call History reports you wish to collect. The API will return all reports that were created between startTime and endTime.
Response entries may be added as more information is made available for the reports.
Values in response items may be extended as more capabilities are added to Webex Calling.
Query Parameters
Time of the first report you wish to collect. (Report time is the time the call finished). Note: The specified time must be between 5 minutes ago and 48 hours ago, and be formatted as YYYY-MM-DDTHH:MM:SS.mmmZ.
Time of the last report you wish to collect. (Report time is the time the call finished). Note: The specified time should be later than startTime but no later than 48 hours, and be formatted as YYYY-MM-DDTHH:MM:SS.mmmZ.
Name of the location (as shown in Control Hub). Up to 10 comma-separated locations can be provided. Allows you to query reports by location.
Limit the maximum number of reports in the response. Range is 1 to 500. When the API has more reports to return than the max value, the API response will be paginated.
Response Properties
The time the call was answered. Time is in UTC.
Whether the call leg was answered. For example, in a hunt group case, some legs will be unanswered, and one will be answered.
The authorization code admin created for a location or site for users to use. Collected by the Account/Authorization Codes or Enhanced Outgoing Calling Plan services.
SIP Call ID used to identify the call. You can share the Call ID with Cisco TAC to help them pinpoint a call if necessary.
Type of call. For example:
SIP_MEETING
SIP_INTERNATIONAL
SIP_SHORTCODE
SIP_INBOUND
UNKNOWN
SIP_EMERGENCY
SIP_PREMIUM
SIP_ENTERPRISE
SIP_TOLLFREE
SIP_NATIONAL
SIP_MOBILE
For incoming calls, the calling line ID of the user. For outgoing calls, it's the calling line ID of the called party.
For incoming calls, the telephone number of the user. For outgoing calls, it's the telephone number of the called party.
For incoming calls, the calling line ID of the calling party. For outgoing calls, it's the calling line ID of the user.
For incoming calls, the telephone number of the calling party. For outgoing calls, it's the telephone number of the user.
The type of client that the user (creating this record) is using to make or receive the call. For example:
SIP
WXC_CLIENT
WXC_THIRD_PARTY
TEAMS_WXC_CLIENT
WXC_DEVICE
WXC_SIP_GW
The version of the client that the user (creating this record) is using to make or receive the call.
Correlation ID to tie together multiple call legs of the same call session.
A unique identifier for the user's department name.
The MAC address of the device, if known.
The keypad digits as dialed by the user, before pre-translations. This field reports multiple call dial possibilities:
Feature access codes (FAC) used for invoking features such as Last Number Redial or a Call Return.
An extension that got dialed and a mis-dialed keypad digit from a device/app.
When a user must dial an outside access code (for example, 9+) before dialing a number, this access code is also reported, as well as the digits dialed thereafter. Note that when pre-translations have no effect, the dialed digits field contains the same data as the called number field. This field is only used for originating (outgoing) Calls and is not available for terminating (incoming) Calls.
Whether the call was inbound or outbound. The possible values are:
ORIGINATING
TERMINATING
The length of the call in seconds.
Inbound trunk may be presented in Originating and Terminating records.
The country code of the dialed number. This is only populated for international calls.
The Session ID comprises a Universally Unique Identifier (UUID) for each user-agent participating in a call. It can be used for end-to-end tracking of a SIP session in IP-based multimedia communication. Each call consists of two UUIDs known as Local Session ID and Remote Session ID.
- The Local SessionID is generated from the Originating user agent.
Location of the report.
The device model type the user is using to make or receive the call.
A unique identifier for the organization that made the call. This is a unique identifier across Cisco.
Call redirection reason for the original called number. For example:
Unconditional: Call Forward Always (CFA) service, Group night forwarding.
NoAnswer: The party was not available to take the call. CF/busy or Voicemail/busy.
Deflection: Indicates that a call was redirected. Possible causes could be auto attendant transfer, transfer out of a call-center, user’s app/device redirection, direct VM transfer etc..
TimeOfDay: Call scheduled period of automated redirection. CF/selective, group night forwarding.
UserBusy: DND enabled or the user willingly declined the call. CF/busy or voicemail/busy.
FollowMe: Automated redirection to a personal redirecting service.
CallQueue: A call center call to an agent or a user (a member of the call queue).
HuntGroup: A hunt-group-based call to an agent or a user (denotes a member of the hunt group).
Unavailable: To voicemail, when the user has no app or device.
Unrecognized: Unable to determine the reason.
Unknown: Call forward by phone with no reason.
The operating system that the app was running on, if available.
Outbound trunk may be presented in Originating and Terminating records.
Call Redirection Reason for the redirecting number. For example:
Unconditional: Call Forward Always (CFA) service.
NoAnswer: The party was not available to take the call. CF/busy or Voicemail/busy.
Deflection: Indicates that a call was redirected. Possible causes could be auto attendant transfer, transfer out of a call-center, user’s app/device redirection, direct VM transfer etc..
TimeOfDay: Call scheduled period of automated redirection. CF/Selective.
UserBusy: DND enabled or user willingly declined the call. CF/busy or Voicemail/busy.
FollowMe: Automated redirection to a personal redirecting service.
CallQueue: A call center call to an agent or a user (denotes a member of the call queue).
HuntGroup: A hunt-group-based call to an agent or a user (denotes a member of the hunt group).
Unavailable: To voicemail, when the user has no app or device.
Unrecognized: Unable to determine the reason.
Unknown: Call forward by phone with no reason.
When the call has been redirected one or more times, this field reports the last redirecting number. Identifies who last redirected the call. Only applies to call scenarios such as transfer, call forwarded calls, simultaneous rings, etc.
Indicates a trigger that led to a change in the call presence. The trigger could be for this particular call or redirected via a different call. For example:
ConsultativeTransfer: While on a call, the call was transferred to another user by announcing it first. meaning the person was given a heads up or asked if they're interested in taking the call and then transferred.
CallForwardSelective: Call Forward as per the defined schedule. Might be based on factors like a specific time, specific callers or to a VM. It always takes precedence over Call Forwarding.
CallForwardAlways: Calls are unconditionally forwarded to a defined phone number or to VM.
CallForwardNoAnswer: The party was not available to take the call.
CallQueue: A call center call to an agent or a user (denotes a member of the call queue).
HuntGroup: A hunt group based call to an agent or a user (denotes a member of the hunt group).
CallPickup: The user part of a pickup group or pickup attempted by this user against a ringing call for a different user or extension.
CalllPark: An ongoing call was parked, assigned with a parked number (not the user’s phone number).
CallParkRetrieve: Call park retrieval attempt by the user, either for a different extension or against the user’s own extension.
Deflection: Indicates that a call was redirected. Possible causes include an auto attendant transfer, transfer out of a call-center, user’s app/device redirection etc..
FaxDeposit: Indicates a FAX was transmitted to the FAX service.
PushNotificationRetrieval: Push notification feature usage indication. Means that a push notification was sent to wake up the client and get ready to receive a call.
BargeIn: Indicates the user barged-in to someone else’s call.
VoiceXMLScriptTermination: Route Point feature usage indication.
AnywhereLocation: Indicates call origination towards the single number reach location.
AnywherePortal: Indicates call origination towards the “user” identified by the single number reach portal.
Unrecognized: Unable to determine the reason.
Indicates which party released the call first. The possible values are:
Local: Used when the local user has released the call first.
Remote: Used when the far-end party releases the call first.
Unknown: Used when the call has partial information or is unable to gather enough information about the party who released the call. It could be because of situations like force lock or because of a session audit failure.
The Session ID comprises a Universally Unique Identifier (UUID) for each user-agent participating in a call. It can be used for end-to-end tracking of a SIP session in IP-based multimedia communication. Each call consists of two UUIDs known as Local Session ID and Remote Session ID.
- The Remote SessionID is generated from the Terminating user agent.
A unique ID for this particular record. This can be used when processing records to aid in deduplication.
The time this report was created. Time is in UTC.
If present, this field's only reported in Originating records. Route group identifies the route group used for outbound calls routed via a route group to Premises-based PSTN or an on-prem deployment integrated with Webex Calling (dial plan or unknown extension).
The main number for the user's site where the call was made or received.
Site timezone is the offset in minutes from UTC time of the user's timezone.
A unique identifier for the site associated with the call. Unique across Cisco products.
This is the start time of the call, the answer time may be slightly after this. Time is in UTC.
If the call is TO or FROM a mobile phone using Webex Go, the Client type will show SIP, and Sub client type will show MOBILE_NETWORK.
Transfer related call ID is used as a call identifier of the other call involved in the transfer. You can share this ID with Cisco TAC to help them pinpoint parties who are involved during a call transfer.
The user who made or received the call.
The type of user (user or workspace) that made or received the call. For example:
AutomatedAttendantVideo
Anchor
BroadworksAnywhere
VoiceMailRetrieval
LocalGateway
HuntGroup
GroupPaging
User
VoiceMailGroup
CallCenterStandard
VoiceXML
RoutePoint
A unique identifier for the user associated with the call. This is a unique identifier across Cisco products.
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. |
Header
Query Parameters
- Time of the first report you wish to collect. (Report time is the time the call finished). **Note:** The specified time must be between 5 minutes ago and 48 hours ago, and be formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`.
- Time of the last report you wish to collect. (Report time is the time the call finished). **Note:** The specified time should be later than `startTime` but no later than 48 hours, and be formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`.
- Name of the location (as shown in Control Hub). Up to 10 comma-separated locations can be provided. Allows you to query reports by location.
- Limit the maximum number of reports in the response. Range is 1 to 500. When the API has more reports to return than the max value, the API response will be paginated.
{
"items": [
{
"Answer time": "2020-05-14T11:01:17.551Z",
"Answered": "true",
"Authorization code": "107",
"Call ID": "SSE1101163211405201218829100@10.177.4.29",
"Call type": "SIP_ENTERPRISE",
"Called line ID": "CALLEDCLIDGOESHERE",
"Called number": "2002",
"Calling line ID": "YOURCLIDGOESHERE",
"Calling number": "2001",
"Client type": "SIP_TOLLFREE",
"Client version": "1.0.2.3",
"Correlation ID": "8e8e1dc7-4f25-4595-b9c7-26237f824535",
"Department ID": "4370c763-81ec-403b-aba3-626a7b1cf264",
"Device MAC": "6C710D8ABC10",
"Dialed digits": "1246",
"Direction": "ORIGINATING",
"Duration": 36,
"Inbound trunk": "InTrunk",
"International country": "US",
"Local SessionID": "82bb753300105000a0000242be131609",
"Location": "Richardson",
"Model": "8851-3PCC",
"Org UUID": "408806bc-a013-4a4b-9a24-85e374912102",
"Original reason": "UserBusy",
"OS type": "na",
"Outbound trunk": "OutTrunk",
"Redirect reason": "Unavailable",
"Redirecting number": "+13343822691",
"Related reason": "CallQueue",
"Releasing party": "Remote",
"Remote SessionID": "6bf2f47800105000a0000242be13160a",
"Report ID": "0a0c2eb7-f1f6-3326-86f9-565d2e11553d",
"Report time": "2020-05-14T11:01:52.723Z",
"Route group": "RouteGrpAA",
"Site main number": "+14692281000",
"Site timezone": "-300",
"Site UUID": "474d4f70-4ef5-4d52-9e1d-b207086629e0",
"Start time": "2020-05-14T11:01:16.545Z",
"Sub client type": "MOBILE_NETWORK",
"Transfer related call ID": "2340586843:0A",
"User": "John Andersen",
"User type": "User",
"User UUID": "47f0d0c2-f05a-44cc-870d-7a3daf859c6c"
}
]
}