Developers

Messaging API

get_message_status


URL:

http://api.msgme.com/v1/messaging/get_message_status

METHOD:

Get

DESCRIPTION:

Returns the status of a [set of] message(s) given a MessageID. Each individual message sent to a mobile phone is indentified by an MTID. An individual message sent to multiple phones (i.e. a 'Blast') can be identified by the set of MTIDs for each phone number, or by one Parent MTID. Any message sent via the Messaging API, whether sent to one phone or many phones, can be identified by the API's returned MessageId. The status 'NOT SENT' will be returned if the message has not been sent for the following reasons: the scheduled time has not arrived, the mobile number is no longer a subscriber, the mobile number no longer wishes to receive text messages.

PARAMETERS:

Parameter Description
token The security token that was returned using authentication_api method.
messageId The transaction ID of any Send Message API call. This will return the statuses of all the MTs generated in the API call.


API REQUEST:

http://api.msgme.com/v1/messaging/get_message_status?token=[token]&messageId=[transaction ID from Messaging API call]



API RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="[status text]" statusCode="[status code]" >
			<message_status
				mtids="[IDs of mobile terminated messages]" 
				status="[Sent|Scheduled|Error]" />
				... 
		</apiResponse>


EXAMPLE USAGE:

In this example we will query for the status of a blast sent via API to multiple numbers using the returned Message ID (messageId 34567).


REQUEST:

GET http://api.msgme.com/v1/messaging/get_message_status?token=0e9ace1582fbb754dfe7f4e11f572bf5273f3c69&messageId=34567


RESPONSE:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiResponse status="success" statusCode="200" >
			<message_status
				mtids="9000,9001,9002,9003,9004,9005,9006 " 
				status="Sent" />
		</apiResponse>