SMS Inbound UDR report record
Unique identifier for the SMS record.
Identifier of the correlated job.
Correlated tracking identifier.
Tracking identifier.
Correlated SMS identifier.
Data center.
Customer identifier.
Correlated service.
Correlated service account.
Billing code provided in the job.
Encoding of the SMS.
Sender phone number of the SMS.
Recipient phone number.
Recipient country iso3-code.
Recipient country iso3-code.
Keyword associated with the SMS.
Number of SMS parts.
Comma-separated list of actions in plaintext.
Message-content of the SMS.
Timestamp when the SMS was received. This is the timestamp used in the query filter.
{ "smsId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "correlatedJobId": "Example String", "correlatedTrackingId": "Example String", "trackingId": "Example String", "correlatedSmsId": "Example String", "dataCenter": "Example String", "customerId": "Example String", "correlatedService": "Example String", "correlatedServiceAccount": "Example String", "billingCode": "Example String", "encoding": "Example String", "sender": "Example String", "recipient": "Example String", "senderCountryCodeIso3": "Example String", "recipientCountryCodeIso3": "Example String", "keyword": "Example String", "numberOfParts": 40, "plaintextActions": "Example String", "messageContent": "Example String", "receivedTs": "Example String" }
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 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" }
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 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" }
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 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" }