wxc_sdk.cdr package

CDR API

class wxc_sdk.cdr.CDRCallType(*values)

Bases: str, SafeEnum

An enumeration.

sip_meeting = 'SIP_MEETING'

sip_international = 'SIP_INTERNATIONAL'

sip_shortcode = 'SIP_SHORTCODE'

sip_inbound = 'SIP_INBOUND'

unknown = 'UNKNOWN'

sip_emergency = 'SIP_EMERGENCY'

sip_premium = 'SIP_PREMIUM'

sip_enterprise = 'SIP_ENTERPRISE'

sip_tollfree = 'SIP_TOLLFREE'

sip_national = 'SIP_NATIONAL'

sip_mobile = 'SIP_MOBILE'

class wxc_sdk.cdr.CDRClientType(*values)

Bases: str, SafeEnum

An enumeration.

sip = 'SIP'

wxc_client = 'WXC_CLIENT'

wxc_third_party = 'WXC_THIRD_PARTY'

teams_wxc_client = 'TEAMS_WXC_CLIENT'

wxc_device = 'WXC_DEVICE'

wxc_sip_gw = 'WXC_SIP_GW'

class wxc_sdk.cdr.CDRDirection(*values)

Bases: str, SafeEnum

An enumeration.

originating = 'ORIGINATING'

terminating = 'TERMINATING'

class wxc_sdk.cdr.CDROriginalReason(*values)

Bases: str, SafeEnum

An enumeration.

unconditional = 'Unconditional'

no_answer = 'NoAnswer'

call_queue = 'CallQueue'

hunt_group = 'HuntGroup'

time_of_day = 'TimeOfDay'

user_busy = 'UserBusy'

follow_me = 'FollowMe'

unrecognised = 'Unrecognised'

deflection = 'Deflection'

unavailable = 'Unavailable'

unknown = 'Unknown'

class wxc_sdk.cdr.CDRRedirectReason(*values)

Bases: str, SafeEnum

An enumeration.

unconditional = 'Unconditional'

no_answer = 'NoAnswer'

call_queue = 'CallQueue'

time_of_day = 'TimeOfDay'

user_busy = 'UserBusy'

follow_me = 'FollowMe'

hunt_group = 'HuntGroup'

deflection = 'Deflection'

unknown = 'Unknown'

unavailable = 'Unavailable'

class wxc_sdk.cdr.CDRRelatedReason(*values)

Bases: str, SafeEnum

An enumeration.

consultative_transfer = 'ConsultativeTransfer'

call_forward_selective = 'CallForwardSelective'

call_park = 'CallPark'

call_park_retrieve = 'CallParkRetrieve'

call_queue = 'CallQueue'

unrecognised = 'Unrecognised'

call_pickup = 'CallPickup'

call_forward_always = 'CallForwardAlways'

call_forward_busy = 'CallForwardBusy'

fax_deposit = 'FaxDeposit'

hunt_group = 'HuntGroup'

push_notification_retrieval = 'PushNotificationRetrieval'

voice_xml_script_termination = 'VoiceXMLScriptTermination'

call_forward_no_answer = 'CallForwardNoAnswer'

anywhere_location = 'AnywhereLocation'

call_retrieve = 'CallRetrieve'

deflection = 'Deflection'

directed_call_pickup = 'DirectedCallPickup'

call_forward_mode_based = 'CallForwardModeBased'

class wxc_sdk.cdr.CDRUserType(*values)

Bases: str, SafeEnum

An enumeration.

automated_attendant_video = 'AutomatedAttendantVideo'

anchor = 'Anchor'

broadworks_anywhere = 'BroadworksAnywhere'

voice_mail_retrieval = 'VoiceMailRetrieval'

local_gateway = 'LocalGateway'

hunt_group = 'HuntGroup'

group_paging = 'GroupPaging'

user = 'User'

voice_mail_group = 'VoiceMailGroup'

call_center_standard = 'CallCenterStandard'

call_center_premium = 'CallCenterPremium'

voice_xml = 'VoiceXML'

route_point = 'RoutePoint'

virtual_line = 'VirtualLine'

place = 'Place'

class wxc_sdk.cdr.CDR(*, startTime: datetime | None = None, answerTime: datetime | None = None, duration: int | None = None, answered: bool | None = None, direction: CDRDirection | str | None = None, calledLineId: str | None = None, callId: str | None = None, callingLineId: str | None = None, callType: CDRCallType | None = None, clientType: CDRClientType | None = None, clientVersion: str | None = None, correlationId: str | None = None, internationalCountry: str | None = None, local_sessionid: str | None = None, deviceMac: str | None = None, inboundTrunk: str | None = None, orgUuid: str | None = None, originalReason: CDROriginalReason | None = None, osType: str | None = None, outboundTrunk: str | None = None, redirectReason: CDRRedirectReason | None = None, relatedReason: CDRRelatedReason | None = None, reportId: str | None = None, reportTime: datetime | None = None, routeGroup: str | None = None, route_list_calls_overage: str | None = None, siteMainNumber: str | None = None, siteTimezone: str | None = None, subClientType: str | None = None, userUuid: str | None = None, user: str | None = None, userType: CDRUserType | None = None, calledNumber: str | None = None, callingNumber: str | None = None, location: str | None = None, dialedDigits: str | None = None, releasingParty: str | None = None, remote_sessionid: str | None = None, redirectingNumber: str | None = None, siteUuid: str | None = None, departmentId: str | None = None, transferRelatedCallId: str | None = None, authorizationCode: str | None = None, model: str | None = None, callTransferTime: datetime | None = None, localCallId: str | None = None, remoteCallId: str | None = None, networkCallId: str | None = None, relatedCallId: str | None = None, userNumber: str | None = None, callOutcome: str | None = None, callOutcomeReason: str | None = None, ringDuration: int | None = None, answerIndicator: str | None = None, releaseTime: datetime | None = None, final_local_sessionid: str | None = None, final_remote_sessionid: str | None = None, pstnVendorName: str | None = None, pstnLegalEntity: str | None = None, pstnVendorOrgId: str | None = None, pstnProviderId: str | None = None, externalCustomerId: str | None = None, redirectingPartyUuid: str | None = None, publicCallingIpAddress: str | None = None, publicCalledIpAddress: str | None = None, callerIdNumber: str | None = None, externalCallerIdNumber: str | None = None, deviceOwnerUuid: str | None = None, callRecordingPlatformName: str | None = None, callRecordingResult: str | None = None, callRecordingTrigger: str | None = None, original_called_party_uuid: str | None = None, recall_type: str | None = None, hold_duration: int | None = None, auto_attendant_key_pressed: str | None = None, queue_type: str | None = None, answered_elsewhere: str | None = None, caller_reputation_score: str | None = None, caller_reputation_service_result: str | None = None, caller_reputation_score_reason: str | None = None, interaction_id: str | None = None, wxcc_consult_merge_status: str | None = None, ELIN: str | None = None, emergency_number_source: str | None = None, **extra_data: Any)

Bases: ApiModel

classmethod normalize_data(data: dict[str, Any])

Pop all empty strings so that they get caught by Optional[] and convert keys to proper attribute names :meta private:

start_time: datetime | None

This is the start time of the call, the answer time may be slightly after this. Time is in UTC.

answer_time: datetime | None

The time the call was answered. Time is in UTC.

duration: int | None

The length of the call in seconds.

answered: bool | None

direction: CDRDirection | str | None

Whether the call was inbound or outbound. The possible values are:

called_line_id: str | None

For incoming calls, the calling line ID of the user. For outgoing calls, it’s the calling line ID of the called party.

call_id: str | None

calling_line_id: str | None

call_type: CDRCallType | None

Type of call. For example:

client_type: CDRClientType | None

The type of client that the user (creating this record) is using to make or receive the call. For example:

client_version: str | None

The version of the client that the user (creating this record) is using to make or receive the call.

correlation_id: str | None

Correlation ID to tie together multiple call legs of the same call session.

international_country: str | None

The country code of the dialed number. This is only populated for international calls.

local_session_id: str | None

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.

device_mac: str | None

The MAC address of the device, if known.

inbound_trunk: str | None

Inbound trunk may be presented in Originating and Terminating records.

org_uuid: str | None

A unique identifier for the organization that made the call. This is a unique identifier across Cisco.

original_reason: CDROriginalReason | None

Populated for calls that transfer, hold, wait, and so on. For example:

os_type: str | None

The operating system that the app was running on, if available.

outbound_trunk: str | None

Outbound trunk may be presented in Originating and Terminating records.

redirect_reason: CDRRedirectReason | None

Populated for calls that transfer, hold, wait, and so on. For example:

related_reason: CDRRelatedReason | None

Populated for calls that transfer, hold, wait, and so on. For example:

report_id: str | None

A unique ID for this particular record. This can be used when processing records to aid in deduplication.

report_time: datetime | None

The time this report was created. Time is in UTC.

route_group: str | None

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: str | None

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: str | None

The main number for the user’s site where the call was made or received.

site_timezone: str | None

Site timezone is the offset in minutes from UTC time of the user’s timezone.

sub_client_type: str | None

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.

user_uuid: str | None

A unique identifier for the user associated with the call. This is a unique identifier across Cisco products.

user: str | None

The user who made or received the call.

user_type: CDRUserType | None

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

called_number: str | None

For incoming calls, the telephone number of the user. For outgoing calls, it’s the telephone number of the called party.

calling_number: str | None

For incoming calls, the telephone number of the calling party. For outgoing calls, it’s the telephone number of the user.

location: str | None

Location of the report.

dialed_digits: str | None

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.

releasing_party: str | None

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_session_id: str | None

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.

redirecting_number: str | None

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.

site_uuid: str | None

A unique identifier for the site associated with the call. Unique across Cisco products.

department_id: str | None

A unique identifier for the user’s department name.

transfer_related_call_id: str | None

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.

authorization_code: str | None

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.

model: str | None

The device model type the user is using to make or receive the call.

call_transfer_time: datetime | None

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.

local_call_id: str | None

A unique identifier that’s 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.

remote_call_id: str | None

A unique identifier that’s 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.

network_call_id: str | None

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.

related_call_id: str | None

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.

user_number: str | None

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.

call_outcome: str | None

Identifies whether the call was set up or disconnected normally. Possible values are:

Success—Call was routed and disconnected successfully. Includes Normal, UserBusy, and NoAnswer scenarios.

Failure—Call failed with an internal or external error.

Refusal—Call was rejected because of call block or timeout.

You can find more information in the Call outcome reason field.

call_outcome_reason: str | None

Additional information about the Call outcome returned. Possible reasons are:

• Success

• Normal: Call is completed successfully.

• UserBusy: Call is a success, but the user is busy.

• NoAnswer: Call is a success, but the user didn’t answer.

• Refusal

• CallRejected: Call attempt rejected at the recipient’s end.

• UnassignedNumber: The dialed number isn’t assigned to any user or service.

• SIP408: Request timed out because couldn’t find the user in time.

• InternalRequestTimeout: Request timed out as the service couldn’t fulfill the request due to an unexpected condition.

• Q850102ServerTimeout: Recovery on timer expiry/server timed out

• NoUserResponse: No response from any end-user device/client

• NoAnswerFromUser: No answer from the user.

• SIP480: Callee or called party is currently unavailable.

• SIP487: Request is terminated by bye or cancel.

• TemporarilyUnavailable: User is temporarily unavailable.

• AdminCallBlock: Call attempt is rejected due to the organization’s call block list.

• UserCallBlock: The call to user is rejected because the number is on the user’s block list.

• Unreachable: Unable to route the call to the desired destination.

• LocalGatewayLoop: Loop detected between the local gateway and Webex Calling.

• UserAbsent: User is temporarily unreachable or unavailable.

• Failure

• DestinationOutOfOrder: Service request failed as the destination can’t be reached or the interface to the destination isn’t functioning correctly.

• SIP501: Invalid method and can’t identify the request method.

• SIP503: Service is temporarily unavailable so can’t process the request.

• ProtocolError: Unknown or unimplemented release code.

• SIP606: Some aspect of the session description wasn’t acceptable.

• NoRouteToDestination: No route available to the destination

• Internal: Failed because of internal Webex Calling reasons.

• MaxConcurrentTerminatingAlertingRequestsExceeded: The number of simultaneous unanswered calls to a local gateway, for the same calling and called number, exceeded the limit.

ring_duration: int | None

The length of ringing before the call was answered or timed out, in seconds.

answer_indicator: str | None

Whether the call leg was answered after a redirection. Possible values: * Yes * No * Yes-PostRedirection

release_time: datetime | None

The time the call was finished, in UTC.

final_local_session_id: str | None

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_session_id: str | None

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.

pstn_vendor_name: str | None

Displays the vendor’s name from whom the PSTN service was purchased for the respective country.

pstn_legal_entity: str | None

Displays the regulated business entity registered for providing PSTN service in that particular country. The field is exclusively for Cisco Calling Plans.

pstn_vendor_org_id: str | None

Displays the Cisco Calling plan’s org UUID. It is unique across different regions

pstn_provider_id: str | None

Represents an immutable Cisco defined UUID attribute for a PSTN provider, which uniquely identifies the entity that has provided PSTN in that country.

external_customer_id: str | None

redirecting_party_uuid: str | None

Whenever call is redirected one or more times, this field indicates the unique identifier of the last redirecting party user or service (that is, accountable for) this CDR. This field holds the value of the UUID contained in the Cisco Common Identity associated with a user or service.

public_calling_ip_address: str | None

Indicates the public IP address of the device or application making a call in India locations.

public_called_ip_address: str | None

Indicates the public IP address of the terminating device or application in India locations.

caller_id_number: str | None

Displays the calling party’s presentation number based on the caller id setting from the control hub. It could be a direct line/extension, location number, custom option from an organization.

external_caller_id_number: str | None

It’s only set when the Control Hub External caller ID phone number setting is either location number or any other number from an organization . Also, it is not set when the Direct line/Ext options has been selected.

device_owner_uuid: str | None

When calls are made using multi-line or shared line options, it represents the unique identifier of the device owner (that is, accountable for). This field holds the value of the UUID contained in the Cisco Common Identity associated with a user.

Example: If Alice has a device assigned, where multiline is configured or Bob and makes/receives a call from Bob’s line, then Bob’s CDR for the call will have Alice UUID as the device owner.

call_recording_platform_name: str | None

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: str | None

“successful”, “failed”, or “successful but not kept.”

Type:

Status of the recorded media

call_recording_trigger: str | None

User’s recording mode for the call. The values for this field are “always”, always-pause-resume”, “on-demand”, or “on-demand-user-start.”

original_called_party_uuid: str | None

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: str | None

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: int | None

Indicates the total duration of call hold time in seconds. This is the floor value of the calculated hold duration

auto_attendant_key_pressed: str | None

Indicates the last key pressed value by the caller.

queue_type: str | None

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: str | None

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: str | None

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: str | None

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: str | None

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: str | None

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: str | None

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: str | None

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: str | None

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.

class wxc_sdk.cdr.DetailedCDRApi(*, session: RestSession, base: str = None)

Bases: ApiChild

Reports: Detailed Call History

The base URL for these APIs is analytics-calling.webexapis.com (or analytics-calling-gov.webexapis.com for Government). These endpoints are not compatible with the API reference’s Try It feature. For questions or assistance, please contact the Webex Developer Support team at devsupport@webex.com.

The CDR Feed API is recommended for users who need to pull CDR records for a specific time period. For more up-to-date records, use the cdr_stream endpoint API instead.

To retrieve Detailed Call History information, your request must include a token with the spark-admin:calling_cdr_read scope. Additionally, the authenticating user must have the administrator role “Webex Calling Detailed Call History API access” enabled.

The CDR Feed API can query any 12-hour period between 5 minutes ago and 30 days prior to the current UTC time. Only 12 hours of records can be retrieved per request (i.e., the time between the selected start and end times in a single API call). For example: If a call ends at 9:46 AM, the record is available for collection starting at 9:51 AM and remains available until 9:46 AM 30 days later. The maximum query duration starting at 9:51 AM would end at 9:51 PM the same day.

This API is rate-limited to 1 initial request per minute per user token, with up to 10 additional pagination requests per minute per user token.

Details on the fields returned from this API and their potential values are available at <https://help.webex.com/en-us/article/nmug598/Reports-for-Your-Cloud-Collaboration-Portfolio>. Select the Report templates tab, and under the Webex Calling reports, see Calling Detailed Call History Report.

By default, the calls to analytics-calling.webexapis.com are routed to the closest region’s servers. If the region’s servers host the organization’s data, then the data is returned. Otherwise, an HTTP 451 error code is returned. In such cases, the response body contains endpoint information indicating where the organization’s data can be retrieved.

get_cdr_history(start_time: str | datetime = None, end_time: datetime | str = None, locations: list[str] = None, host: str = 'analytics-calling.webexapis.com', stream: bool = False, **params) → Generator[CDR, None, None]

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.

Parameters:

• start_time (Union[str, datetime]) –

  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 Can be a datetime object or an ISO-8601 datetime string to be parsed by dateutil.parser.isoparse()

• end_time (Union[str, datetime]) –

  Time of the last report you wish to collect. (Report time is the time the call finished).

  Note: The specified time should be earlier than startTime and no earlier than 48 hours ago. Can be a datetime object or an ISO-8601 datetime string to be parsed by dateutil.parser.isoparse().

• locations (list[str]) – Names of the location (as shown in Control Hub). Up to 10 comma-separated locations can be provided. Allows you to query reports by location.

• host (str) – analytics host to access. Defaults to ‘analytics.webexapis.com’.

• stream (bool) – If true, collect data from cdr_stream, else from cdr_feed. Defaults to False (cdr_feed).

• params – additional arguments

Returns:

base = ''