Fax
List of fax reception records.
Page number of the response, starting at 0.
Page size of the response.
Flag indicating whether there are more pages.
Implements interfaces
Base
{ "content": [ { "__typename": "FaxInUdrReportRecord" } ], "pageIndex": 40, "pageSize": 40, "hasMoreElements": true }
Fax
Fax Inbound UDR Report Record
Unique identifier for the fax reception record.
Accounting service identifier, used for billing and cost allocation.
Total number of pages in the received fax document.
Scheduled timestamp when archived fax data will be purged.
Current archiving status of the fax document.
Transmission speed, in bits per second, used during fax reception.
Billing code associated with the fax reception for cost allocation.
Timestamp when the fax call was successfully connected.
Country from which the fax was sent.
Called Station Identifier of the receiving fax machine.
Phone number that received the fax.
Display format of the called number as shown to users.
Phone number from which the fax was sent.
Transmitting Station Identifier of the sending fax machine.
Timestamp when the fax call was initiated.
Number of pages successfully received and confirmed.
Customer identifier for the account.
Email addresses or delivery endpoints for the received fax.
Sender information used in fax delivery notifications.
User account associated with the delivery sender.
Number of pages discarded due to transmission errors.
MIME type of the converted fax document (e.g., application/pdf).
Status of document delivery to the specified recipients.
Size of the received fax file, in bytes.
Transmission status indicating success or failure of fax reception.
Primary timestamp used for record sorting and filtering.
Number of recipients configured to receive the fax document.
Fax resolution quality (e.g., standard, fine, superfine).
Additional email addresses for secondary delivery of the fax.
Number of virtual pages billed for this fax reception.
{ "faxId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "accountingService": "Example String", "allPages": 40, "archivePurgeAt": "Example String", "archivingStatus": "Example String", "baudRate": 40, "billingCode": "Example String", "callConnectedAt": "Example String", "calledCountry": "Example String", "calledCsId": "Example String", "calledNumber": "Example String", "calledNumberDisplay": "Example String", "callingNumber": "Example String", "callingTsId": "Example String", "callStartedAt": "Example String", "confirmedPages": 40, "customerId": "Example String", "deliveryRecipients": "Example String", "deliverySender": "Example String", "deliverySenderUser": "Example String", "discardedPages": 40, "docMimeType": "Example String", "documentDeliveryStatus": "Example String", "faxFileSize": 40, "faxTransmitStatus": "Example String", "keyTimestamp": "Example String", "recipientsCount": 40, "resolution": "Example String", "secondaryDeliveryRecipients": "Example String", "virtualPagesBilled": 40 }
Fax
List of fax outbound usage detail records.
Page index of the response, starting at 0.
Page size of the response.
Indicates whether there are more pages.
Implements interfaces
Base
{ "content": [ { "__typename": "FaxOutUdrReportRecord" } ], "pageIndex": 40, "pageSize": 40, "hasMoreElements": true }
Fax
Fax Outbound UDR Report Record
Unique identifier for the fax transmission.
Job identifier used for grouping related fax operations.
Account identifier associated with the fax transmission.
Account name associated with the fax transmission.
Server identifier for the account.
Service type for the account.
Number of pages in the transmission attempt.
Sequence number of the transmission attempt.
Transmission speed in bits per second.
Country billed for the fax transmission.
Timestamp when the call was connected.
Duration of the call, in milliseconds.
Country of the called number.
Called Station Identifier (CSI) of the receiving fax machine.
Phone number that was called.
Zone classification for the called number.
Timestamp when the call ended.
Transmitting Station Identifier (TSI) of the sending fax machine.
Timestamp when the call was initiated.
Number of pages in the document.
Customer reference for the fax transmission.
Scheduled timestamp for job archive purge.
Billing code for the job.
Billing information for the job.
Customer identifier for the job.
Customer reference for the job.
Resolution setting specified by the customer.
Customer-specified start time for the fax transmission.
Customer tags associated with the job.
Indicates whether express delivery was requested.
Indicates whether personalized features were enabled.
Data center where the job was submitted.
Timestamp when the job was submitted.
Key timestamp for the record.
Timestamp when the last attempt ended.
Sequence number of the last attempt.
Maximum page number transmitted.
Timestamp when final processing completed.
Status code for the transmission.
Status name for the transmission.
Reason for the transmission status.
Total duration of all call attempts, in milliseconds.
Total number of pages transmitted across all attempts.
Time from job submission to first dial attempt, in seconds.
Number of virtual pages billed.
{ "faxId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "jobId": "Example String", "accountId": "Example String", "accountName": "Example String", "accountServerId": "Example String", "accountService": "Example String", "attemptPages": 40, "attemptSeqNo": 40, "baudRate": 40, "billedCountry": "Example String", "callConnectedAt": "Example String", "callDuration": "Example Custom Scalar", "calledCountry": "Example String", "calledCsId": "Example String", "calledNumber": "Example String", "calledZone": 40, "callEndedAt": "Example String", "callingTsId": "Example String", "callInviteAt": "Example String", "docPages": 40, "faxCustomerRef": "Example String", "jobArchivePurgeAt": "Example String", "jobBillingCode": "Example String", "jobBillingInfo": "Example String", "jobCustomerId": "Example String", "jobCustomerRef": "Example String", "jobCustomerResolution": "Example String", "jobCustomerStartFaxAt": "Example String", "jobCustomerTags": "Example String", "jobExpress": true, "jobPersonalized": true, "jobSubmissionDc": "Example String", "jobSubmittedAt": "Example String", "keyTimestamp": "Example String", "lastAttemptEndedAt": "Example String", "lastAttemptSeqNo": 40, "maxPageTransmitted": 40, "processingFinalAt": "Example String", "statusCode": "Example String", "statusName": "Example String", "statusReason": "Example String", "sumCallDurations": "Example Custom Scalar", "sumPagesTransmitted": 40, "timeToFirstDial": 40, "virtualPagesBilled": 40 }
Sms
Paginated result set for SMS outbound usage detail records.
List of SMS outbound usage detail records.
Page number of the response, starting at 0.
Page size of the response.
Flag indicating if more pages are available.
Implements interfaces
Base
{ "content": [ { "__typename": "SmsOutUdrReportRecord" } ], "pageIndex": 40, "pageSize": 40, "hasMoreElements": true }
Sms
SMS Outbound UDR report record
Unique identifier for the SMS record.
Request identifier.
Job identifier.
Tracking identifier.
Reference provided by the customer for the overall job.
Recipient reference provided by the customer for this individual recipient.
Data center.
Customer identifier.
Retarus service used for sending.
Service account.
Service version.
Billing code provided in the job.
Indicates whether a delivery notification was requested in the job.
Indicates whether flash SMS requests were requested in the job.
Encoding of the SMS.
Indicates whether express delivery was requested in the job.
Indicates whether personalized SMS was enabled.
Sender of the SMS.
Recipient phone number.
Recipient country code.
Type of the recipient, e.g., mobile or fixed line.
Number of SMS parts.
Overall processing status of the SMS, either NULL or DONE.
Current status code of the SMS.
Overall status of the SMS, either NULL or SUC_ACC.
Scheduled timestamp of the SMS.
Delivery timestamp of the SMS.
Status timestamp of the SMS.
Final processing timestamp of the SMS.
Processing timestamp of the SMS. This is the timestamp used in the query filter.
Job finalization timestamp for the SMS. Note: This timestamp applies to the possibly multi-SMS job, not to this individual SMS.
{ "smsId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "requestId": "Example String", "jobId": "Example String", "trackingId": "Example String", "reference": "Example String", "recipientReference": "Example String", "dataCenter": "Example String", "customerId": "Example String", "service": "Example String", "serviceAccount": "Example String", "serviceVersion": "Example String", "billingCode": "Example String", "statusRequests": true, "flash": true, "encoding": "Example String", "express": true, "personalized": true, "src": "Example String", "recipient": "Example String", "recipientCountryCode": "Example String", "recipientType": "Example String", "numberOfParts": 40, "processStatus": "Example String", "statusCode": "Example String", "status": "Example String", "numberScheduleTs": "Example String", "numberDeliveryTs": "Example String", "numberStatusTs": "Example String", "numberFinalTs": "Example String", "deliveryProcessedTs": "Example String", "jobFinalTs": "Example String" }
Transactional
Page number of the response, starting at 0.
Page size of the response.
Flag indicating whether there are more pages.
Implements interfaces
Base
{ "content": [ { "__typename": "TransactionalEmailEventReportRecord" } ], "pageIndex": 40, "pageSize": 40, "hasMoreElements": true }
Transactional
Transactional Email Event Report Record.
Metadata: Data center where the usage occurred.
Master data: Technical account (user ID).
Usage: Unique ID of the usage data entry.
Usage: Sender address.
Usage: Sender domain.
Usage: Recipient address.
Usage: Recipient domain.
Master data: Cost center.
Usage: Campaign.
Usage: Main datetime field for when the event occurred.
Usage: Type of event. Either 'CLICK' or 'OPEN'.
Usage: Event subtype. This can be 'LINK_CLICKED' for click event types or 'MAIL_OPENED' for mail event types.
Usage: For 'CLICK' events, this is the clicked URL.
Usage: Name of the user client application.
Usage: Version of the user client application.
Usage: Is the client a mail application?
Usage: User agent of the client application.
Usage: Operating system name.
Usage: Operating system version.
Usage: Recipient reference provided by the customer.
{ "eventId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "dataCenter": "Example String", "customerId": "Example String", "userId": "Example String", "usageId": "Example String", "usageMsgFrom": "Example String", "usageMsgFromDomain": "Example String", "usageMsgTo": "Example String", "usageMsgToDomain": "Example String", "costCenter": "Example String", "campaign": "Example String", "eventTime": "Example String", "eventType": "Example String", "eventSubType": "Example String", "eventClickUrl": "Example String", "eventClientName": "Example String", "eventClientVersion": "Example String", "eventClientIsMail": true, "eventUserAgent": "Example String", "eventOsName": "Example String", "eventOsVersion": "Example String", "reference": "Example String" }
Transactional
Page number of the response, starting at 0.
Page size of the response.
Flag indicating whether there are more pages.
Implements interfaces
Base
{ "content": [ { "__typename": "TransactionalEmailUdrReportRecord" } ], "pageIndex": 40, "pageSize": 40, "hasMoreElements": true }
Transactional
Transactional Email UDR Report Record
Metadata: Entry interface (e.g., SMTP or REST).
Metadata: Data center where the usage occurred.
Usage: Job ID.
Master data: Cost center.
Master data: Technical account (user ID).
Usage: Campaign.
Usage: Unique ID of the usage data entry.
Usage: Type of usage. Either 'mail' or 'traceRecover'.
Usage: Main datetime field for when the usage occurred.
Usage: Sender address.
Usage: Sender domain.
Usage: Recipient address.
Usage: Recipient domain.
Usage: The size of the delivered email, in the unit specified by usageSizeUnit.
Usage: The unit in which the usage size is reported.
Usage: Job reference provided by the customer.
Usage: Recipient ID.
{ "metaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "metaVersion": 40, "metaCreationTime": "Example String", "customerId": "Example String", "metaEntryInterface": "Example String", "metaProcessingDomain": "Example String", "metaDataCenter": "Example String", "metaEnvironment": "Example String", "jobId": "Example String", "costCenter": "Example String", "userId": "Example String", "campaign": "Example String", "usageId": "Example String", "usageType": "Example String", "usageCreationTime": "Example String", "usageMsgFrom": "Example String", "usageMsgFromDomain": "Example String", "usageMsgTo": "Example String", "usageMsgToDomain": "Example String", "usageMsgSize": 40, "usageSizeUnit": "Example String", "usageStatus": "Example String", "usageSubStatus": "Example String", "usageStatusDetails": "Example String", "usageStatusCode": "Example String", "usageReference": "Example String", "usageCorrelationId": "Example String" }