Digital Wallet Cards icon

Digital Wallet Cards

Interact with Digital Wallet Cards loyalty program API

Overview

The "Get SMS History" operation in the Communication resource allows users to retrieve historical records of SMS messages sent through the Digital Wallet Cards API. This node is useful for auditing, reporting, or monitoring SMS communications with customers. For example, a business can use this operation to fetch all SMS messages sent within a specific date range, filter by customer ID or phone number, and analyze message delivery trends or customer engagement.

Typical scenarios include:

  • Retrieving SMS logs for customer support follow-up.
  • Generating reports on SMS campaign effectiveness.
  • Filtering SMS history by phone number or customer to investigate communication issues.

Properties

Name Meaning
Return All Whether to return all results or limit to a specific number.
Limit Maximum number of results to return (1 to 1000).
Additional Fields Collection of optional filters and pagination settings:
- Page Page number for pagination (default 1).
- Sort By Field name to sort the results by.
- Sort Order Sort order direction: "Ascending" or "Descending".
- Filter by Phone Filter SMS history by phone number.
- Filter by Customer ID Filter SMS history by associated customer ID.
- Date From Start date/time to filter SMS history from.
- Date To End date/time to filter SMS history up to.

Output

The output is an array of JSON objects representing individual SMS history records. Each record typically includes details such as:

  • Phone number the SMS was sent to.
  • Associated customer ID (if any).
  • Message content.
  • Timestamp of when the SMS was sent.
  • Status or delivery information (depending on API response).

This data structure enables downstream processing like filtering, analysis, or integration with other systems.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the Digital Wallet Cards API.
  • Needs an API key credential configured in n8n for authentication.
  • The base URL used is https://api.digitalwallet.cards.
  • Pagination and sorting parameters are supported via query parameters.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication errors.
    • Requesting too many records without enabling "Return All" may result in truncated data.
    • Invalid date formats in filters may cause request failures.
    • Using unsupported sort fields or values might lead to API errors.
  • Error Messages:

    • "Unknown communication operation: getSMSHistory": Indicates the operation parameter is incorrect or misspelled.
    • Validation errors if required parameters are missing.
    • API rate limits or connectivity issues may cause timeouts or HTTP errors.
  • Resolutions:

    • Ensure API credentials are correctly set up.
    • Use valid ISO 8601 date-time strings for date filters.
    • Enable "Return All" if you need complete data sets.
    • Check API documentation for supported sort fields and filter options.

Links and References


If you need details on other operations or resources, feel free to ask!

Discussion