Look Up a Message Detail Record

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

API Upgrade

To upgrade from v2 to v2.1, see Upgrade to Flowroute Messaging API v2.1.

Endpoint

GET /messages/:record_id

Request Parameters

Path 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 mdr1- preface.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains the message object. 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 the following:
- body - The content of the sent message.
- direction - The direction of the message. For a sent message, this is outbound. For a received message this is inbound.
- amount_nanodollars - The cost of the message in nanodollars. The displayed nanodollars amount is the USD amount_display value multiplied by 1,000,000,000 (one billion) for a corresponding whole number.

Example Request

curl -u accessKey:secretKey 
https://api.flowroute.com/v2/messages/mdr1-3fda18239a4d4ec2a7a961f6d813daf4

Example Request

This assumes that you have the Python API Wrapper installed and set up.

#Look up the MDR
response = controller.get_message_lookup("mdr1-3fda18239a4d4ec2a7a961f6d813daf4")

Example Request

This assumes that you have the PHP API Wrapper installed and set up.

#Get the MDR
$response = $controller->getMessageLookup('mdr1-3fda18239a4d4ec2a7a961f6d813daf4');

Example Request

This assumes that you have the Ruby API Wrapper installed and set up.

#Get the MDR
recID = 'mdr1-3fda18239a4d4ec2a7a961f6d813daf4'

#Print the response
print ctl.get_message_lookup(recID)

Example Request

This assumes that you have the Node.js API Wrapper installed and set up.

//Set your callback function
    var cb =  function(err, response){
      if(err){
        console.log(err);
      }
      console.log(response);
    };
  
//Get the MDR
flowroute.MessagesController.getMessageLookup("recordID", callback)

Example Response

200 OK

{
  "data": {
    "attributes": {
      "body": "Hey, nice marmot!",
      "direction": "outbound",
      "timestamp": "2016-04-14T21:10:27.366645+00:00",
      "amount_nanodollars": 4000000,
      "from": "12062092844",
      "message_encoding": 0,
      "is_mms": false,
      "to": "19515557918",
      "amount_display": "$0.0040",
      "callback_url": null,
      "message_type": "long-code"
    },
    "type": "message",
    "id": "mdr1-3fda18239a4d4ec2a7a961f6d813daf4"
  }
}

sms v2.0

About

Endpoints

Related Articles

Look Up a Message Detail Record

API Upgrade

Endpoint

Request Parameters

Path Parameters

record_id

Response Format

data

attributes

Example Request

Example Request

Example Request

Example Request

Example Request

Example Response

200 OK