RESTful API

Create Campaign

Overview

Allows the user to create interactive campaigns

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/createCampaign/{instanceId}/{mimId}/{minType}/{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
mimId The campaign id, please use -1 if creating a new one, or the actual ID if your want to edit an existing one
minType The type of campaign you want to create/edit. See the available Campaign's Types for more information
Json
POST 		The campaign description in detail. Learn more about the Campaign Descriptor 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>createCampaign</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

Get Campaign

Overview

Returns the basic information about the campaign

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getCampaign/{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

Activate Campaign

Overview

Activate a specific campaign. It has no effect if the campaign is currently activated.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/activateCampaign/{instanceId}/{mimId}/{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
mimId The campaign id, you could retrieve this information from the campaign manager UI or using the List Campaigns
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>

Deactivate Campaign

Overview

Deactivate a campaign. It has no effect if the campaign is currently deactivated.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/deactivateCampaign/{instanceId}/{mimId}/{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
mimId The campaign id, you could retrieve this information from the campaign manager UI or using the List Campaigns
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>deactivateCampaign</input>
<status>OK</status>
<description>Completed</description>