Look Up a Message Detail Record

Use this endpoint to search for a specific message record ID and return a Message Detail Record (in MDR2 format).

Endpoint

GET /messages/:record_id

Request Parameters

All request parameters are optional unless otherwise noted.

Body Parameters

record_id
string required
The unique message detail record identifier (MDR ID) of any message. When entering the MDR ID, the number should include the mdr2- preface.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains the response body contains the message object for your specified record_id. On error, the header status code is an error code and the response body contains an error object.

data

Object composed of attributes, type, and id.
attributes

Object composed of attributes defined in Receive an MMS.

Example Request

GET /v2.2/messages/mdr2-d6fdc68258e24157898f0a6780722ecd HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl -u accessKey:secretKey https://api.flowroute.com/v2.2/messages/mdr2-391a27ae879d11e7abc4be28d2dc3553

Example Request

This assumes that you have the Python API Wrapper installed and set up. The following example is from demo.py which looks up a set of messages and retrieves the details of the first message in the resulting array. Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors.


# Instantiate the API client and create a controller for Messages
client = FlowroutenumbersandmessagingClient(basic_auth_user_name, basic_auth_password)
messages_controller = client.messages

# Look up MDR details 
message_id = result['data'][0]['id']
result = messages_controller.look_up_a_message_detail_record(message_id)
pprint.pprint(result)

Example Response

200 OK

{
    "data": {
      "attributes": {
        "amount_display": "$0.0097",
        "amount_nanodollars": 9700000,
        "body": "I'm in a meeting",
        "delivery_receipts": [
        {
            "level": 2,
            "status": "message buffered",
            "status_code": 1003,
            "status_code_description": "Message accepted by the SMSC but the phone is off or out of reach. The message is buffered.",
            "timestamp": "2019-07-08T18:07:03.00Z"
          },
          {
            "level": 1,
            "status": "smsc submit",
            "status_code": null,
            "status_code_description": "Message has been sent",
            "timestamp": "2019-07-08T18:06:53.00Z"
          }
        ],
        "direction": "outbound",
        "from": "12065555141",
        "is_mms": false,
        "message_encoding": 0,
        "message_type": "longcode",
        "price_details": {
          "base_rate": "0.003500",
          "charged_cost": "0.009700",
          "segment_count": 1,
          "surcharge_rate": "0.006200"
        },
        "status": "message buffered",
        "timestamp": "2019-07-08T18:06:53.00Z",
        "to": "14037622211"
      },
      "id": "mdr2-abc123",
      "links": {
        "self": "https://api.flowroute.com/v2.2/messages/mdr2-abc123"
      },
      "type": "message"
    }
  }

mms v2.2

About

Endpoints

ACCOUNT LEVEL MESSAGING CALLBACK SERVICES

PHONE NUMBER MESSAGING CALLBACK SERVICES

Related Articles

Look Up a Message Detail Record

Endpoint

Request Parameters

Body Parameters

record_id

Response Format

data

attributes

Example Request

Example Request

Example Request

Example Response

200 OK