Replies

/v2/replies/getbydate

Retrieve messages in a given date range. With paging.

Authentication: In order to use this method you must be authenticated using one of the supported methods.

Parameters

  • StartDate - the start of the date range to include messages from
  • EndDate - the end of the date range to include messages from
  • Page - (optional) the page number of results to retreive.
  • PageSize - (optional) the maximum number of results to retreive per page.

Return Values

  • 200 - Success.
  • 401 - Credentials failed.

Content will contain

  • Items - a collection of Reply data type
  • PageNumber - the page index of the results.
  • PageSize - the size of the page.
  • TotalRecords - the total number of records which are within the date range specified in the request.
  • TotalPages - the total number of pages of results which are withing the date range specified in the request.

Example Request

GET /v2/Replies/GetByDate?startDate=2010-05-24&endDate=2017-05-25 HTTP/1.1
Host: api.messagenet.com.au
Authorization: Bearer 12345
Accept: application/json
Content-Type: application/json

And an example response

{
    "Items": [
       {
           "MessageText": "Sample text",
           "MessageId": "1",
           "From": "0400555555",
           "To": "0400555555",
           "DateReceived": "2015-11-13T16:08:23+11:00"
       }],
    "PageNumber": 1,
    "PageSize": 200,
    "TotalRecords": 1,
    "TotalPages": 1
}