Overview

This API endpoint allows the user to fetch any replies that they have received to transactional SMS messages sent out via our platform. Date parameters are supplied to filter the results.

The Method

API Method
REST GET https://[Your URL]/api/2.0/production/sms/replies

Parameters

Property Type Description Default Required Read Only
processed_since Date-Time A starting date to filter the replies returned None Yes
processed_until Date-Time An ending date to filter the replies returned None Yes
Optional Parameters

You may include any of these optional parameters:

Property Type Description Default Required Read Only
page integer Page number. 200 results are returned per page. 1 No

Code Samples

Example Request

GET /api/2.0/production/sms/replies?processed_since=2021-01-01 09:00:00&processed_until=2022-03-10 09:00:00&page=3 HTTP/1.1
Host: [Your URL]
Authorization: Basic [Your Auth]

Example Response

{
    "total": 10671,
    "per_page": 200,
    "current_page": 3,
    "last_page": 54,
    "next_page_url": "http://[Your URL]/sms/replies/?processed_since=2021-01-01+09%3A00%3A00&processed_until=2022-03-10+09%3A00%3A00&page=4",
    "prev_page_url": "http://[Your URL]/sms/replies/?processed_since=2021-01-01+09%3A00%3A00&processed_until=2022-03-10+09%3A00%3A00&page=2",
    "from": 401,
    "to": 600,
    "data": [
        {
            "reply_id": 2000410,
            "reply_content": "This is my SMS reply :)",
            "reply_mobile_number": "+277*********",
            "reply_transaction_id": 200104992,
            "reply_received_date": "2020-07-13 13:22:04",
            "created_at": "2021-03-01 16:32:41",
            "updated_at": "2021-03-01 16:32:41",
            "transaction": {
                "transaction_id": 200104992,
          "queued_date": "2020-07-13 13:17:27",
                "sent_date": "2020-07-13 13:17:35",
                "transaction_mobile_number": "+277********",
                "transaction_message": "This is an example SMS sent from Everlytic. Reply STOP to Opt-Out",
                "transaction_custom_id": "custom-123",
                "transaction_status": "sent",
                "transaction_quota_cost": 1,
                "transaction_fail_message": "",
            }
        },
  ]
}