GET /messages

Fetch messages that have been sent from/to your account in the last 30 days.

Servers

Request headers

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

Query parameters

Name Type Required Description
startTime String No

By Default messages from last 30 days will be fetched.Use this parameter to fetch the messages from the time you want.

Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2024-01-24T15:39:00Z".

You can set a time from last 30 days. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error. If startTime alone set, messages from this time till current time will be fetched.

limit Integer No

Tell us how many results you want us to return, up to a maximum of 50.

Default value: 10

direction String No

Filter your messages by direction:

  • outgoing - messages sent from your account.
  • incoming - messages sent to your account.

Valid values:

  • "incoming"
  • "outgoing"
filter String No

Filter your messages 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.
reverse Boolean No

If set to true the results will be returned in reverse order. Recent messages will be returned first. By default, the results will be returned in the order they were sent/received.

Default value: false

status String No

Filter your messages by one of the statuses below:

  • queued - messages queued for sending or still in transit.
  • sent - messages that have been sent from the server.
  • delivered - messages successful delivered to the recipient's device. Note that we will only be able to return this status if you set deliveryNotification to true (paid feature).
  • expired - message that couldn't be sent within the retryTimeout timeframe.

Valid values:

  • "sent"
  • "queued"
  • "expired"
  • "delivered"
endTime String No

By Default messages from last 30 days will be fetched. Use this parameter to fetch the messages till the time you want.

Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2024-01-24T16:39:00Z".

You can set a time from last 30 days and endTime should be after startTime (if set). If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error.

offset Integer No

Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

Default value: 0

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.