Journeys
When you want to use Web Pages and Surveys of a Journey you have to use as idWebSite the value of the field idWebSite inside the Journey structure.
createCampaign
Creates a new journey.
If you want to create a simple email you should create a communication, not a journey.
| Parameter |
Type |
Description |
| name |
String |
|
| field |
List of FieldValue
|
Available fields:
-
subject: default subject for new communications
-
emailfrom: default from email for new communications
-
smsfrom: default SMS sender for new communications
-
emailalias: default (display name) from name for new communications
-
emailreplyto: default email reply to for new communications
-
emailmultipart: sets multipart delivery, default for new communications
-
cssinline: displays inline css, default for new communications
-
emailenabled: enables the email channel, default for new communications
-
smsenabled: enables the SMS channel, default for new communications
-
faxenabled: enables the Fax channel, default for new communications
-
useallmedia: sends on each channel available for contacts, default for new communications
-
ignoreusermediapref: for multichannel delivery sends also on channels for which contacts have not given an explicit consent, default for new communications
-
removedupemails: removes duplicate email addresses during sendings, default for new communications
-
removedupcells: removes duplicate mobile numbers during sendings, default for new communications
-
removedupfax: removes duplicate Fax numbers during sendings, default for new communications
-
defaulttarget: default target for deliveries (comma separated list of audience IDs)
-
forceusetarget: restricts target for deliveries to default target
|
| options |
List of <Option> |
|
Return values: String
Permissions: Create journeys
getAllCampaigns
Returns lists of all journeys.
Return values: List of MNCampaign
Permissions: Manage all journeys
findCampaignById
Returns information about a journey.
| Parameter |
Type |
| idCampaign |
String |
Return values: MNCampaign
Permissions: Manage journey
updateCampaign
Updates a journey.
| Parameter |
Type |
Description |
| name |
String |
|
| field |
List of FieldValue
|
options are the same as createCampaign
|
| options |
List of <Option> |
|
Return values: void
Permissions: Manage journey
WebDomains
getAllWebDomains
Returns the ID and the name for all defined webdomains.
| Parameter |
Type |
| options |
list of <options> |
Return values: List of MNWebDomain
Permissions: None (every webdomain is always public)
Events
getSimpleMessageEvents
Returns all transactional message events matching the given filters.
| Parameter |
Type |
Description |
| options |
list of <options> |
Available values:
-
Integer idsimplemessage: message id
-
Integer idcontact: contact id
-
Integer idmessagetype: type of id message
-
Integer idmessagecategory: catetory id of the message
-
String from: minimum event timestamp (for the format see formatting date-times)
-
String to: max event timestamp (for the format see formatting date-times)
-
String channel: event channel ("email", "sms", "fax" or "*")
|
| |
|
|
Return values: List of Simplemessageevent
Permissions: View statistics details