Textlocal Logo

API Documentation

Message Status

This command can be used to determine the delivery status of a sent message, whether it be SMS or MMS.

Resource URL

https://api.textlocal.in/status_message/

Sample Request

<?php
	// Account details
	$apiKey = urlencode('Your apiKey');
	
	// Message Details
	$message_id = '123456';

	// Prepare data for POST request
	$data = array('apikey' => $apiKey, 'message_id' => $message_id);
 
	// Send the POST request with cURL
	$ch = curl_init('https://api.textlocal.in/status_message/');
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$response = curl_exec($ch);
	curl_close($ch);
	
	// Process your response here
	echo $response;
?>
<?php
	// Account details
	$apiKey = urlencode('Your apiKey');
	
	// Message Details
	$message_id = '123456';

	// Prepare data for POST request
	$data = 'apikey=' . $apiKey . '&message_id=' . $message_id;
 
	// Send the GET request with cURL
	$ch = curl_init('https://api.textlocal.in/status_message/?' . $data);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$response = curl_exec($ch);
	curl_close($ch);
	
	// Process your response here
	echo $response;
?>
<?php
	require('Textlocal.class.php');

	$Textlocal = new Textlocal(false, false, 'your apiKey');
	
	$message_id = 123456;
	
	$response = $Textlocal->getMessageStatus($message_id);
	print_r($response);
?>

Parameters

message_id ID of the message you'd like to check the status of. Found in the response of send_sms.
Login Parameters (Additional Information)
apiKey You can create these in your Messenger Control Panel (click here) for each application, and limit the usage of them by host IP Address.

Sample Response

{
	"message":{
		"id":1151895224,
		"recipient":918123456789,
		"type":"sms",
		"status":"D",
		"date":"2013-07-04 14:31:18"
	},
	"status":"success"
}
<?xml version="1.0" encoding="UTF-8" ?>
<response>
	<message>
		<id>1151895224</id>
		<recipient>918123456789</recipient>
		<type>sms</type>
		<status>D</status>
		<date>2013-07-04 14:31:18</date>
	</message>
	<status>success</status>
</response>

Errors

Error Codes
16 No message ID specified.
17 Invalid message ID.