Steps

List of properties of the Step resource

Property

Description

id

Id of the step

mode

Sending mode "combined" or "prioritized"

priorities

List of channels to prioritize in the framework of the substitution (EMAIL, SMS, VOICE, VOICEMAIL)

medias

List of channels used for this step

campaignId

Id of the campaign to which the step is attached

campaignName

Name of the campaign to which the step is attached

campaignListCount

Number of contacts in the list of the campaign

autoPeriod

String of characters representing the periodicity at which the campaign is to be sent in the framework of automated or recurring campaigns

autoField

Contact field used as a basis in the framework of automated campaigns

reference

Client reference for the step

date

Send date for the step

status

Status of the step

  • created: step created (status by default)

  • canceled: step canceled before its start date (so no message has been sent)

  • interrupted: step canceled after its start date (so a portion of the messages may have been sent)

  • ended: step ended (each mailing has exceeded the timeout for its media)

dateUpdated

Date of the last modification for the step

dateCreated

Creation date of the step (= confirmation date of the campaign)
 

Listing the steps

List of available filters

Property

Description

id

Filter according to one or more step ids

campaignId

Filter according to one or more campaign ids

reference

Filter on a customer reference

medias

Filter on one or more media of the step
 

Example 1: Retrieving a step from its id

GET /rest/steps HTTP/1.1

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpZCI6ImYyMzE2…
Host: api.messengeo.net
Content-Type: application/x-www-form-urlencoded

id=103
 

With Curl

curl

-X GET

-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...ccOqbVow8xOQyQ"

-d id=103

https://api.messengeo.net/rest/steps
 

Example 2: Retrieving the steps of a campaign containing an SMS sending

GET /rest/steps HTTP/1.1

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpZCI6ImYyMzE2…
Host: api.messengeo.net
Content-Type: application/x-www-form-urlencoded

campaignId=24&medias=SMS
 

With Curl

curl

-X GET

-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...ccOqbVow8xOQyQ"

-d campaignId=24

-d medias=SMS

https://api.messengeo.net/rest/steps
 

Return

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

{
   "size": 1,
   "total": 1,
   "list": [
   {
       "autoField": null,
       "autoPeriod": null,
       "campaignId": "615",
       "campaignListCount": "36",
       "campaignName": "Campagne 09/06/2014 10:50",
       "date": "2014-06-09 10:51:59",
       "dateCreated": "2014-06-09 10:51:59",
       "dateUpdated": "2014-06-12 10:52:11",
       "id": "618",
       "medias": [
           "SMS"
       ],
       "mode": "combined",
       "priorities": [
           ""
       ],
       "reference": "1475",
       "status": "ended"
   }
   ]
}