List of properties of the Campaign resource

Listing campaigns

List of available filters

Example

List the campaigns for which the id is either 24 or 25

or in POST (but by specifying the action)

And with Curl

Return

This method sends back as return campaigns encapsulated in a structure that also contains:

{
	"size": 2,        // Nombre campagnes renvoyées
	"total": 2,       // Nombre total de campagnes si la requête n’était pas limitée
	"list": [         // Liste des ressources campaigns
   	{
            "id": "24",
            "name": "Campagne 15/10/2013 11:50",
       	"cancelled": "0",
             ...
       	"status": "ended",
       	"type": "STANDARD"
       	"dateCreated": "2014-06-09 10:51:59",
   	},
   	{
            "id": "25",
            "name": "Campagne 09/06/2014 10:50",
       	"cancelled": "0",
             ...
       	"status": "ended",
       	"type": "STANDARD"
       	"dateCreated": "2014-06-09 10:51:59",
   	}
	]
}

Creating a campaign

List of parameters to supply in order to create a campaign

List of parameters for the steps table

List of parameters for the mailings table

Link for unsubscribing

So that the recipient of emails can unsubscribe from the service, a link for unsubscribing must be present in the body of the email (HTML and TEXT). This link must be inserted via the #OPTOUTLINK# field which will be replaced with the link for unsubscribing that is proper to each recipient.

The #OPTOUTLINK# field in the HTML and TEXT portions is required in order to save the mailing.

For example

Preview link

Just like the link for unsubscribing, there is also a customized field allowing a preview link to be inserted into the HTML creation. This link must be inserted via the #PREVIEWLINK# field which will be replaced with the preview link.

For example

Links present in the HTML and TEXT portions

When mailings are created, the links present in the HTML and TEXT portions are detected in order to be tracked. For each link, an id corresponding to both the link and to the contact is added which allows us to know when link was clicked, by whom, when, etc.

To deactivate link tracking, simply add the attribute rel= "notrack" in each of the links.

For example, to not track a link present in an image

Specifying a URL or PING

Instead of regularly polling the status of a message until it is received ("pull" mode), you can be informed ("push" mode) of the arrival of a status linked to the messages that you have sent.

For this, you supply, when the mailing is created, an address on your server ‘http://myserver.com/ping.php ?id=#id# ’ for example, and the Digitaleo platform will call this address with the id of the email when its status changes.

This URL is passed in the pingUrl parameter.

Cumulating changes in status ("batch") is possible by using the #ids# pattern instead of #id#. The ids are then separated by commas.

Syntax of the period for automated or recurring campaigns

The expected syntax is inspired by the crontab format

<minute> <hour> <day> <month> <dayWeek>

Note: dayWeek is a series of indexes (0=Sunday, 1=Monday, etc)

For recurring campaigns, the possible values are:

• minute & hour: value

• day: value, interval, every day ("*")

• month: value, interval, every month ("*")

• dayWeek: value, interval, every day of the week ("*")

For triggered campaigns, a reference to the day and to the month of the autoField can be used with the values "D" and "M". The possible values are:

• minute & hour: value

• day: reference to the day of the "autoField" field ("D") - a number of days

• month: all months ("*") or reference to the month of the "autoField" field ("M") - a number of months

• dayWeek: value, interval, every day of the week ("*")

Example for recurring campaigns

Example for triggered campaigns

Example 1: Creating a campaign comprising 2 steps, of one is prioritized and one combined

$myNewCampaign = $messengeo->campaignsCreate(
 array(
   'name'       	=> 'Soldes du 10 juillet',
   'reference'  	=> '12',
   'listId'     	=> '2674',
   'steps'      	=> array(
       array(
           'mode'   	=> 'prioritized',
           'priorities' => 'EMAIL,SMS',
           'date'   	=> '2013-07-10 12:00:00',
           'mailings'   => array(
               array(
                   'name'     	=> 'mailing email du 10 juillet',
                   'text'     	=> 'Bientôt les soldes',
                   'html'     	=> '

Titre de la page

Bientôt les soldes

', 'subject' => "Info soldes", 'replyContact' => 'sender@gmail.com', 'media' => 'EMAIL', ), array( 'name' => 'mailing sms du 10 juillet', 'text' => 'Bientôt les soldes', 'media' => 'SMS', ), ), 'reference' => 'Ref1', ), array( 'mode' => 'combined', 'date' => '2013-07-15 12:00:00', 'mailings' => array( array( 'name' => 'mailing email du 15 juillet', 'text' => 'Profitez des soldes', 'html' => 'Titre de la pageProfitez des soldes', 'subject' => "Rappel des soldes", 'replyContact' => 'sender@gmail.com', 'media' => 'EMAIL', ), array( 'name' => 'mailing sms du 15 juillet', 'text' => 'Profitez des soldes', 'media' => 'SMS', ), ), ), ) ) );

Example 2: How to create an automated campaign

Creating an automated campaign using the birthDate field knowing that the message must be sent once a year at 11:45 the day before the birthday, with a shift to Saturday if the date falls on a Sunday.

$autoCampaign = $messengeo->campaignsCreate(
  array(
    'type'  => 'TRIGGERED',
    'steps' => array(
       array(
         ...
         'autoField'  => 'birthDate',
         'autoPeriod' => '45 11 D-1 M 1,2,3,4,5,6',
         ...
      )
    )
  )
);

Example 3: How to create an automated campaign - II

Creating an automated campaign using the field03 field knowing that the message has to be sent every month at 12:30 two days before the date mentioned in the contact.

$autoCampaign = $messengeo->campaignsCreate(
 array(
   'type'  => 'TRIGGERED',
   'steps' => array(
      array(
        ...
        'autoField'  => 'field03',
        'autoPeriod' => '30 12 D-2 * *',
        ...
      )
    )
  )
);

Example 4: How to create an automated campaign - III

Creating an automated campaign using the field06 field knowing that the message has to be sent every year at 12:30 1 month before the date mentioned in the contact.

$autoCampaign = $messengeo->campaignsCreate(
 array(
   'type'  => 'TRIGGERED',
   'steps' => array(
     array(
        ...
        'autoField'	=> 'field06',
        'autoPeriod'   => '30 12 D M-1 *',
        ...
     )
   )
 )
);

Example 5: How to create a recurring campaign

Creating a recurring campaign knowing that the message has to be sent (to all of the contacts) on the 10th of every month at 12:30. If the 10th falls on a Sunday, the message will be sent on the 9th.

$autoCampaign = $messengeo->campaignsCreate(
 array(
   'type'  => 'RECURRING',
   'steps' => array(
     array(
        ...
        'autoPeriod'   => '30 12 10 * 1,2,3,4,5,6',
        ...
     )
   )
 )
);

Example 6: How to create a transactional campaign

Creating a transactional campaign of which the message will be sent to each new recipient that is associated with it.

$myNewCampaign = $messengeo->campaignsCreate(
 array(
   'name'       	=> 'Campagne nouveau client',
   'type'          => 'TRANSACTIONAL',
   'steps'      	=> array(
       array(
           'priorities' => 'EMAIL',
           'mailings'   => array(
               array(
                   'name'     	=> 'mailing pour les nouveaux clients',
                   'html'     	=> '

Titre de la pageBienvenue en tant que nouveau client', 'subject' => "Bienvenue", 'replyContact' => 'sender@gmail.com', 'media' => 'EMAIL', ), ) )) ));

Creation of two new contacts associated with the previously created transactional campaign, having 15 for id. In the following example, the messages will be sent to the contacts on the date of 16/02/2015 at 5 o'clock. If no date is defined, the messages will then be sent automatically.

$myNewContacts = $messengeo->campaigncontactsCreate(
 array(
   'campaignId'     => 15,
   'date'          => '2015-02-16 05:00:00',
   'contacts'       => array(
       array(
           'email'     => 'contact1@digitaleo.com',
           'firstName' => 'Contact1 FirstName',
           'LastName'  => 'Contact1 LastName'
       ),
       array(
           'email'     => 'contact2@digitaleo.com',
           'firstName' => 'Contact2 FirstName',
           'LastName'  => 'Contact2 LastName'
       )
   )
 )
);

Example 7: Spreading out the sending

Creating an SMS campaign in packets of 100 messages every 20 minutes.

$myNewCampaign = $messengeo->campaignsCreate(
 array(
   'name'       	=> 'appel conseiller',
   'reference'  	=> '12',
   'listId'     	=> '2674',
   'steps'      	=> array(
       array(
           'date'   	=> '2013-07-10 12:00:00',
           'mailings'   => array(
               array(
                   'text'     	=> 'Bonjour, appelez votre conseiller au 06... pour discuter de votre contrat',
                   'media'    	=> 'SMS',
                   'batchVolume'    	=> 100, // nombre de messages
                   'batchDelay'    	=> 20, // nombre de minutes entre chaque paquet
               ),
           ),
       ),
   )
 )
);

Canceling a campaign

List of parameters to supply

Notes

• The end date of the campaign takes the date of cancellation

• The status of the campaign is modified ("canceled" if the cancellation occurs before the start date of the campaign, "interrupted" otherwise)

Return

A resource of which the only property is success is returned. 1 in case of a successful cancellation 0 otherwise.

{
  success: 1,
}

Example

<table class="api-table>

Parameter

Type

Description

Required?

action

string

=cancel

allows you to specify the action to be carried out

yes (action=cancel)

id

int

Id of the campaign to be canceled

yes

{
  count: 1,
}

{
	total: 45554,
	wait: 0,
	on: 45554,
	ok: 0,
	ko: 0,
	no: 0,
	optout: 0,
	opened: 0,
	clicked: 0,
	hb: 0,
	sb: 0,
	rep: 0,
	date: null
}