RESTful API

Get Campaign

Previous Versions

Overview

Returns the basic information about the campaign

URL

Http access method: GET

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/campaign/{instanceId}/{searchString}/{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
searchString It could be the Campaign Name or the Campaign ID. 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>getCampaign</input>
<status>OK</status>
<description>Completed</description>
<result>
      <mim>
         <id>1</id>
         <msgtype>2</msgtype>
         <name>MIM1</name>
         <description>MIM description</description>
         <active>1</active>
         <deliveryMethod>SMS</deliveryMethod>
      </mim>
</result>
Result parameters

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

Parameter Name Description Possible Values
mim.id The campaign identifier number Number
mim.msgtype The campaign type Number
mim.name Name of the campaign Text
mim.description Description used at the creation time Text
mim.active Indicates if the campaign is Active (1) or Inactive (0) Number
mim.deliveryMethod Indicate which is the delivery method configured: SMS or PUSH Text