Developers

Messaging API

send_message


URL:

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

METHOD:

Post

DESCRIPTION:

Sends a custom message to any number of mobile numbers in batches of 100 maximum per API call.

PARAMETERS:

Parameter Description
token The security token that was returned using authentication_api method.
accountId Account ID of the sender
shortcode The short code that the keyword belongs to.
message The custom message to be sent to the subscribers. Note: Messages over Carrier length limits (US Carrier limit is 160 characters) will result in multiple messages being sent.
schedule An ISO 8601 date time stamp, with the following valid time zones: US/Pacific|US/Eastern|US/Mountain|US/Central|US/Hawaii|GMT
msidn Wrapped in <msidns> element. A call may contain up to 100 MSIDNs. IMPORTANT: Each MSIDN must have a terms="true" attribute in order to send the message to the destination MSIDN.


API REQUEST:

			<?xml version="1.0" encoding="UTF-8"?>
			<apiRequest token="[token]">
				<SendMessage accountId="[account ID]">
					<msidns>
						<msidn terms="true">55512345678</msidn>
						...
					</msidns>
					<shortcode>[short Code]</shortcode>
					<message><![CDATA[custom message]]></message>
					<schedule>YYYY-mm-dd HH:mm:ss Timezone</schedule>
				</SendMessage>
			</apiRequest>

API RESPONSE:

			<?xml version="1.0" encoding="UTF-8"?>
			<apiResponse status="[status text]" statusCode="[status code]">
			<messages>
				<message id="[MT message ID]"/>
			</messages>
			</apiResponse>


EXAMPLE USAGE:


REQUEST:

		<?xml version="1.0" encoding="UTF-8"?>
		<apiRequest token="P5Yyxyr5TiJ4F_MmdQ4E0S8BsIJD5e4usM8GWNZVmYoUdeax">
			<SendMessage accountId="100982">
				<msidns>
					<msidn terms="true">1235551234</msidn>
					<msidn terms="true">5551235555</msidn>
				</msidns>
				<shortcode>28444</shortcode>
				<message><![CDATA[Test the phone!]]></message>
				<schedule>2009-08-23 14:51:00 US/Pacific</schedule>
			</SendMessage>
		</apiRequest>

RESPONSE:

			<?xml version="1.0" encoding="UTF-8"?>
			<apiResponse status="OK" statusCode="200">
			<messages>
				<message id="7525777"/>
			</messages>
			</apiResponse>