//[[restapi:start|RESTful API]]//

====== Sending Geo Push ======

==== Previous Versions ====
<wrap button>[[restapi:sending_geo_push_3_34|Tag 34]]</wrap>

==== Overview ====

This method allows you to fire a Push Message over a region. The region will be defined as a circle given a cardinal point of the globe and a radius.

All registered devices inside that circle at that moment will receive the message you send.

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/sendGeoPushToApp/{instanceId}/{appName}/{platform}/{msgTitle}/{latitude}/{longitude}/{radius}/{expirationDate}/{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 [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| appName | Your App's name which will receive your Push Notifications |
| platform | The target platform for the push service. <wrap info>Valid values are: **ANDROID** or **IOS**</wrap> |
| msgTitle | A title for this message. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. <wrap alert>You can't exceed 80 characters</wrap> |
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your message. This is a text file that could contain HTML format. |
| latitude | The point latitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap> |
| longitude | The point longitude <wrap info>Number ([[https://en.wikipedia.org/wiki/Decimal_degrees|decimal notation]])</wrap> |
| radius | The circle radius. <wrap info>Use **meters** for this value</wrap> |
| expirationDate \\ <wrap notice>OPTIONAL</wrap>| The date in milliseconds (since 1970-01-01T00:00:00Z) when the blast message must expire. |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendGeoPushToApp</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<statusDescription>Finished</statusDescription>
		<clientId>As223sdadq8d8287v5z</clientId>
		<appName>Inbox</appName>
		<platform>ANDROID</platform>
		<messages>
			<message>
				<blastId>-2490820026197535447</blastId>
				<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
				<type>PUSH</type>
				<from>Inbox</from>
				<to>13056708084</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>
				<timezone>America/Caracas</timezone>
				<appName>Inbox</appName>
				<platform>ANDROID</platform>
			</message>

			...

			<message>
				<blastId>-2490820026197535447</blastId>
				<id>489cf77-4fbc-4822-a5ed-21516555fd1e</id>
				<type>PUSH</type>
				<from>testApp</from>
				<to>18133210984</to>
				<subject>testApp Push Ogangi</subject>
				<text>testApp Push Ogangi Message</text>
				<status>SENDING</status>
				<statusDescription> Sending to device </statusDescription>
				<date>2014-01-24T12:45:50.903-04:35</date>
				<timezone>America/Caracas</timezone>
				<appName>Inbox</appName>
				<platform>ANDROID</platform>
			</message>
		</messages>
	</blast>
</result>

</code>

== Result parameters ==

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

^ Parameter Name ^ Description ^ Possible Values ^
| blastId | The unique blast identification, a blast is always needed to send one or more messages | Text |
| status | Indicates current the blast's status | For more information please review the [[restapi:appx_msg_status#blast|Message's Status]] page |
| statusDescription | A human readable explanation about the blast's status | Text |
| clientId | The client identification (sender) | Text |
| appName | The app name used to sent the message | Text |
| platform | The target platform used | Valid values: \\ ANDROID \\ IOS |
| message.blastId | Unique identifier for the blast used to fire the message | Text |
| message.id | Unique identifier for the message created | Text |
| message.type | Indicates the kind of message that was sent | **PUSH \\ SMS \\ EMAIL ** |
| 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.subject | Message's subject | Text |
| message.text | Message's content | Text |
| message.status | Indicates the message's status at the origination moment | See our [[restapi:appx_msg_status#blast|Message's Status]] page |
| message.statusDescription | A human readable explanation about the current status | Text |
| 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 [[restapi:appx_date#date_format_-_pattern_letters|pattern letters]] quick reference |
| message.timezone | Timezone used | Text |
| message.appName | App used, only available when using PUSH | Text |
| message.platform | App platform, only available when using PUSH | Text |