openapi: 3.0.0 info: title: 'Webex Admin Address Book Reports: Detailed Call History API' version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: 'Reports: Detailed Call History' paths: /cdr_feed: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/CDRResponse' example: items: - Answer indicator: 'Yes' Answer time: '2020-05-14T11:01:17.551Z' Answered: 'true' Authorization code: '107' Call ID: SSE1101163211405201218829100@10.177.4.29 Caller ID number: '2003' Call outcome: Success Call outcome reason: Normal Call Recording Platform Name: Webex Call Recording Result: successful Call Recording Trigger: always Call transfer Time: '2023-06-05T18:21:29.707Z' 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 Device owner UUID: 1e9e14c7-4f25-4595-b9c7-26237f824536 Dialed digits: '1246' Direction: ORIGINATING Duration: 36 External caller ID number: '2004' Final local SessionID: 82bb753300105000a0000242be131609 Final remote SessionID: cfe67b8a00105000a0000242be131609 Inbound trunk: InTrunk International country: US Local call ID: '113104021:0' Local SessionID: 82bb753300105000a0000242be131609 Location: Richardson Model: 8851-3PCC Network call ID: BW2356451711108231501755806@10.21.0.192 Org UUID: 408806bc-a013-4a4b-9a24-85e374912102 Original reason: UserBusy OS type: na Outbound trunk: OutTrunk Public Called IP Address: 0.0.0.0 Public Calling IP Address: 0.0.0.0 Release time: '2023-10-12 21:22:32.621' Ring duration: 23 Redirecting party UUID: afgh Redirect reason: Unavailable Redirecting number: '+13343822691' Related call ID: '760583469:0' Related reason: CallQueue Releasing party: Remote Remote call ID: '113103977:0' 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 number: '+81546668399' User type: User User UUID: 47f0d0c2-f05a-44cc-870d-7a3daf859c6c PSTN Vendor Name: Cisco Calling Plans PSTN Legal Entity: Broadsoft Adaption LLC PSTN Vendor Org ID: 0b43a1a8-2efd-4892-b301-e7a5a6d2c884 PSTN Provider ID: e8e730a0-ee04-4df4-90a6-b7072aec9062 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Detailed Call History operationId: getDetailedCallHistory description: '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.' tags: - 'Reports: Detailed Call History' parameters: - name: startTime in: query description: 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 formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`. required: true example: '2022-06-08T21:27:00.604Z' schema: type: string - name: endTime in: query description: 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 formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`. required: true example: '2022-06-09T23:27:18.604Z' schema: type: string - name: locations in: query description: 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. example: Erlanger Urgent / Primary Care Main schema: type: string - name: max in: query description: 'Limit the maximum number of reports per page of the response. The range is 500 to 5000. Values below 500 are automatically adjusted up to 500, and values above 5000 are automatically adjusted down to 5000. When the API has more reports to return than the max value, the API response will be paginated. Follow the next link contained in the “Link” header within a response to request the next page of results. If there is no next link, all reports for the selected time range have been collected. For instance, let''s say the initial API request is https://analytics-calling.webexapis.com/v1/cdr_feed?endTime=2025-08-15T10:00:00.000Z&startTime=2025-08-15T08:00:00.000Z&max=5000 The link header in the response would look something like <;rel="next">' example: 1000 schema: type: number default: 5000 /cdr_stream: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/CDRResponse' example: items: - Answer indicator: 'Yes' Answer time: '2020-05-14T11:01:17.551Z' Answered: 'true' Authorization code: '107' Call ID: SSE1101163211405201218829100@10.177.4.29 Caller ID number: '2003' Call outcome: Success Call outcome reason: Normal Call Recording Platform Name: Webex Call Recording Result: successful Call Recording Trigger: always Call transfer Time: '2023-06-05T18:21:29.707Z' 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 Device owner UUID: 1e9e14c7-4f25-4595-b9c7-26237f824536 Dialed digits: '1246' Direction: ORIGINATING Duration: 36 External caller ID number: '2004' Final local SessionID: 82bb753300105000a0000242be131609 Final remote SessionID: cfe67b8a00105000a0000242be131609 Inbound trunk: InTrunk International country: US Local call ID: '113104021:0' Local SessionID: 82bb753300105000a0000242be131609 Location: Richardson Model: 8851-3PCC Network call ID: BW2356451711108231501755806@10.21.0.192 Org UUID: 408806bc-a013-4a4b-9a24-85e374912102 Original reason: UserBusy OS type: na Outbound trunk: OutTrunk Public Called IP Address: 0.0.0.0 Public Calling IP Address: 0.0.0.0 Release time: '2023-10-12 21:22:32.621' Ring duration: 23 Redirecting party UUID: afgh Redirect reason: Unavailable Redirecting number: '+13343822691' Related call ID: '760583469:0' Related reason: CallQueue Releasing party: Remote Remote call ID: '113103977:0' 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 number: '+81546668399' User type: User User UUID: 47f0d0c2-f05a-44cc-870d-7a3daf859c6c PSTN Vendor Name: Cisco Calling Plans PSTN Legal Entity: Broadsoft Adaption LLC PSTN Vendor Org ID: 0b43a1a8-2efd-4892-b301-e7a5a6d2c884 PSTN Provider ID: e8e730a0-ee04-4df4-90a6-b7072aec9062 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Live Stream Detailed Call History operationId: getLiveStreamDetailedCallHistory description: '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 time window during which Detailed Call History data was inserted into the Webex Calling cloud. The API will return all reports whose insertion time into the Webex Calling cloud falls 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.' tags: - 'Reports: Detailed Call History' parameters: - name: startTime in: query description: The start date-time of the first record you wish to collect in UTC time. It would be the earliest time at which the data was inserted into the Webex Calling cloud for the records you wish to collect. Format must be as `YYYY-MM-DDTHH:MM:SS.mmmZ`. `startTime` can't be older than 12 hours from your current UTC time. The window period between `startTime` and `endTime` must not exceed 2 hours in a single API request. required: true example: '2022-06-08T21:27:00.604Z' schema: type: string - name: endTime in: query description: The end date-time of the last record you wish to collect in UTC time. It would be the latest time at which the data was inserted into the Webex Calling cloud for the records you wish to collect. Format must be as `YYYY-MM-DDTHH:MM:SS.mmmZ`. `endTime` must be 1 minute ago from your current UTC time and can’t be older than 12 hours. `endTime` must be greater than `startTime`. The window period between `startTime` and `endTime` must not exceed 2 hours in a single API request. required: true example: '2022-06-09T23:27:18.604Z' schema: type: string - name: locations in: query description: 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. example: Erlanger Urgent / Primary Care Main schema: type: string - name: max in: query description: 'Limit the maximum number of reports per page of the response. The range is 500 to 5000. Values below 500 are automatically adjusted up to 500, and values above 5000 are automatically adjusted down to 5000. When the API has more reports to return than the max value, the API response will be paginated. Follow the next link contained in the “Link” header within a response to request the next page of results. If there is no next link, all reports for the selected time range have been collected. For instance, let''s say the initial API request is https://analytics-calling.webexapis.com/v1/cdr_stream?endTime=2025-08-15T10:00:00.000Z&startTime=2025-08-15T08:00:00.000Z&max=5000 The link header in the response would look something like <;rel="next">' example: 1000 schema: type: number default: 5000 components: schemas: CDR: type: object properties: Answer indicator: type: string example: 'Yes' description: "Whether the call leg was answered after a redirection. Possible values: \n\n- Yes\n\n- No\n\n- Yes-PostRedirection" Answer time: type: string example: '2020-05-14T11:01:17.551Z' description: The time the call was answered. Time is in UTC. Answered: type: string example: 'true' description: Whether the call leg was answered. For example, in a hunt group case, some legs will be unanswered, and one will be answered. Authorization code: type: string example: '107' description: 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. Call ID: type: string example: SSE1101163211405201218829100@10.177.4.29 description: 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. Caller ID number: type: string example: '2003' description: 'Displays the calling party’s presentation number based on the caller ID setting from Control Hub. Can be a line/extension, location number, or a custom organization option. - The Caller ID number is not restricted to E.164 format and can vary based on system configuration. - For redirected calls, represents only the redirecting party''s caller ID number.' Call outcome: type: string example: Success description: 'Identifies whether the call was set up or disconnected normally. Possible values: - Success: Call is routed and disconnected successfully. Includes Normal, UserBusy, and NoAnswer scenarios. - Failure: Call failed with an internal or external error. - Refusal: Call is rejected because of call block or timeout. You can find more information in the Call outcome reason field.' Call outcome reason: type: string example: Normal description: "Additional information about the Call outcome returned. Possible reasons are:\n\n- Success\n - Normal: Call is completed successfully.\n - UserBusy: Call is a success, but the user is busy.\n - NoAnswer: Call is a success, but the user didn't answer.\n\n- Refusal\n - CallRejected: Call attempt rejected at the recipient's end.\n - UnassignedNumber: The dialed number isn't assigned to any user or service.\n - SIP408: Request timed out because couldn’t find the user in time.\n - InternalRequestTimeout: Request timed out as the service couldn’t fulfill the request due to an unexpected condition.\n - Q850102ServerTimeout: Recovery on timer expiry/server timed out\n - NoUserResponse: No response from any end-user device/client\n - NoAnswerFromUser: No answer from the user.\n - SIP480: Callee or called party is currently unavailable.\n - SIP487: Request is terminated by bye or cancel.\n - TemporarilyUnavailable: User is temporarily unavailable.\n - AdminCallBlock: Call attempt is rejected due to the organization's call block list.\n - UserCallBlock: The call to user is rejected because the number is on the user's block list.\n - Unreachable: Unable to route the call to the desired destination.\n - LocalGatewayLoop: Loop detected between the local gateway and Webex Calling.\n - UserAbsent: User is temporarily unreachable or unavailable.\n\n- Failure\n - DestinationOutOfOrder: Service request failed as the destination can’t be reached or the interface to the destination isn’t functioning correctly.\n - SIP501: Invalid method and can’t identify the request method.\n - SIP503: Service is temporarily unavailable so can’t process the request.\n - ProtocolError: Unknown or unimplemented release code.\n - SIP606: Some aspect of the session description wasn't acceptable.\n - NoRouteToDestination: No route available to the destination\n - Internal: Failed because of internal Webex Calling reasons.\n - MaxConcurrentTerminatingAlertingRequestsExceeded: The number of simultaneous unanswered calls to a local gateway, for the same calling and called number, exceeded the limit.\n - RouteListCalls: When off-net route list call is blocked due to exceeding the Route List Calls license overage limit for the organization." Call Recording Platform Name: type: string example: Webex description: '`Call recording Platform Name` and the recording platform can be "DubberRecorder", "Webex" or "Unknown" if the `Call Recording Platform Name` could not be fetched. Other supported vendors include "Eleveo", "ASCTech", "MiaRec", and "Imagicle".' Call Recording Result: type: string example: successful description: 'Status of the recorded media: "successful", "failed", or "successful but not kept." ' Call Recording Trigger: type: string example: always description: 'User''s recording mode for the call. The values for this field are "always", always-pause-resume", "on-demand", or "on-demand-user-start." ' Call transfer Time: type: string example: '2023-06-05T18:21:29.707Z' description: Indicates the time at which the call transfer service was invoked during the call. The invocation time is shown using the UTC/GMT time zone format. Call type: type: string example: SIP_ENTERPRISE description: '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' Called line ID: type: string example: CALLEDCLIDGOESHERE description: For incoming calls, the calling line ID of the user. For outgoing calls, it's the calling line ID of the called party. Called number: type: string example: '2002' description: For incoming calls, the telephone number of the user. For outgoing calls, it's the telephone number of the called party. Calling line ID: type: string example: YOURCLIDGOESHERE description: For incoming calls, the calling line ID of the calling party. For outgoing calls, it's the calling line ID of the user. Calling number: type: string example: '2001' description: For incoming calls, the telephone number of the calling party. For outgoing calls, it's the telephone number of the user. Client type: type: string example: SIP_TOLLFREE description: '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' Client version: type: string example: 1.0.2.3 description: The version of the client that the user (creating this record) is using to make or receive the call. Correlation ID: type: string example: 8e8e1dc7-4f25-4595-b9c7-26237f824535 description: Correlation ID to tie together multiple call legs of the same call session. Department ID: type: string example: 4370c763-81ec-403b-aba3-626a7b1cf264 description: A unique identifier for the user's department name. Device MAC: type: string example: 6C710D8ABC10 description: The MAC address of the device, if known. Device owner UUID: type: string example: 1e9e14c7-4f25-4595-b9c7-26237f824536 description: "When calls are made using multi-line or shared line options, this field represents the unique identifier of the device owner. It holds the UUID from the Cisco Common Identity associated with the user. For example, if Alice has a device assigned and makes or receives a call from Bob's line, the CDR will show Alice's UUID as the device owner. \n\n- Only set when the device owner is different than the owner of the device who made/received the call." Dialed digits: type: string example: '1246' description: "The keypad digits as dialed by the user, before pre-translations. \nThis field reports multiple call dial possibilities:\n\n- Feature access codes (FAC) used for invoking features such as Last Number Redial or a Call Return.\n\n- An extension that got dialed and a mis-dialed keypad digit from a device/app.\n\n- 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. \nNote that when pre-translations have no effect, the dialed digits field contains the same data as the called number field. \nThis field is only used for originating (outgoing) Calls and is not available for terminating (incoming) Calls." Direction: type: string example: ORIGINATING description: 'Whether the call was inbound or outbound. The possible values are: - ORIGINATING - TERMINATING' Duration: type: number example: 36 description: The length of the call in seconds. External caller ID number: type: string example: '2004' description: "Set only when the control hub External Caller ID phone number is a location number or another number from the organization. Not set when \"Direct line/Ext\" options are selected. \n\n- Only included in originating CDRs (not present in terminating CDRs).\n\n- Not set for calls that are redirected" Final local SessionID: type: string example: 82bb753300105000a0000242be131609 description: 'Each call consists of four UUIDs known as Local Session ID, Final Local Session ID, Remote Session ID and Final Remote Session ID. - 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 systems in compliance with RFC 7206 and draft-ietf-insipid-session-id-15. - The Local SessionID is generated from the Originating user agent. - The Remote SessionID is generated from the Terminating user agent. - The Final Local Session ID has the value of the Local Session ID at the end of the call. - The Final Remote Session ID has the value of the Remote Session ID at the end of the call.' Final remote SessionID: type: string example: cfe67b8a00105000a0000242be131609 description: 'Each call consists of four UUIDs known as Local Session ID, Final Local Session ID, Remote Session ID and Final Remote Session ID. - 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 systems in compliance with RFC 7206 and draft-ietf-insipid-session-id-15. - The Local SessionID is generated from the Originating user agent. - The Remote SessionID is generated from the Terminating user agent. - The Final Local Session ID has the value of the Local Session ID at the end of the call. - The Final Remote Session ID has the value of the Remote Session ID at the end of the call.' Inbound trunk: type: string example: InTrunk description: Inbound trunk may be presented in Originating and Terminating records. International country: type: string example: US description: The country code of the dialed number. This is only populated for international calls. Local call ID: type: string example: '113104021:0' description: 'A unique identifier that is used to correlate CDRs and call legs with each other. This ID is used in conjunction with: - Remote call ID: To identify the remote CDR of a call leg. - Transfer related call ID: To identify the call transferred leg.' Local SessionID: type: string example: 82bb753300105000a0000242be131609 description: 'Each call consists of four UUIDs known as Local Session ID, Final Local Session ID, Remote Session ID and Final Remote Session ID. - 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 systems in compliance with RFC 7206 and draft-ietf-insipid-session-id-15. - The Local SessionID is generated from the Originating user agent. - The Remote SessionID is generated from the Terminating user agent. - The Final Local Session ID has the value of the Local Session ID at the end of the call. - The Final Remote Session ID has the value of the Remote Session ID at the end of the call.' Location: type: string example: Richardson description: Location of the report. Model: type: string example: 8851-3PCC description: 'The device model type the user is using to make or receive the call. ' Network call ID: type: string example: BW2356451711108231501755806@10.21.0.192 description: A unique identifier that shows if other CDRs are in the same call leg. Two CDRs belong in the same call leg if they have the same Network call ID. Org UUID: type: string example: 408806bc-a013-4a4b-9a24-85e374912102 description: A unique identifier for the organization that made the call. This is a unique identifier across Cisco. Original reason: type: string example: UserBusy description: '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: Indication that a call was redirected. Possible causes could be Blind transfer, Auto attendant transfer, Transfer out of a Call center etc. - TimeOfDay: Automated redirection based on the time of the call. Call Forwarding Selective, Call Forwarding mode-based, or Group Night. - UserBusy: DND enabled or the user willingly declined the call. CF/busy or voicemail/busy. - FollowMe: Automated redirection to a personal redirecting service which could be Simultaneous Ringing, Sequential Ringing, Office Anywhere, or Remote Office. - 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. - ExplicitIdxxx: Enterprise voice portal redirection to the user’s home voice portal. The “xxx” portion is the digits collected from the caller, identifying the target mailbox (Extension or DN). - ImplicitId: Indicates an enterprise voice portal redirection to the user’s home voice portal.' OS type: type: string example: na description: The operating system that the app was running on, if available. Outbound trunk: type: string example: OutTrunk description: Outbound trunk may be presented in Originating and Terminating records. Public Called IP Address: type: string example: 0.0.0.0 description: Public IP address of the terminating device or application that is assigned with an Internet Telephony Number. Public Calling IP Address: type: string example: 0.0.0.0 description: Public IP address of the device or application making a call that is assigned with an Internet Telephony Number. Release time: type: string example: '2023-10-12 21:22:32.621' description: The time the call was finished, in UTC. Ring duration: type: number example: 23 description: The length of ringing before the call was answered or timed out, in seconds. Redirecting party UUID: type: string example: afgh description: 'When a call is redirected one or more times, indicates the unique identifier of the last redirecting party user or service accountable for the CDR. Holds the value of the UUID contained in the Cisco Common Identity associated with a user or service. ' Redirect reason: type: string example: Unavailable description: '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: Indication that a call was redirected. Possible causes could be Blind transfer, Auto attendant transfer, Transfer out of a Call center etc. - TimeOfDay: Automated redirection based on the time of the call. Call Forwarding Selective, Call Forwarding Mode-Based, or Group Night - UserBusy: DND enabled or user willingly declined the call. CF/busy or Voicemail/busy. - FollowMe: Automated redirection to a personal redirecting service which could be Simultaneous Ringing, Sequential Ringing, Office Anywhere, or Remote Office. - 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. - ExplicitIdxxx: Enterprise voice portal redirection to the user’s home voice portal. The “xxx” portion is the digits collected from the caller, identifying the target mailbox (Extension or DN). - ImplicitId: Indicates an enterprise voice portal redirection to the user’s home voice portal.' Redirecting number: type: string example: '+13343822691' description: 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. Related call ID: type: string example: '760583469:0' description: Call identifier of a different call that was created by this call because of a service activation. The value is the same as the Local call ID field of the related call. You can use this field to correlate multiple call legs connected through other services. Related reason: type: string example: CallQueue description: '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. - CallForwardModeBased: Calls are forwarded using the mode-based management feature option. - 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: Indication that a call was redirected. Possible causes could be Blind transfer, Auto-attendant transfer, Transfer out of a Call center, 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. - CallForwardBusy: The user willingly declined the call, or DND was enabled that then redirected the call to a defined phone number or voice mail. - CallForwardNotReachable: Hunt group redirection for an agent who is not reachable. - CallRetrieve: The user triggered the call retrieve option to pick up a call that was parked. - CallRecording: The user initiated the call recording service that triggered Start/Pause/Resume/Stop recording options. - DirectedCallPickup: Indicates this user belonged to a call pickup group who answered the call or answered when another member of the call pickup group in a location was busy. - Executive: The user has been configured using the Executive/Executive assistant service who is allowed to handle calls on someone else''s behalf. Also known as Boss-admin. - ExecutiveAssistantInitiateCall: The user has been configured as an Executive assistant who placed or initiated the call on someone else’s (Boss admin''s) behalf. - ExecutiveAssistantDivert: The user has been configured as an Executive assistant who had call forwarding enabled to a defined phone number. - ExecutiveForward: The Executive (Boss-admin) had a call forward setting enabled to a defined number. Generally triggered when an ExecutiveAssistant did not pick a call. - ExecutiveAssistantCallPush: The user has been configured as an Executive assistant who received a call and pushed that call out (using #63) to the Executive’s (Boss-admin''s) number. - Remote Office: Indicates the call was made to reach the remote location of the user. - RoutePoint: Indicates an incoming and queued call to an agent (for incoming calls to the route point). - SequentialRing: Indicates this user is in the list of phone numbers, which are alerted sequentially upon receiving an incoming call that matches a set of criteria. - SimultaneousRingPersonal: Indicates this user was in the list of multiple destinations that are to ring simultaneously when any calls are received on their phone number (the first destination answered is connected). - CCMonitoringBI: The indication that a Call Queue supervisor invoked silent monitoring.' Releasing party: type: string example: Remote description: '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.' Remote call ID: type: string example: '113103977:0' description: A unique identifier that is used to correlate CDRs and call legs with each other. This ID is used in conjunction with Local call ID to identity the local CDR of a call leg. Remote SessionID: type: string example: 6bf2f47800105000a0000242be13160a description: 'Each call consists of four UUIDs known as Local Session ID, Final Local Session ID, Remote Session ID and Final Remote Session ID. - 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 systems in compliance with RFC 7206 and draft-ietf-insipid-session-id-15. - The Local SessionID is generated from the Originating user agent. - The Remote SessionID is generated from the Terminating user agent. - The Final Local Session ID has the value of the Local Session ID at the end of the call. - The Final Remote Session ID has the value of the Remote Session ID at the end of the call.' Report ID: type: string example: 0a0c2eb7-f1f6-3326-86f9-565d2e11553d description: A unique ID for this particular record. This can be used when processing records to aid in deduplication. Report time: type: string example: '2020-05-14T11:01:52.723Z' description: The time this report was created. Time is in UTC. Route group: type: string example: RouteGrpAA description: 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). Route list calls overage: type: string example: '2' description: This field is reported whenever an off-net route list call is made or received that exceeds the Route List Calls license volume for the organization. The value indicates the number of bursting calls (calls over the licensed volume) at the time the call was made or received. Site main number: type: string example: '+14692281000' description: The main number for the user's site where the call was made or received. Site timezone: type: string example: '-300' description: Site timezone is the offset in minutes from UTC time of the user's timezone. Site UUID: type: string example: 474d4f70-4ef5-4d52-9e1d-b207086629e0 description: A unique identifier for the site associated with the call. Unique across Cisco products. Start time: type: string example: '2020-05-14T11:01:16.545Z' description: 'This is the start time of the call, the answer time may be slightly after this. Time is in UTC. ' Sub client type: type: string example: MOBILE_NETWORK description: 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: type: string example: 2340586843:0A description: Call identifier of a different call that was involved in the transfer. You can share this ID with Cisco TAC to help them pinpoint parties who were involved in the call transfer. User: type: string example: John Andersen description: 'Represents the display name for the user type involved in the call, such as User, Workspace, Virtual Line, Auto Attendant, or Call Queue. ' User number: type: string example: '+81546668399' description: Represents the E.164 number of the user generating a CDR. If the user has no number assigned to them, then their extension will be displayed instead. User type: type: string example: User description: 'The type of user (user or workspace) that made or received the call. For example: - AutomatedAttendantVideo: Automated Attendant Video IVR group service. - Anchor: A Webex Calling user number made or received that is integrated with Webex Contact Center. An "anchor" is created to facilitate the call routing flow between WxC and WxCC. - BroadworksAnywhere: Single number reach (Office anywhere) service. - VoiceMailRetrieval: Voice Mail group service. - LocalGateway: A local gateway-based user who made or received the call. - HuntGroup: A hunt group based service. - GroupPaging: One way call or group page made for target users. - User: The direct user who made or received the call. - VoiceMailGroup: Shared voicemail or inbound FAX destination for users. - CallCenterStandard: A call queue-based service. - VoiceXML: Call added back to the Route Point queue after script termination. - RoutePoint: Route Point call to an agent (for an incoming call to the routing point). - Place: A workspace-based user who made or received the call. - VirtuaLline: Call made or received by a virtual line user using the Multi-line option in Webex Calling.' User UUID: type: string example: 47f0d0c2-f05a-44cc-870d-7a3daf859c6c description: A unique identifier for the user associated with the call. This is a unique identifier across Cisco products. PSTN Vendor Name: type: string example: Cisco Calling Plans description: 'Displays the name of the vendor from which one has purchased PSTN service for a specific country. For example: - If purchased from Cisco PSTN, the field would display "Cisco Calling Plans" - If purchased from Cisco Cloud Connected PSTN Partners, the field would list names such as "Tata", "IntelePeer", "KDDI", etc.' PSTN Legal Entity: type: string example: Broadsoft Adaption LLC description: 'This field shows the regulated business entity registered to provide PSTN service in a particular country. It is exclusively used for Cisco Calling Plans. - Note: The name of the regulated entity may vary within a region and across different regions.' PSTN Vendor Org ID: type: string example: 0b43a1a8-2efd-4892-b301-e7a5a6d2c884 description: This field displays the organization's Universal Unique Identifier (UUID) for Cisco Calling Plans, which is unique across various regions. PSTN Provider ID: type: string example: e8e730a0-ee04-4df4-90a6-b7072aec9062 description: This field represents an immutable UUID, as defined by Cisco, for a PSTN provider partner. It uniquely identifies the entity that has provided PSTN service in that country. Original Called Party UUID: type: string example: e8e730a0-ee04-4df4-90a6-b7072aec9062 description: When the call is redirected one or more times, this field represents the unique identifier of the first redirecting party. This might be a user, service, workspace, or virtual line that’s accountable for the CDRs. The field holds the value of the UUID contained in the Cisco Common Identity associated with a user, service, workspace, or virtual line. Recall Type: type: string example: call park description: This field indicates that the call is a call park recall. A call park recall occurs when a parked call is not retrieved within the provisioned recall time. In such cases, the system attempts to return the parked call to the user who originally parked it or to an alternate recall destination, which can only be a hunt group. The recall attempt may either succeed or fail, and if it fails, the parked call remains unretrieved. Hold Duration: type: number example: 10 description: Indicates the total duration of call hold time in seconds. This is the floor value of the calculated hold duration Auto Attendant Key Pressed: type: string example: '5' description: Indicates the last key pressed value by the caller. Queue Type: type: string example: Customer Assist description: 'The field represents the type of call queue service. Example: Queue Type = Customer Assist, if it’s a customer assist based call queue Queue Type = Call Queue, if it’s a calling > feature based call queue' Answered Elsewhere: type: string example: 'Yes' description: 'This field is present in the terminating CDR when an incoming call is answered by a different user, workspace, virtual line, or service. Example: Set to Answered Elsewhere = Yes, for a Hunt Group agent''s call when simultaneous routing is in use and another agent answers the call.' Caller Reputation Score: type: string example: '2.5' description: This field contains the score received from the caller reputation provider. The score ranges from 0.0 to 5.0. If the provider doesn’t send a score, the system omits this field. Caller Reputation Service Result: type: string example: allowed description: 'This field records the outcome of the Caller Reputation Service and appears only in terminating CDRs. The field can contain the following values: allow — Set when the caller’s reputation score meets or exceeds the higher threshold, or if an error occurs while obtaining the reputation score from the provider. captcha-allow — Set when the caller’s reputation score falls between the lower and higher thresholds and the caller successfully completes the captcha challenge. captcha-block — Set when the caller’s reputation score falls between the lower and higher thresholds and the caller fails or abandons the captcha challenge. block — Set when the caller’s reputation score is below the lower threshold.' Caller Reputation Score Reason: type: string example: OK description: This field indicates the reason for the reputation score is assigned for a call. This field contains the reason value provided by the caller reputation provider in the call analysis request. If the score couldn’t be obtained from the provider due to error conditions, then the score reason specifies the particular error. Interaction ID: type: string example: a98c732b-36ac-4d20-87b2-fec4e0a69209 description: 'A unique identifier used to tie together multiple call patterns linked by a service interaction. Example for consult and transfer call flow— When a user places an active call on hold, initiates another call from the same app or device, and then transfers the original call, both calls share the same Interaction ID.' WxCC consult merge status: type: string example: 'Yes' description: 'This field specifies whether Webex Contact Center (WxCC) has performed a transfer or conference operation on a consultative call, indicating that the consulted party was connected to the customer call. If the value is set to "No", the call was initiated by WxCC as part of an agent''s consult action, but the consulted leg was not transferred or conferenced into the customer call leg. If the value is set to "Yes", the call was initiated by WxCC as part of an agent''s consult action, and the consulted leg was transferred or conferenced into the customer call leg. If the value is set to "NA", the call leg is not associated with an agent consultative call.' ELIN: type: string example: '+14085551234' description: When set, this is the Emergency Location Identification Number (ELIN) used for the emergency call or callback. The ELIN may be an ELIN from the location's pool (numbers the customer has configured as ELINs), or it may be the workspace's own number which was used as ECBN for the emergency call and treated as an ELIN. Emergency number source: type: string example: ELIN Pool description: 'Indicates the source of the number used for an emergency call or emergency callback. The field can contain the following values: ELIN Pool—ELIN obtained from the location''s pool. Workspace ELIN—Workspace''s number obtained through ECBN used as ELIN. Workspace ELIN Fallback—Workspace''s number obtained through ECBN used as ELIN due to ELIN fallback. This value is present only in originating CDRs. ELIN fallback occurs when ELIN use is allowed and the location has ELINs provisioned, but no ELIN is currently available in the location''s pool. ECBN Fallback—ECBN is used due to ELIN fallback. This value is present only in originating CDRs. ECBN—ECBN is used when the location has no ELINs provisioned, ELIN usage is not allowed for the call, or callback is not to an ELIN.' CDRResponse: type: object properties: items: type: array description: Array of detailed call history records items: $ref: '#/components/schemas/CDR' example: items: - Report ID: 0a0c2eb7-f1f6-3326-86f9-565d2e11553d Report time: '2020-05-14T11:01:52.723Z' Call ID: SSE1101163211405201218829100@10.177.4.29 User: John Andersen Duration: 36 securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps