🧪 RESTful API - message query via the web interface / timestamp

🌐 What is the RESTful API?

The REST API allows direct access to various gateway functions – such as retrieving messages, status information, or logs.

🧠 Good to know: The API can be tested interactively in the web interface – no external tools required!

🚀 Quick Start: Use the Interactive API

📍 In the web interface, navigate to:

Configuration → RESTful API → Interactive API

There you’ll find a list of available API endpoints that can be tested directly – including input fields for parameters.

🔍 Example: Retrieve Messages via GET /messages

Use the GET /messages endpoint to fetch all sent and received SMS within a specific timeframe.

🗓️ Date Format – Use UNIX Timestamps!

Start and end times are not entered as plain dates (e.g. 2024-04-26) but must be in UNIX timestamp format (number of seconds since 01/01/1970).

🧭 Example:

➡️ Helpful converter: www.unixtimestamp.com

✅ Sample API Request

GET /messages?start=1704067200&end=1735689599

🔎 This request retrieves all messages between January 1, 2024 and December 31, 2024.

🛠️ Additional Usage Notes

• Timezone matters:
  Timestamps are based on UTC – convert to local time if necessary

• Parameters are optional:
  If start and end are omitted, the entire message history is returned (may be limited by server constraints)

• URL encoding:
  Special characters like +, : or spaces must be URL-encoded
  → Example: + becomes %2B

📌 Summary of Parameters

💡 Tips for Developers and Power Users

For automated queries or testing outside the web interface, the following tools are recommended:

• Postman – graphical interface for building and testing API calls

• curl – command-line tool for Linux, macOS, Windows

• Custom REST clients – written in Python, Go, Node.js, etc.

🔄 Combined with a timestamp converter, you can easily build scheduled reports or monitoring solutions.