Facebook

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Facebook wall.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegFacebook/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Facebook pseudonym or alias.
appName Your Facebook App's name which will post your messages
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Facebook and grant application's permission to post messages in a Facebook user's wall.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Facebook if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlFacebook/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Facebook App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Facebook Wall. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Facebook wall.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegFacebook/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Facebook pseudonym or alias.
appName Your Facebook App's name which will post your messages
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Facebook and grant application's permission to post messages in a Facebook user's wall.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Facebook if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlFacebook/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Facebook App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Facebook Wall. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Facebook wall.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegFacebook/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Facebook pseudonym or alias.
appName Your Facebook App's name which will post your messages
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Facebook and grant application's permission to post messages in a Facebook user's wall.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Facebook if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlFacebook/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Facebook App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Facebook after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlFacebook</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://www.facebook.com/dialog/oauth?...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Facebook Wall. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Twitter

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Timeline.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegTwitter/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Twitter pseudonym or alias.
appName Your Twitter App's name which will post your messages
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Twitter and grant application's permission to post messages in your Twitter's Timeline.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Twitter if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlTwitter/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Twitter App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Timeline.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegTwitter/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Twitter pseudonym or alias.
appName Your Twitter App's name which will post your messages
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Twitter and grant application's permission to post messages in your Twitter's Timeline.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Twitter if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlTwitter/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Twitter App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request (with registration)

Overview

Use this method to register your application with the Campaign Manager it will return the URL that you need to grant the application permissions to post your message in your Timeline.

This method is very convenient if the user wants to remain registered for future publications.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlRegTwitter/{instanceId}/{deviceId}/{appName}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
deviceid The user's identifier. In this particular case will be the Twitter pseudonym or alias.
appName Your Twitter App's name which will post your messages
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlRegTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Authentication Request and Message Post (without registration)

Overview

Use this method to authenticate against Twitter and grant application's permission to post messages in your Twitter's Timeline.

This method is convenient if you don't want to save login user data, just keep in mind that you always will be forced to perform login with Twitter if you use this method multiple times.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/authUrlTwitter/{instanceId}/{appName}/{msgContent}/{redirectURL}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName Your Twitter App's name which will post your messages
msgContent The message you want to post. This parameter must be Base64 encoded.
redirectURL The URL that users will be redirected to from Twitter after registration finished. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>authUrlTwitter</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>
			https://api.twitter.com/oauth/authenticate?oauth_token=...
		</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message Contains the URL where the user carries out the corresponding login process. It also allows the application to post messages to the Twitter Timeline. Once the user finishes this process, he will have the option to return to the Web the Client has configured before. Text

Request Device Location

Overview

You can request the location for a particular device by using this method, the Campaign Manager will request the current location from the device using a special PUSH message, when the device's location arrive it will deliver the information through your Callback URL.

Please note that this method is just a request, which means that you have to be ready at your end to handle the location information when it arises.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName
OPTIONAL
Your App's name which will receive your Push Notifications
Write null on this placeholder to ignore this parameter
platform
OPTIONAL
The target platform for the push service.
Valid values are: ANDROID, IOS or null to ignore
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<LocationRequest>
		<requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
		<user>13056708084</user>
		<requestType>LOCATION</requestType>
		<latitude>0.0</latitude>
		<longitude>0.0</longitude>
		<status>PENDING</status>
		<clientId>uTJoDFuabB6YFvc9s43</clientId>
		<appName>AppName</appName>
		<platform>IOS</platform>
		<date>2014-03-17T17:26:23.133-04:30</date>
	</LocationRequest>
</result>

Please be aware that the <LocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
LocationRequest.requestId This is your request identifier Text
LocationRequest.user The deviceId or mobile phone number Text
LocationRequest.requestType The request's type. In this case: LOCATION
LocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
LocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
LocationRequest.status This is the general status for the operation Starting value: PENDING
LocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
LocationRequest.appName The identifier of the application, which will receive the push message. Text
LocationRequest.platform The target platform used Valid values:
ANDROID
IOS
LocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Checking Device Location by Coordinates

Overview

Verify if a particular device is inside a region at this moment.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/checkLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{latitude}/{longitude}/{radius}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName Your App's name which will receive your Push Notifications
platform The target platform for the push service.
Valid values are: ANDROID or IOS
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>checkLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<checkLocationRequest>
	        <requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
        	<user>584241111111</user>
	        <requestType>LOCATION</requestType>
        	<latitude>0.0</latitude>
	        <longitude>0.0</longitude>
        	<status>PENDING</status>
	        <clientId>uTJoDFuabB6YFvc9s43</clientId>
        	<appName>AppName</appName>
	        <platform>IOS</platform>
        	<date>2014-03-17T17:26:23.133-04:30</date>
	        <poiLatitude>8.630554</poiLatitude>
        	<poiLongitude>71.13327</poiLongitude>
	        <poiRadius>3000.0</poiRadius>
        	<poiName></poiName>
	</checkLocationRequest>
</result>

Please be aware that the <checkLocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
checkLocationRequest.requestId This is your request identifier Text
checkLocationRequest.user The deviceId or mobile phone number Text
checkLocationRequest.requestType The request's type. In this case: CHK_LOCATION
checkLocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
checkLocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
checkLocationRequest.status This is the general status for the operation Starting value: PENDING
checkLocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
checkLocationRequest.appName The identifier of the application, which will receive the push message. Text
checkLocationRequest.platform The target platform used Valid values:
ANDROID
IOS
checkLocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
checkLocationRequest.poiLatitude The point of interest's latitude Number (decimal notation)
checkLocationRequest.poiLongitude The point of interest's longitude Number (decimal notation)
checkLocationRequest.poiRadius The radius of the point of interest Number (meters)
checkLocationRequest.poiName The point of interest's name. Text

Create Geo-Fence

Overview

Create a geographical fence (represented as a circle) that will be watched. This fence is capable to detect when App's users pass through it in any direction.

If this happened you will be notified about this through your Callback URL.

This function send a push notification to every device registered into your app so they can save the geo-fence in their platform's device (Android or iOS).

Be aware that every platform has their conditions. For example, iOS limits the number of regions that may be simultaneously monitored by a single app to twenty.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createGeoFence/{instanceId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Notify Region Event

Overview

Use this method from the mobile App (if you are developing yours) when a Geo-Fence event occurs. Once the Campaign Manager get the notification it will pass it to the client through the Callback URL.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/notifyRegionEvent/{instanceId}/{regionId}/{deviceId}/{status}/{date}/{latitude}/{longitude}/{regionType}/{appName}/{platform}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
deviceId The if of the device running device
status The status for this event, entering or leaving Possible values: ENTER | EXIT
date The time & date when the event occurs. formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference
latitude The coordinate's latitude of the device's location when the event happened Number (decimal notation)
longitude The coordinate's longitude of the device's location when the event happened Number (decimal notation)
regionType The type of the region that triggers the event Possible values: geofence | beacon
appName The App's name which will receive your Push Notifications
platform The target platform for the push service. Valid values are: ANDROID | IOS
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>notifyRegionEvent</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the notification was posted or not true
false
message A human readable explanation Text

Remove Geo-Fence

Overview

Remove an existing Geo-Fence.

This function send a special push message to every device registered with your App so it can delete the Geo-Fence on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeGeoFence/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region deleted</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieving Geo-Fence

Overview

This method will list all client's Geo-Fences.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieving Geo-Fence (with pagination & filters)

Overview

This method will list all client's Geo-Fences. You can filter and paginate your results.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page A numeric indicator to fetch a specific page. useful when you are dealing with a large bunch of data and you want to iterate over it
resultsPerPage How many items will show per fetch.
parameters Use this as search's filters. Please learn more about this by reading the Geo-Fence Inline Search String Write null on this placeholder if you don't want to use search filters
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieve Geo-Fence by ID

Overview

Given a Geo-Fence's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFenceById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the Geo-Fence to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFenceById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Update Geo-Fence

Overview

Once you have created your Geo-Fence you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this modification by sending a special push message

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editGeoFence/{instanceId}/{regionId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The region's id you want to update
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude
OPTIONAL
The point latitude Number (decimal notation)
longitude
OPTIONAL
The point longitude Number (decimal notation)
radius
OPTIONAL
The circle radius. Use meters for this value
eventType
OPTIONAL
The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Request Device Location

Overview

You can request the location for a particular device by using this method, the Campaign Manager will request the current location from the device using a special PUSH message, when the device's location arrive it will deliver the information through your Callback URL.

Please note that this method is just a request, which means that you have to be ready at your end to handle the location information when it arises.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName
OPTIONAL
Your App's name which will receive your Push Notifications
Write null on this placeholder to ignore this parameter
platform
OPTIONAL
The target platform for the push service.
Valid values are: ANDROID, IOS or null to ignore
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<LocationRequest>
		<requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
		<user>13056708084</user>
		<requestType>LOCATION</requestType>
		<latitude>0.0</latitude>
		<longitude>0.0</longitude>
		<status>PENDING</status>
		<clientId>uTJoDFuabB6YFvc9s43</clientId>
		<appName>AppName</appName>
		<platform>IOS</platform>
		<date>2014-03-17T17:26:23.133-04:30</date>
	</LocationRequest>
</result>

Please be aware that the <LocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
LocationRequest.requestId This is your request identifier Text
LocationRequest.user The deviceId or mobile phone number Text
LocationRequest.requestType The request's type. In this case: LOCATION
LocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
LocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
LocationRequest.status This is the general status for the operation Starting value: PENDING
LocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
LocationRequest.appName The identifier of the application, which will receive the push message. Text
LocationRequest.platform The target platform used Valid values:
ANDROID
IOS
LocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Request Device Location

Overview

You can request the location for a particular device by using this method, the Campaign Manager will request the current location from the device using a special PUSH message, when the device's location arrive it will deliver the information through your Callback URL.

Please note that this method is just a request, which means that you have to be ready at your end to handle the location information when it arises.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName
OPTIONAL
Your App's name which will receive your Push Notifications
Write null on this placeholder to ignore this parameter
platform
OPTIONAL
The target platform for the push service.
Valid values are: ANDROID, IOS or null to ignore
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<LocationRequest>
		<requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
		<user>13056708084</user>
		<requestType>LOCATION</requestType>
		<latitude>0.0</latitude>
		<longitude>0.0</longitude>
		<status>PENDING</status>
		<clientId>uTJoDFuabB6YFvc9s43</clientId>
		<appName>AppName</appName>
		<platform>IOS</platform>
		<date>2014-03-17T17:26:23.133-04:30</date>
	</LocationRequest>
</result>

Please be aware that the <LocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
LocationRequest.requestId This is your request identifier Text
LocationRequest.user The deviceId or mobile phone number Text
LocationRequest.requestType The request's type. In this case: LOCATION
LocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
LocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
LocationRequest.status This is the general status for the operation Starting value: PENDING
LocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
LocationRequest.appName The identifier of the application, which will receive the push message. Text
LocationRequest.platform The target platform used Valid values:
ANDROID
IOS
LocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Checking Device Location by Coordinates

Overview

Verify if a particular device is inside a region at this moment.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/checkLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{latitude}/{longitude}/{radius}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName Your App's name which will receive your Push Notifications
platform The target platform for the push service.
Valid values are: ANDROID or IOS
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>checkLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<checkLocationRequest>
	        <requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
        	<user>584241111111</user>
	        <requestType>LOCATION</requestType>
        	<latitude>0.0</latitude>
	        <longitude>0.0</longitude>
        	<status>PENDING</status>
	        <clientId>uTJoDFuabB6YFvc9s43</clientId>
        	<appName>AppName</appName>
	        <platform>IOS</platform>
        	<date>2014-03-17T17:26:23.133-04:30</date>
	        <poiLatitude>8.630554</poiLatitude>
        	<poiLongitude>71.13327</poiLongitude>
	        <poiRadius>3000.0</poiRadius>
        	<poiName></poiName>
	</checkLocationRequest>
</result>

Please be aware that the <checkLocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
checkLocationRequest.requestId This is your request identifier Text
checkLocationRequest.user The deviceId or mobile phone number Text
checkLocationRequest.requestType The request's type. In this case: CHK_LOCATION
checkLocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
checkLocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
checkLocationRequest.status This is the general status for the operation Starting value: PENDING
checkLocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
checkLocationRequest.appName The identifier of the application, which will receive the push message. Text
checkLocationRequest.platform The target platform used Valid values:
ANDROID
IOS
checkLocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
checkLocationRequest.poiLatitude The point of interest's latitude Number (decimal notation)
checkLocationRequest.poiLongitude The point of interest's longitude Number (decimal notation)
checkLocationRequest.poiRadius The radius of the point of interest Number (meters)
checkLocationRequest.poiName The point of interest's name. Text

Create Geo-Fence

Overview

Create a geographical fence (represented as a circle) that will be watched. This fence is capable to detect when App's users pass through it in any direction.

If this happened you will be notified about this through your Callback URL.

This function send a push notification to every device registered into your app so they can save the geo-fence in their platform's device (Android or iOS).

Be aware that every platform has their conditions. For example, iOS limits the number of regions that may be simultaneously monitored by a single app to twenty.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createGeoFence/{instanceId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Notify Region Event

Overview

Use this method from the mobile App (if you are developing yours) when a Geo-Fence event occurs. Once the Campaign Manager get the notification it will pass it to the client through the Callback URL.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/notifyRegionEvent/{instanceId}/{regionId}/{deviceId}/{status}/{date}/{latitude}/{longitude}/{regionType}/{appName}/{platform}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
deviceId The if of the device running device
status The status for this event, entering or leaving Possible values: ENTER | EXIT
date The time & date when the event occurs. formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference
latitude The coordinate's latitude of the device's location when the event happened Number (decimal notation)
longitude The coordinate's longitude of the device's location when the event happened Number (decimal notation)
regionType The type of the region that triggers the event Possible values: geofence | beacon
appName The App's name which will receive your Push Notifications
platform The target platform for the push service. Valid values are: ANDROID | IOS
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>notifyRegionEvent</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the notification was posted or not true
false
message A human readable explanation Text

Remove Geo-Fence

Overview

Remove an existing Geo-Fence.

This function send a special push message to every device registered with your App so it can delete the Geo-Fence on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeGeoFence/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region deleted</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieving Geo-Fence

Overview

This method will list all client's Geo-Fences.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieving Geo-Fence (with pagination & filters)

Overview

This method will list all client's Geo-Fences. You can filter and paginate your results.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page A numeric indicator to fetch a specific page. useful when you are dealing with a large bunch of data and you want to iterate over it
resultsPerPage How many items will show per fetch.
parameters Use this as search's filters. Please learn more about this by reading the Geo-Fence Inline Search String Write null on this placeholder if you don't want to use search filters
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieve Geo-Fence by ID

Overview

Given a Geo-Fence's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFenceById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the Geo-Fence to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFenceById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Update Geo-Fence

Overview

Once you have created your Geo-Fence you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this modification by sending a special push message

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editGeoFence/{instanceId}/{regionId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The region's id you want to update
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude
OPTIONAL
The point latitude Number (decimal notation)
longitude
OPTIONAL
The point longitude Number (decimal notation)
radius
OPTIONAL
The circle radius. Use meters for this value
eventType
OPTIONAL
The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Checking Device Location by Coordinates

Overview

Verify if a particular device is inside a region at this moment.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/checkLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{latitude}/{longitude}/{radius}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName Your App's name which will receive your Push Notifications
platform The target platform for the push service.
Valid values are: ANDROID or IOS
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>checkLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<checkLocationRequest>
	        <requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
        	<user>584241111111</user>
	        <requestType>LOCATION</requestType>
        	<latitude>0.0</latitude>
	        <longitude>0.0</longitude>
        	<status>PENDING</status>
	        <clientId>uTJoDFuabB6YFvc9s43</clientId>
        	<appName>AppName</appName>
	        <platform>IOS</platform>
        	<date>2014-03-17T17:26:23.133-04:30</date>
	        <poiLatitude>8.630554</poiLatitude>
        	<poiLongitude>71.13327</poiLongitude>
	        <poiRadius>3000.0</poiRadius>
        	<poiName></poiName>
	</checkLocationRequest>
</result>

Please be aware that the <checkLocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
checkLocationRequest.requestId This is your request identifier Text
checkLocationRequest.user The deviceId or mobile phone number Text
checkLocationRequest.requestType The request's type. In this case: CHK_LOCATION
checkLocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
checkLocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
checkLocationRequest.status This is the general status for the operation Starting value: PENDING
checkLocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
checkLocationRequest.appName The identifier of the application, which will receive the push message. Text
checkLocationRequest.platform The target platform used Valid values:
ANDROID
IOS
checkLocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
checkLocationRequest.poiLatitude The point of interest's latitude Number (decimal notation)
checkLocationRequest.poiLongitude The point of interest's longitude Number (decimal notation)
checkLocationRequest.poiRadius The radius of the point of interest Number (meters)
checkLocationRequest.poiName The point of interest's name. Text

Create Geo-Fence

Overview

Create a geographical fence (represented as a circle) that will be watched. This fence is capable to detect when App's users pass through it in any direction.

If this happened you will be notified about this through your Callback URL.

This function send a push notification to every device registered into your app so they can save the geo-fence in their platform's device (Android or iOS).

Be aware that every platform has their conditions. For example, iOS limits the number of regions that may be simultaneously monitored by a single app to twenty.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createGeoFence/{instanceId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Notify Region Event

Overview

Use this method from the mobile App (if you are developing yours) when a Geo-Fence event occurs. Once the Campaign Manager get the notification it will pass it to the client through the Callback URL.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/notifyRegionEvent/{instanceId}/{regionId}/{deviceId}/{status}/{date}/{latitude}/{longitude}/{regionType}/{appName}/{platform}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
deviceId The if of the device running device
status The status for this event, entering or leaving Possible values: ENTER | EXIT
date The time & date when the event occurs. formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference
latitude The coordinate's latitude of the device's location when the event happened Number (decimal notation)
longitude The coordinate's longitude of the device's location when the event happened Number (decimal notation)
regionType The type of the region that triggers the event Possible values: geofence | beacon
appName The App's name which will receive your Push Notifications
platform The target platform for the push service. Valid values are: ANDROID | IOS
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>notifyRegionEvent</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the notification was posted or not true
false
message A human readable explanation Text

Remove Geo-Fence

Overview

Remove an existing Geo-Fence.

This function send a special push message to every device registered with your App so it can delete the Geo-Fence on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeGeoFence/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region deleted</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieving Geo-Fence

Overview

This method will list all client's Geo-Fences.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Request Device Location

Overview

You can request the location for a particular device by using this method, the Campaign Manager will request the current location from the device using a special PUSH message, when the device's location arrive it will deliver the information through your Callback URL.

Please note that this method is just a request, which means that you have to be ready at your end to handle the location information when it arises.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName
OPTIONAL
Your App's name which will receive your Push Notifications
Write null on this placeholder to ignore this parameter
platform
OPTIONAL
The target platform for the push service.
Valid values are: ANDROID, IOS or null to ignore
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<LocationRequest>
		<requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
		<user>13056708084</user>
		<requestType>LOCATION</requestType>
		<latitude>0.0</latitude>
		<longitude>0.0</longitude>
		<status>PENDING</status>
		<clientId>uTJoDFuabB6YFvc9s43</clientId>
		<appName>AppName</appName>
		<platform>IOS</platform>
		<date>2014-03-17T17:26:23.133-04:30</date>
	</LocationRequest>
</result>

Please be aware that the <LocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
LocationRequest.requestId This is your request identifier Text
LocationRequest.user The deviceId or mobile phone number Text
LocationRequest.requestType The request's type. In this case: LOCATION
LocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
LocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
LocationRequest.status This is the general status for the operation Starting value: PENDING
LocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
LocationRequest.appName The identifier of the application, which will receive the push message. Text
LocationRequest.platform The target platform used Valid values:
ANDROID
IOS
LocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Checking Device Location by Coordinates

Overview

Verify if a particular device is inside a region at this moment.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/checkLocation/{instanceId}/{to}/{appName}/{platform}/{from}/{carrier}/{latitude}/{longitude}/{radius}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to This is the device's mobile phone number
appName Your App's name which will receive your Push Notifications
platform The target platform for the push service.
Valid values are: ANDROID or IOS
from
OPTIONAL
The short or long code that will originate the SMS if needed
Write null on this placeholder to ignore this parameter
carrier
OPTIONAL
The carrier operator used to fire the SMS if needed
Write null on this placeholder to ignore this parameter
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Please note that all OPTIONAL parameter are linked, which means that you have to choose between use them all or ignore them all together.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>checkLocation</input>
<status>OK</status>
<description>Completed</description>
<result>
	<checkLocationRequest>
	        <requestId>3d97e8ca-fcc9-4f15-8c22-8cbf123c723f</requestId>
        	<user>584241111111</user>
	        <requestType>LOCATION</requestType>
        	<latitude>0.0</latitude>
	        <longitude>0.0</longitude>
        	<status>PENDING</status>
	        <clientId>uTJoDFuabB6YFvc9s43</clientId>
        	<appName>AppName</appName>
	        <platform>IOS</platform>
        	<date>2014-03-17T17:26:23.133-04:30</date>
	        <poiLatitude>8.630554</poiLatitude>
        	<poiLongitude>71.13327</poiLongitude>
	        <poiRadius>3000.0</poiRadius>
        	<poiName></poiName>
	</checkLocationRequest>
</result>

Please be aware that the <checkLocationRequest> tag and its content is a generic object and may apply to other responses in other methods.

As this is an asynchronous method this will not contains the actual device's information, you will be receiving an update through your Callback URL

Result parameters
Parameter Name Description Possible Values
checkLocationRequest.requestId This is your request identifier Text
checkLocationRequest.user The deviceId or mobile phone number Text
checkLocationRequest.requestType The request's type. In this case: CHK_LOCATION
checkLocationRequest.latitude The device's latitude. Number (decimal notation) Starting value: 0.0
checkLocationRequest.longitude The device's longitude. Number (decimal notation) Starting value: 0.0)
checkLocationRequest.status This is the general status for the operation Starting value: PENDING
checkLocationRequest.clientId This is your unique id, it represents you on the Campaign Manager Platform Text
checkLocationRequest.appName The identifier of the application, which will receive the push message. Text
checkLocationRequest.platform The target platform used Valid values:
ANDROID
IOS
checkLocationRequest.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
checkLocationRequest.poiLatitude The point of interest's latitude Number (decimal notation)
checkLocationRequest.poiLongitude The point of interest's longitude Number (decimal notation)
checkLocationRequest.poiRadius The radius of the point of interest Number (meters)
checkLocationRequest.poiName The point of interest's name. Text

Create Geo-Fence

Overview

Create a geographical fence (represented as a circle) that will be watched. This fence is capable to detect when App's users pass through it in any direction.

If this happened you will be notified about this through your Callback URL.

This function send a push notification to every device registered into your app so they can save the geo-fence in their platform's device (Android or iOS).

Be aware that every platform has their conditions. For example, iOS limits the number of regions that may be simultaneously monitored by a single app to twenty.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createGeoFence/{instanceId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude The point latitude Number (decimal notation)
longitude The point longitude Number (decimal notation)
radius The circle radius. Use meters for this value
eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Notify Region Event

Overview

Use this method from the mobile App (if you are developing yours) when a Geo-Fence event occurs. Once the Campaign Manager get the notification it will pass it to the client through the Callback URL.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/notifyRegionEvent/{instanceId}/{regionId}/{deviceId}/{status}/{date}/{latitude}/{longitude}/{regionType}/{appName}/{platform}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
deviceId The if of the device running device
status The status for this event, entering or leaving Possible values: ENTER | EXIT
date The time & date when the event occurs. formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference
latitude The coordinate's latitude of the device's location when the event happened Number (decimal notation)
longitude The coordinate's longitude of the device's location when the event happened Number (decimal notation)
regionType The type of the region that triggers the event Possible values: geofence | beacon
appName The App's name which will receive your Push Notifications
platform The target platform for the push service. Valid values are: ANDROID | IOS
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>notifyRegionEvent</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the notification was posted or not true
false
message A human readable explanation Text

Remove Geo-Fence

Overview

Remove an existing Geo-Fence.

This function send a special push message to every device registered with your App so it can delete the Geo-Fence on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeGeoFence/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region deleted</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieving Geo-Fence

Overview

This method will list all client's Geo-Fences.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieving Geo-Fence (with pagination & filters)

Overview

This method will list all client's Geo-Fences. You can filter and paginate your results.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFences/{instanceId}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page A numeric indicator to fetch a specific page. useful when you are dealing with a large bunch of data and you want to iterate over it
resultsPerPage How many items will show per fetch.
parameters Use this as search's filters. Please learn more about this by reading the Geo-Fence Inline Search String Write null on this placeholder if you don't want to use search filters
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFences</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFences>
		<GeoFence>
		        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        		<name>test</name>
		        <latitude>8.620554</latitude>
        		<longitude>-71.13317</longitude>
	        	<radius>3000.0</radius>
	        	<type>geoFence</type>
		        <eventType>ENTER-EXIT</eventType>
        		</msgTitle>
		        </msgContent>
        		</rules>
	        	<appName>AppTest</appName>
	        	<timezone>America/Caracas</timezone>
		        <update>2014-03-20T17:55:16.621-04:30</update>
		</GeoFence>
 
		...
 
		<GeoFence>
		        <regionId>8js7ah23-lolk-mkajhsud02uq</regionId>
        		<name>folks</name>
	        	<latitude>82.620554</latitude>
	        	<longitude>11.13317</longitude>
		        <radius>3000.0</radius>
        		<type>geoFence</type>
		        <eventType>ENTER</eventType>
        		</msgTitle>
	        	</msgContent>
	        	</rules>
		        <appName>AppTest</appName>
        		<timezone>America/Caracas</timezone>
		        <update>2014-02-02T07:15:14.131-04:30</update>
		</GeoFence>
	</GeoFences>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieve Geo-Fence by ID

Overview

Given a Geo-Fence's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFenceById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the Geo-Fence to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFenceById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Update Geo-Fence

Overview

Once you have created your Geo-Fence you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this modification by sending a special push message

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editGeoFence/{instanceId}/{regionId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The region's id you want to update
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude
OPTIONAL
The point latitude Number (decimal notation)
longitude
OPTIONAL
The point longitude Number (decimal notation)
radius
OPTIONAL
The circle radius. Use meters for this value
eventType
OPTIONAL
The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Retrieve Geo-Fence by ID

Overview

Given a Geo-Fence's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getGeoFenceById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the Geo-Fence to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getGeoFenceById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Update Geo-Fence

Overview

Once you have created your Geo-Fence you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this modification by sending a special push message

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editGeoFence/{instanceId}/{regionId}/{name}/{latitude}/{longitude}/{radius}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The region's id you want to update
name The name identifier for this Geo-Fence. This parameter must be Base64 encoded. You can't exceed 80 characters
latitude
OPTIONAL
The point latitude Number (decimal notation)
longitude
OPTIONAL
The point longitude Number (decimal notation)
radius
OPTIONAL
The circle radius. Use meters for this value
eventType
OPTIONAL
The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters. Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters. Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editGeoFence</input>
<status>OK</status>
<description>Completed</description>
<result>
	<GeoFence>
	        <regionId>ef0d1fb5-c7cb-5db2e87f273d</regionId>
        	<name>test</name>
	        <latitude>8.620554</latitude>
        	<longitude>-71.13317</longitude>
	        <radius>3000.0</radius>
        	<type>geoFence</type>
	        <eventType>ENTER-EXIT</eventType>
        	</msgTitle>
	        </msgContent>
        	</rules>
	        <appName>AppTest</appName>
        	<timezone>America/Caracas</timezone>
	        <update>2014-03-20T17:55:16.621-04:30</update>
	</GeoFence>
</result>
Result parameters
Parameter Name Description Possible Values
GeoFence.regionId Region's unique identifier Text
GeoFence.name Geo-Fence's name Text
GeoFence.latitude Region's latitude point. Number (decimal notation) Starting value: 0.0
GeoFence.longitude Region's longitude point. Number (decimal notation) Starting value: 0.0)
GeoFence.radius Region's radius Number (meters)
GeoFence.type Campaign type, always GEOFENCE for this method Text
GeoFence.eventType The type of event that triggers the geo-fence. Valid values are: ENTER | EXIT | ENTER-EXIT
GeoFence.msgTitle The title of this message. Text
GeoFence.msgContent The content of the message per se. Text
GeoFence.rules The RULE defined at the creation time Text
GeoFence.appName The identifier of the application, who will monitor the region. Text
GeoFence.timezone Timezone used Text
GeoFence.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Create Beacon

Overview

A Beacon it's a small device that constantly will be broadcasting some information to its surroundings (indoor use, low distant range) using Bluetooth. This method allows you to attach your information to a specific beacon, so users that enter in the beacon's range will receive the desired information.

Beacons have caused a great impact on markets and department stores. You can learn more about Bluetooth and Beacons here.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createBeacon/{instanceId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
uuid Beacon's UUID value. This value comes with the device
major Beacon's MAJOR VERSION value. This value comes with the device
minor Beacon's MINOR VERSION value. This value comes with the device
manufacturer Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values
distance User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR
eventType The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Remove Beacon

Overview

This function will delete a registered beacon region.

This function send a special push message to every device registered with your App so it can delete the Beacon on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeBeacon/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region removed</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Create Beacon

Overview

A Beacon it's a small device that constantly will be broadcasting some information to its surroundings (indoor use, low distant range) using Bluetooth. This method allows you to attach your information to a specific beacon, so users that enter in the beacon's range will receive the desired information.

Beacons have caused a great impact on markets and department stores. You can learn more about Bluetooth and Beacons here.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createBeacon/{instanceId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
uuid Beacon's UUID value. This value comes with the device
major Beacon's MAJOR VERSION value. This value comes with the device
minor Beacon's MINOR VERSION value. This value comes with the device
manufacturer Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values
distance User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR
eventType The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Remove Beacon

Overview

This function will delete a registered beacon region.

This function send a special push message to every device registered with your App so it can delete the Beacon on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeBeacon/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region removed</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieve Beacon

Overview

This method will list all client's Beacons.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getBeacons/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBeacons</input>
<status>OK</status>
<description>Completed</description>
<result>
	<BeaconRegions>
		<Beacon>
			<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
			<name>BeaconTest</name>
			<type>BEACON</type>
			<eventType>ENTER</eventType>
			<msgTitle>Beacon subject</msgTitle>
			<msgContent>Beacon text</msgContent>
			<appName>OgangiTest</appName>
			<timezone>America/Caracas</timezone>
			<update>2014-06-08T23:46:12.805-04:30</update>
			<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
			<major>8888</major>
			<minor>3333</minor>
			<manufacturer>ESTIMOTE</manufacturer>
			<distance>NEAR</distance>
		<Beacon>
 
		...
 
		<Beacon>
			<regionId>8s37da21-lof3-8a9d-01nf-kai23laod9000</regionId>
			<name>BeaconTest2</name>
			<type>BEACON</type>
			<eventType>ENTER</eventType>
			<msgTitle>Beacon subject2</msgTitle>
			<msgContent>Beacon text2</msgContent>
			<appName>OgangiTest</appName>
			<timezone>America/Caracas</timezone>
			<update>2014-04-08T13:49:11.304-04:30</update>
			<uuid>9KIJ82HD-8SD7-01LD-JAUW-01JDLAO98E9S</uuid>
			<major>8888</major>
			<minor>3333</minor>
			<manufacturer>ESTIMOTE</manufacturer>
			<distance>NEAR</distance>
		<Beacon>
	</BeaconRegions>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Retrieve Beacon by Id

Overview

Given a Beacon's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getBeaconById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's identifier to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBeaconById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Update Beacon

Overview

Once you have created a Beacon you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this update by sending a special push message.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editBeacon/{instanceId}/{regionId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's id you want to update
name
OPTIONAL
The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
Write null to ignore this placeholder
uuid
OPTIONAL
Beacon's UUID value. This value comes with the device.
Write null to ignore this placeholder
major
OPTIONAL
Beacon's MAJOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
minor
OPTIONAL
Beacon's MINOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
manufacturer
OPTIONAL
Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values.
Write null to ignore this placeholder
distance
OPTIONAL
User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR or null to ignore this placeholder
eventType
OPTIONAL
The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT or null to ignore this placeholder
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore this placeholder
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore this placeholder
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore this placeholder
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Retrieve IP Address Info

Overview

This handy method provides the geographical information from an IP address.

We keep our internal database synced to the geographical information provided by ip2location.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getIPAddressInfo/{instanceId}/{ip}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
ip The IP address to query
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getIPAddressInfo</input>
<status>OK</status>
<description>Completed</description>
<result>
	<ipAddressInfo>
		<isoCountryCode>US</isoCountryCode>
		<regionCode>VA</regionCode>FINISHED>
		<regionName>Virginia</regionName>
		<city>Falls Church</city>
		<zipCode>22042</zipCode>
		<latitude>38.863998</latitude>
		<longitude>-77.192200</longitude>
		<metroCode>511</metroCode>
		<areaCode>703</areaCode>
	</ipAddressInfo>
</result>
Result parameters
Parameter Name Description Possible Values
isoCountryCode The two-character ISO 3166-1 standard for country code A ISO 3166 String
regionCode The principal geographical subdivision code according the ISO 3166-1 standard A ISO 3166 String
regionName Name of the providence or state. Text
city The city name for the location associated with the IP address. Text
zipCode Zip Code for the location associated with the IP address. Text
latitude Latitudinal coordinates corresponding to the location . Number (decimal notation)
longitude Longitudinal coordinates corresponding to the location. Number (decimal notation)
metroCode Is the Designated Market Area (DMA) region code associated with the IP address. These are only available for networks in the US. Text
Only available in the United States
areaCode Is the telephone area code associated with the IP address. This output is deprecated, and may not reflect newer area codes. Text
Only available in the United States

Retrieve Beacon by Id

Overview

Given a Beacon's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getBeaconById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's identifier to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBeaconById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Update Beacon

Overview

Once you have created a Beacon you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this update by sending a special push message.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editBeacon/{instanceId}/{regionId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's id you want to update
name
OPTIONAL
The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
Write null to ignore this placeholder
uuid
OPTIONAL
Beacon's UUID value. This value comes with the device.
Write null to ignore this placeholder
major
OPTIONAL
Beacon's MAJOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
minor
OPTIONAL
Beacon's MINOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
manufacturer
OPTIONAL
Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values.
Write null to ignore this placeholder
distance
OPTIONAL
User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR or null to ignore this placeholder
eventType
OPTIONAL
The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT or null to ignore this placeholder
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore this placeholder
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore this placeholder
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore this placeholder
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Create Beacon

Overview

A Beacon it's a small device that constantly will be broadcasting some information to its surroundings (indoor use, low distant range) using Bluetooth. This method allows you to attach your information to a specific beacon, so users that enter in the beacon's range will receive the desired information.

Beacons have caused a great impact on markets and department stores. You can learn more about Bluetooth and Beacons here.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/createBeacon/{instanceId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
uuid Beacon's UUID value. This value comes with the device
major Beacon's MAJOR VERSION value. This value comes with the device
minor Beacon's MINOR VERSION value. This value comes with the device
manufacturer Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values
distance User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR
eventType The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore
appName Your App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Remove Beacon

Overview

This function will delete a registered beacon region.

This function send a special push message to every device registered with your App so it can delete the Beacon on the device's platform.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeBeacon/{instanceId}/{regionId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The identifier of the region that trigger the event.
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Region removed</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the region was deleted or not true
false
message A human readable explanation Text

Retrieve Beacon

Overview

This method will list all client's Beacons.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getBeacons/{instanceId}/{appName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName The App's name which will receive your Push Notifications
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBeacons</input>
<status>OK</status>
<description>Completed</description>
<result>
	<BeaconRegions>
		<Beacon>
			<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
			<name>BeaconTest</name>
			<type>BEACON</type>
			<eventType>ENTER</eventType>
			<msgTitle>Beacon subject</msgTitle>
			<msgContent>Beacon text</msgContent>
			<appName>OgangiTest</appName>
			<timezone>America/Caracas</timezone>
			<update>2014-06-08T23:46:12.805-04:30</update>
			<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
			<major>8888</major>
			<minor>3333</minor>
			<manufacturer>ESTIMOTE</manufacturer>
			<distance>NEAR</distance>
		<Beacon>
 
		...
 
		<Beacon>
			<regionId>8s37da21-lof3-8a9d-01nf-kai23laod9000</regionId>
			<name>BeaconTest2</name>
			<type>BEACON</type>
			<eventType>ENTER</eventType>
			<msgTitle>Beacon subject2</msgTitle>
			<msgContent>Beacon text2</msgContent>
			<appName>OgangiTest</appName>
			<timezone>America/Caracas</timezone>
			<update>2014-04-08T13:49:11.304-04:30</update>
			<uuid>9KIJ82HD-8SD7-01LD-JAUW-01JDLAO98E9S</uuid>
			<major>8888</major>
			<minor>3333</minor>
			<manufacturer>ESTIMOTE</manufacturer>
			<distance>NEAR</distance>
		<Beacon>
	</BeaconRegions>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Retrieve Beacon by Id

Overview

Given a Beacon's Id retrieve the information about it

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getBeaconById/{instanceId}/{regionId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's identifier to look for
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBeaconById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Update Beacon

Overview

Once you have created a Beacon you could use this method to edit it and keeping it updated.

The Campaign Manager will notify all devices about this update by sending a special push message.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/editBeacon/{instanceId}/{regionId}/{name}/{uuid}/{major}/{minor}/{manufacturer}/{distance}/{eventType}/{msgTitle}/{msgContent}/{rules}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
regionId The Beacon's id you want to update
name
OPTIONAL
The desired beacon's name. This parameter must be Base64 encoded. You can't exceed 80 characters
Write null to ignore this placeholder
uuid
OPTIONAL
Beacon's UUID value. This value comes with the device.
Write null to ignore this placeholder
major
OPTIONAL
Beacon's MAJOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
minor
OPTIONAL
Beacon's MINOR VERSION value. This value comes with the device.
Write null to ignore this placeholder
manufacturer
OPTIONAL
Beacon's Manufacturer. Each manufacturer could provide a proprietary mechanism to modify UUID, Major & Minor values.
Write null to ignore this placeholder
distance
OPTIONAL
User's distance to the beacon needed to trigger the event. Valid values are: INMEDIATE | NEAR | FAR or null to ignore this placeholder
eventType
OPTIONAL
The type of event that triggers the Beacon. Valid values are: ENTER | EXIT | ENTER-EXIT or null to ignore this placeholder
msgTitle
OPTIONAL
A title for this message. This parameter must be Base64 encoded. You can't exceed 80 characters.
Write null to ignore this placeholder
msgContent
OPTIONAL
The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters.
Write null to ignore this placeholder
rules
OPTIONAL
Powerful mechanism of rules. For more information please read the RULE parameter appendix
Write null to ignore this placeholder
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>editBeacon</input>
<status>OK</status>
<description>Completed</description>
<result>
	<Beacon>
		<regionId>e4f1f80f-eb8f-4b05-a40a-803f2f212054</regionId>
		<name>BeaconTest</name>
		<type>BEACON</type>
		<eventType>ENTER</eventType>
		<msgTitle>Beacon subject</msgTitle>
		<msgContent>Beacon text</msgContent>
		<appName>OgangiTest</appName>
		<timezone>America/Caracas</timezone>
		<update>2014-06-08T23:46:12.805-04:30</update>
		<uuid>B9407F30-F5F8-466E-AFF9-25556B57FE6D</uuid>
		<major>8888</major>
		<minor>3333</minor>
		<manufacturer>ESTIMOTE</manufacturer>
		<distance>NEAR</distance>
	<Beacon>
</result>

Please be aware that the <Beacon> object it's generic and may apply to other responses in other methods.

Result parameters
Parameter Name Description Possible Values
Beacon.regionId Region's unique identifier Text
Beacon.name Beacon's name Text
Beacon.type Location Based Campaign's type. Always BEACON for this method
Beacon.eventType The type of event that triggers the beacon. Valid values are: ENTER | EXIT | ENTER-EXIT
Beacon.msgTitle The message's title to be deliver when the beacon fires. Text
Beacon.msgContent The message's content to be deliver when the beacon fires. Text
Beacon.appName The identifier of the application, who will monitor the beacon. Text
Beacon.timezone Timezone used Text
Beacon.update The date mark when the last update occurs A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
uuid Beacon's UUID value. Text
major Beacon's MAJOR VERSION value. Text
minor Beacon's MINOR VERSION value. Text
manufacturer Beacon's Manufacturer. Text
distance User's distance to the beacon needed to trigger the event. INMEDIATE
NEAR
FAR

Retrieve IP Address Info

Overview

This handy method provides the geographical information from an IP address.

We keep our internal database synced to the geographical information provided by ip2location.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getIPAddressInfo/{instanceId}/{ip}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
ip The IP address to query
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getIPAddressInfo</input>
<status>OK</status>
<description>Completed</description>
<result>
	<ipAddressInfo>
		<isoCountryCode>US</isoCountryCode>
		<regionCode>VA</regionCode>FINISHED>
		<regionName>Virginia</regionName>
		<city>Falls Church</city>
		<zipCode>22042</zipCode>
		<latitude>38.863998</latitude>
		<longitude>-77.192200</longitude>
		<metroCode>511</metroCode>
		<areaCode>703</areaCode>
	</ipAddressInfo>
</result>
Result parameters
Parameter Name Description Possible Values
isoCountryCode The two-character ISO 3166-1 standard for country code A ISO 3166 String
regionCode The principal geographical subdivision code according the ISO 3166-1 standard A ISO 3166 String
regionName Name of the providence or state. Text
city The city name for the location associated with the IP address. Text
zipCode Zip Code for the location associated with the IP address. Text
latitude Latitudinal coordinates corresponding to the location . Number (decimal notation)
longitude Longitudinal coordinates corresponding to the location. Number (decimal notation)
metroCode Is the Designated Market Area (DMA) region code associated with the IP address. These are only available for networks in the US. Text
Only available in the United States
areaCode Is the telephone area code associated with the IP address. This output is deprecated, and may not reflect newer area codes. Text
Only available in the United States

MT

Send SMS

Overview

Send a text message to a cell phone using its mobile number as target.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMS/{instanceId}/{carrier}/{from}/{mobileNumber}/{text}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
carrier Mobile operator in which the user have his SIM card or contract
from Short or Long code that will be used to originate the SMS. If you don't have one assigned yet please contact our support team trough our ticketing tool to request one.
mobileNumber The target User's mobile phone number. This parameter must be Base64 encoded
text This is the content of the message. This parameter must be Base64 encoded
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Send SMS (Campaign Manager)

Overview

Send a text message to a cell phone using its mobile number as target.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/sendMT/{instanceId}/{from}/{carrier}/{mobileNumber}/{text}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
from Short or Long code that will be used to originate the SMS. If you don't have one assigned yet please contact our support team trough our ticketing tool to request one.
carrier Mobile operator ID in which the user have his SIM card or contract.
Write null on this placeholder to let the CM look for a suitable carrier
mobileNumber The target User's mobile phone number
text This is the content of the message. This parameter must be Base64 encoded
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendMT</input>
<status>OK</status>
<description>Completed</description>

Generate Mobile PIN

Overview

Generates and send a PIN code to a mobile device via SMS.

Useful when a live validation is needed, user cases examples:

  • User own's the mobile number
  • ATM or any other delicate operation
  • Promo code
URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSPinMobileNumberConfirm/{instanceId}/{carrier}/{from}/{mobileNumber}/{text}/{length}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
carrier Mobile operator in which the user have his SIM card or contract
from Short or Long code that will be used to originate the SMS. If you don't have one assigned yet please contact our support team trough our ticketing tool to request one.
mobileNumber The target User's mobile phone number
text This is the content of the message. This parameter must be Base64 encoded
length PIN's length (how many characters long)
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMSPinMobileNumberConfirm</input>
<status>OK</status>
<description>Completed</description>
<result>
	<PinSMSConfirmation>
			<pin>846547</pin>
	</PinSMSConfirmation>
</result>
Result parameters
Parameter Name Description Possible Values
PinSMSConfirmation.pin The generated PIN Text

MO

Fire Message

Overview

Trigger an incoming message to the campaign manager (MO) for the given user information, useful when a user will respond to the campaign using a third party interface and no its mobile device. The response to this message will came using the intended response mechanism of the target campaign.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/fireMessage/{instanceId}/{mobileNumber}/{text}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
mobileNumber The target user mobile phone number
text This is the content of the message. This parameter must be Base64 encoded
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>activateCampaign</input>
<status>OK</status>
<description>Completed</description>

List Incoming Messages

Overview

Retrieve messages received, you can even narrow the results by adding some filters.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getMOMessages/{instanceId}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
parameters This parameters are special filters to narrow results when dealing with big amounts of data, Please find more information about these filters in the MO Inline Search String appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getMOMessages</input>
<status>OK</status>
<description>Completed</description>
<result>
	<MOMessageList>
		<records>17</records>
		<MessageList>
			<MOMessage>
				<text>Test</text>
				<from>58123456789</from>
				<to>19893143924</to>
				<encoding>UTF-8</encoding>
				<keyword>^OGANGI.*</keyword>
				<carrier>Movistar</carrier>
				<sendDate>2014-10-13 10:30:51.922</sendDate>
			</MOMessage>
		</MessageList>
	<MOMessageList>
</result>
Result parameters

Please be aware that the <MOMessage> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
MOMessageList.records Total found Number
MOMessage.text Message's content Text
MOMessage.from Who sent the message Short/Long code which originated the message
MOMessage.to Recipient for this message User's mobile number
MOMessage.encoding The charset encoding used for the message's text Valid encoding name
MOMessage.keyword Keyword in the message content. Text
MOMessage.carrier The carrier name used for this delivery Text
MOMessage.sendDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference

Lists

Add User to Distribution List

Overview

Add a mobile number to a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/addUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to add.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>addUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Remove User from Distribution List

Overview

Remove a mobile number from a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/removeUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to remove
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Add User to Distribution List

Overview

Add a mobile number to a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/addUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to add.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>addUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Remove User from Distribution List

Overview

Remove a mobile number from a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/removeUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to remove
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Add User to Distribution List

Overview

Add a mobile number to a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/addUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to add.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>addUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Remove User from Distribution List

Overview

Remove a mobile number from a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/removeUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to remove
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Add User to Distribution List

Overview

Add a mobile number to a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/addUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to add.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>addUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Remove User from Distribution List

Overview

Remove a mobile number from a distribution list.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/removeUserDistributionList/{instanceId}/{distListId}/{mobileNumber}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
distListId Target distribution list
mobileNumber The mobile number to remove
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeUserDistributionList</input>
<status>OK</status>
<description>Completed</description>

Blasting

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName The user name associated with the instance
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number
Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcasts ID to consult
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Broadcast ID to delete
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName The user name associated with the instance
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number
Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcasts ID to consult
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Broadcast ID to delete
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName The user name associated with the instance
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number
Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcasts ID to consult
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Broadcast ID to delete
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName The user name associated with the instance
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number
Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcasts ID to consult
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Broadcast ID to delete
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>

Blast by File

Overview

Send SMSs massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the SMSs Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendSMSByFile/{instanceId}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{userName}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName The user name associated with the instance
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number
Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcasts ID to consult
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Broadcast ID to delete
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The running broadcast ID to suspend
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId The broadcast ID to resume
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
broadcastId Running broadcast Id to stop
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Retrieve Client's Credits

Overview

Clients will require credits to send messages. Every message (regardless the channel) cost 1 credit. Use this method to see how many credits a client currently have.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getClientCredits/{instanceId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getClientCredits</input>
<status>OK</status>
<description>Completed</description>
<result>
	<clientCredits>
		<credits>7059</ credits >
		<clientId>As223sdadq8d8287v5v</clientId>
	</clientCredits>
</result>
Result parameters
Parameter Name Description Possible Values
credits The available credit count at the moment Number
clientId The client's Id Text

Retrieve Client's Transactions

Overview

A transaction is a credit operation, related to a purchase or expense. This method will list all your transactions.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getClientTransactions/{instanceId}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getClientTransactions</input>
<status>OK</status>
<description>Completed</description>
<result>
	<clientTransactions>
		<clientTransaction>
			<amount>1</amount>
			<operationType>DEDUCT</ operationType >
			<date>2013-11-06T13:35:01.000-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</clientTransaction>
		<clientTransaction>
			<amount>500</amount>
			<operationType>PURCHASE</ operationType >
			<date>2013-11-06T13:35:01.000-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</clientTransaction>		  
	</clientTransactions>
</result>
Result parameters
Parameter Name Description Possible Values
clientTransaction.amount The transaction's amount. Number
clientTransaction.operationType Operation type. PURCHASE / DEDUCT
clientTransaction.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
clientTransaction.timezone Timezone used Text
clientTransaction.clientId The client identification Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
id Recipient id on the restricted list
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient
parameters
OPTIONAL
Search filters. Please learn more about it in the restriction list search parameters appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text

Message Report

Overview

List all messages information in a given period of time. It support filters to help you get the desired information easily.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/messageReport/{instanceId}/{initialDate}/{finalDate}/{page}/{resultsPerPage}/{parameters}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
initialDate Starting timestamp Measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
finalDate Final timestamp Measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
parameters This parameters are special filters to narrow results when dealing with big amounts of data, Please find more information about these filters in the MT Inline Search String appendix
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example
Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>messageReport</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<records>15</records>
		<message>
			<blastId>-2490820026197535447</blastId>
			<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
			<type>PUSH</type>
			<from>Inbox</from>
			<to>18133210984</to>
			<subject>Inbox Push Ogangi</subject>
			<text>Inbox Push Ogangi Message</text>
			<status>SENT</status>
			<statusDescription>Sent</statusDescription>
			<date>2014-01-24T12:45:50.903-04:30</date>
			<lastUpdated>2015-11-04T11:47:26.511-04:30</lastUpdated>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
			<appName>Inbox</appName>
			<platform>IOS</platform>
		</message>
 
		...
 
	<