Message Detail Records

| cURL | Python | Node | Java | .NET | Ruby |

cURL

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to acquire an API Key to run this code in your terminal.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/messages/834f3d53-8a3c-4aa0-a733-7f2d682a72df"

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "phone_number": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "cost": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following:

Python

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to set up your development environment and acquire an API Key to run this code.

import telnyx
telnyx.api_key = 'YOUR_API_KEY'

response = telnyx.Message.retrieve("834f3d53-8a3c-4aa0-a733-7f2d682a72df")

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "address": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "amount": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following:

Node

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to set up your development environment and acquire an API Key to run this code.

const telnyx = require("telnyx")("YOUR_API_KEY")

const { data: messageDetail } = await telnyx.Message.retrieve("834f3d53-8a3c-4aa0-a733-7f2d682a72df")

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "address": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "amount": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following:

Java

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to set up your development environment and acquire an API Key to run this code.

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MessagesApi;
import java.util.UUID;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");

        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MessagesApi apiInstance = new MessagesApi(defaultClient);
        UUID id = UUID.fromString("834f3d53-8a3c-4aa0-a733-7f2d682a72df"); // UUID | The id of the message
        try {
            MessageResponse result = apiInstance.retrieveMessage(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#retrieveMessage");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "address": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "amount": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following:

.NET

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to set up your development environment and acquire an API Key to run this code.

using System;
using Telnyx;
using System.Threading.Tasks;

namespace retrieve_mdr
{
    class Program
    {
        private static string TELNYX_API_KEY = System.Environment.GetEnvironmentVariable("TELNYX_API_KEY");
        private static string MDR = "MDR_UUID";
        static async Task Main(string[] args)
        {
            Console.WriteLine("Retrieve UUID!");
            TelnyxConfiguration.SetApiKey(TELNYX_API_KEY);
            MessagingSenderIdService service = new MessagingSenderIdService();

            try
            {
                var retrieveMessage = await service.GetAsync(MDR);
                Console.WriteLine(retrieveMessage);
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "address": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "amount": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following:

Ruby

Once a send message API request goes through, your SMS or MMS will be put into a queue to be sent to its destination. A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

Retrieving an MDR

Note: You will have to set up your development environment and acquire an API Key to run this code.

require 'telnyx'
Telnyx.api_key = 'YOUR_API_KEY'

response = Telnyx::Message.retrieve("834f3d53-8a3c-4aa0-a733-7f2d682a72df")

Note: After pasting the above content, Kindly check and remove any new line added

Response Payload

{
  "data": {
    "record_type": "message",
    "id": "834f3d53-8a3c-4aa0-a733-7f2d682a72df",
    "direction": "outbound",
    "type": "sms",
    "from": "+18445550001",
    "to": [
      {
        "address": "+18665550002",
        "status": "delivered",
        "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
    "text": "Hello, World!",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://www.example.com/callbacks",
    "use_profile_webhooks": false,
    "cost": {
      "amount": "1.23",
      "currency": "USD"
    },
    "parts": 1,
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "valid_until": "2019-01-23T18:10:02.574Z",
    "errors": [],
    "carrier": "Verizon",
    "line_type": "Wireless"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

MDR Schema and Status Descriptions

A Message Detail Record (MDR) describes a specific message request and includes those that are active, pending and completed. Telnyx stores the most recent version of the MDR.

MDR Schema

MDR status Field

status describes the status/state of the message request when the MDR was retrieved. The value is a string without whitespace.

Inbound Status

When you request an MDR for an inbound message request, the status of the retrieved MDR will most likely be "delivered". That said, there are two inbound statuses:

Outbound Status

For an outbound message request:

• An MDR is only created when Telnyx attempts to send the message. A rejected request will not have an associated MDR. When a request is rejected, Telnyx responds with the reason e.g., missing or invalid value.
• If the request includes a reachable delivery status webhook URL, we'll POST the MDR after each status update.
• Telnyx stores the most recent version of the MDR.
• The status of a completed request is either "delivered" or "failed" , which are the "finished" statuses.

An accepted request will transition through some, but not all, of the following: