Retrieve a Message Detail Record | Plivo API Reference

Latest Legacy

Retrieve a Message

Retrieves a Message Detail Record (MDR).

API Endpoint

GET https://api.plivo.com/v1/Account/{auth_id}/Message/{message_uuid}/

Arguments

No arguments need to be passed.

Returns

This API call returns the Message Detail Record for the message identified by the message_uuid specified in the request URL.

Response

HTTP Status Code: 200

{
    "api_id": "85a704c8-e47a-11eb-9a69-0242ac110004",
    "carrier_fees": "0.04",
    "carrier_fees_rate": "0.04",
    "error_code": "000",
    "from_number": "17087654321",
    "is_domestic": "false",
    "mcc": "312",
    "message_direction": "outbound",
    "message_state": "delivered",
    "message_time": "2021-07-13 13:04:06.799021+05:30",
    "message_type": "sms",
    "message_uuid": "b48d95dc-e3ac-11eb-a9c2-0242ac110005",
    "mnc": "650",
    "powerpack_id": "1d5f3dd8-b207-4738-b59f-3c2ac7d3461c",
    "resource_uri": "/v1/Account/{auth_id}/Message/b48d95dc-e3ac-11eb-a9c2-0242ac110005/",
    "to_number": "12401234567",
    "total_amount": "0.00140",
    "total_rate": "0.00140",
    "tendlc_campaign_id": "CD4WJJD",
    "tendlc_registration_status": "registered",
    "destination_country_iso2": "US",
    "units": 1,
    "replaced_sender": "17087654321",
    "is_domestic": false,
    "dlt_entity_id": "",
    "dlt_template_id": "",
    "dlt_template_category": "",
    "requester_ip": "192.168.0.1",
    "destination_network": "verizon", 
    "conversation_id": "2b89d38b573b5ca0a1e85ba3b8d159fc",
    "conversation_origin": "authentication",
    "conversation_expiration_timestamp": "2024-02-13 01:21:00-08:00", 
    "log": "number_only"

}

Example Request

1
2
3
4
5
6
7
import plivo

client = plivo.RestClient(auth_id="<auth_id>", auth_token="auth_token")

# Get MDR
response = client.messages.get(message_uuid='d6d17dd2-b9fe-4cf8-acfd-c6a8b959ea38')
print(response)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
require 'rubygems'
require 'plivo'

include Plivo
include Plivo::Exceptions

# Environment
api = RestClient.new("<auth_id>", "<auth_token>")

# GET MDR
begin
response = api.messages.get("c9d8f08d-4f1f-4765-b7e4-83e0d35a36c5")
puts response
rescue PlivoRESTError => e
    puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10
11
let plivo = require('plivo')

let client = new plivo.Client('<auth_id>','<auth_token>');

// Get MDR
client.messages.get("62085fe8-9b8a-4c9d-9527-5996e94333ab")
.then(function(response) {
    console.log(response);
}).catch(function(error) {
    console.log(error);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php
require 'vendor/autoload.php';
use Plivo\RestClient;

// ENVIORNMENT
$client = new RestClient("<auth_id>", "<auth_token>");

// Get MDR
try {
    $response = $client->messages->get('c9d8f08d-4f1f-4765-b7e4-83e0d35a36c5');
    print_r($response);
}
catch (PlivoRestException $ex) {
    print_r($ex);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.plivo.examples;
import java.io.IOException;

import com.plivo.api.Plivo;
import com.plivo.api.models.message.Message;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.exceptions.PlivoValidationException;

public class Sample {

	public static void main(String[] args) throws PlivoValidationException {
        Plivo.init("<auth_id>", "<auth_token>");

        // Get MDR
		try {
		Message response = Message.getter("62085fe8-9b8a-4c9d-9527-5996e94333ab").get();		
		System.out.println(response);
		} catch (PlivoRestException | IOException e) {
			e.printStackTrace();
		}
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Exception;

namespace dotnet_sdk
{
    class Sms
    {
        static void Main(string[] args)
        {
            // ENVIRONMENT
            var api = new PlivoApi("<auth_id>","<auth_token>");

            // Get MDR
            try
            {   
                Console.WriteLine("Get MDR");
                var response = api.Message.Get(
                messageUuid: "d6af1134-ab76-11ed-bf27-0242ac110003"
            );
                Console.WriteLine(response);
            }
            catch (PlivoRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }

        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package main

import (
	"fmt"

	plivo "github.com/plivo/plivo-go"
)

func main() {

	// ENVIRONMENT
	client, err := plivo.NewClient("<auth_id>", "<auth_token>",
		&plivo.ClientOptions{})
	if err != nil {
		panic(err)
	}

	// GET MDR
	response, err := client.Messages.Get("e0f9ab26-bec2-4f21-b1f0-47014e15e268")
	if err != nil {
		panic(err)
	}
	fmt.Printf("Response: %#v\n", response)

}

Example Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import plivo

auth_id = "Your AUTH_ID"
auth_token = "Your Auth_TOKEN"
p = plivo.RestAPI(auth_id, auth_token)

# Message UUID for which the details will be retrieved
params = {'message_uuid': '0936ec98-7c4c-11e4-9bd8-22000afa12b9'}
# Fetch the details
response = p.get_message(params)

# Prints all the details of a message
print str(response)

# Prints the number of SMS units
# print "Your SMS was split into %s units" % response[1]['units']

# Prints the status of the message
# print response[1]['message_state']

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
require 'rubygems'
require 'plivo'
include Plivo

AUTH_ID = "Your AUTH_ID"
AUTH_TOKEN = "Your AUTH_TOKEN"
p = RestAPI.new(AUTH_ID, AUTH_TOKEN)

# Message UUID for which the details will be retrieved
params = {'record_id' => '0936ec98-7c4c-11e4-9bd8-22000afa12b9'}
# Fetch the details
response = p.get_message(params)

# Prints all the details of a message
puts response

# Prints the number of SMS units
# puts "Your SMS was split into %s units" % response[1]['units']

# Prints the status of the message
# puts response[1]['message_state']

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var plivo = require('plivo');
var p = plivo.RestAPI({
    authId: 'Your AUTH_ID',
    authToken: 'Your AUTH_TOKEN'
});

// Message UUID for which the details will be retrieved
var params = {'record_id': '005bcdf3-b1b9-4487-b8d3-59efb41431ca'};

// Fetch the details
p.get_message(params, function (status, response) {
    console.log('Status: ', status);
    console.log('API Response:\n', response);
    console.log('Units:', response['units']);
    console.log('Status:', response['message_state']);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
    require 'vendor/autoload.php';
    use Plivo\RestAPI;
    $auth_id = "Your AUTH_ID";
    $auth_token = "Your AUTH_TOKEN";
    $p = new RestAPI($auth_id, $auth_token);

    // Message UUID for which the details will be retrieved
    $params = array('record_id' => '0936ec98-7c4c-11e4-9bd8-22000afa12b9');
    // Fetch the details
    $response = $p->get_message($params);

    // Print the response
    print_r ($response['response']);

    // Print the number of SMS units
    print "Units : {$response['response']['units']}";

    // Print the status of the message
    print "Message State : {$response['response']['message_state']}";
?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package com.plivo.test;

import java.util.LinkedHashMap;
import com.plivo.helper.api.client.*;
import com.plivo.helper.api.response.message.MessageResponse;
import com.plivo.helper.exception.PlivoException;

public class GetDetails {
    public static void main(String[] args) {
        String authId = "Your AUTH_ID";
        String authToken = "Your AUTH_TOKEN";
        RestAPI api = new RestAPI(authId, authToken, "v1");

        LinkedHashMap<String, String> parameters = new LinkedHashMap<String, String>();
        // Message UUID for which the details will be retrieved
        parameters.put("record_id", "0936ec98-7c4c-11e4-9bd8-22000afa12b9");
        try {
            Message msg = api.getMessage(parameters);
            // Prints all the details of a message
            System.out.println(msg);

            // Prints the number of SMS units
            // System.out.println("Units : " + msg.units);

            // Prints the state of the message
            // System.out.println("Message State : " + msg.messageState);
        } catch (PlivoException e) {
            System.out.println(e.getLocalizedMessage());
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
using System;
using System.Collections.Generic;
using System.Reflection;
using RestSharp;
using Plivo.API;

namespace Get_Details
{
    class Program
    {
        static void Main(string[] args)
        {
            RestAPI plivo = new RestAPI("Your AUTH_ID", "Your AUTH_TOKEN");
            IRestResponse<Message> resp = plivo.get_message(new Dictionary<string, string>()
            {
                // Message UUID for which the details will be retrieved
                { "record_id", "1aead330-8ff9-11e4-9bd8-22000afa12b9" }
            });

            // Prints all the details of a message
            Console.Write(resp.Content);

            // Print the status of the message
            // Console.Write("Message State : {0}", resp.Data.message_state);

            Console.ReadLine();
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
    package main

import (
	"fmt"

	plivo "github.com/plivo/plivo-go"
)

func main() {

	// ENVIRONMENT
	client, err := plivo.NewClient("<auth_id>", "<auth_token>",
		&plivo.ClientOptions{})
	if err != nil {
		panic(err)
	}

	// GET MDR
	response, err := client.Messages.Get("e0f9ab26-bec2-4f21-b1f0-47014e15e268")
	if err != nil {
		panic(err)
	}
	fmt.Printf("Response: %#v\n", response)

}

Rate this page

🥳 Thank you! It means a lot to us!