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