Pricing Templates
Log in Sign up
Integrations / Telstra Messaging / ...

POST /reports/messages

Request a CSV report of messages (both incoming and outgoing) that have been sent to/from your account within the last three months. You can request details for a specific timeframe, and filter your messages by tags, recipient number or Virtual Number.

A 201 Created means your report has been queued for generation. Make a note of the reportId returned in the response. You'll need this to check the status of your report and fetch your download link with GET reports/{reportId}. If you supplied a reportCallbackUrl in the request we'll also notify it when your report is ready for download.

Once your report is generated, it will be available for download for one week. The expiry date is returned in the response.

Servers

Request headers

Name Type Required Description
Accept String Yes
Telstra-api-version String No
Content-Type String Yes
Content-Language String Yes
Authorization String Yes
Accept-Charset String Yes

Request body fields

Name Type Required Description
endDate String Yes

Type the end date (inclusive) of your reporting period here.

Your endDate must be a date in the past, and less than three months from your startDate. Use ISO format(yyyy-mm-dd).
filter String No

Filter your messages report by:

  • tag - use one of the tags assigned to your message(s)
  • number - either the Virtual Number used to send the message, or the Recipient Number the message was sent to.
reportCallbackUrl String No

Tell us the callbackUrl you want us to notify when your report is ready for download.

Sample callback response:

{
  "reportId":"1520b774-46b0-4415-a05f-7bcb1c032c59",
  "reportStatus":"completed",
  "timestamp":"2022-11-10T05:06:42.823Z"
}
startDate String Yes

Set the time period you want to generate a report for by typing the start date (inclusive) here.

Note that we only retain data for three months, so please ensure your startDate is not more than three months old.

Use ISO format(yyyy-mm-dd), e.g. 2019-08-24.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy