Batch deliveries
MNSendOptions
| Field | Type |
|---|---|
| trial | Boolean |
| enableEmail | Boolean |
| enableSms | Boolean |
| enableFax | Boolean |
| allowEmailDuplicated | Boolean |
| allowCellDuplicated | Boolean |
| allowFaxDuplicated | Boolean |
| ondemand | Boolean |
| enableSendTimeOptimization | Boolean |
| requestedStartDate | Date |
| speedPerMinute | Integer |
MNDeliveryStatus
| Field | Type | Description |
|---|---|---|
| idNewsletter | String | |
| idDeliveryStatus | String | |
| requestedEmailMessages | int | |
| requestedSmsMessages | int | |
| requestedFaxMessages | int | |
| status | String | List of possible values:"finished" delivery finished"deleted" delivery deleted"error" an error occurred in the delivery"preparationerror" an error occurred in the delivery preparation"splittestpause" A/B split test finished, delivery pending completion"userinterrupted" delivery interrupted"userinterruptedfinished" end of interrupted delivery"sending" active delivery"waiting" pending delivery"unconfirmed" unconfirmed delivery"preparing" delivery in preparation"finishing" delivery completed (waiting for bounce)"suspended" suspended delivery |
| startDate | Date | |
| active | Boolean | |
| idPlannedDelivery | String | |
| scheduleType | String | "single" not periodic delivery"daily" daily delivery"weekly" weekly delivery "monthly" monthly delivery"yearly" yearly delivery"other" |
| target | String | |
| additionTargetFilterPresent | Boolean | true if option "additionalTargetFilterQuery" is set in sendNewsletter function |
Deliveries
MNMessageStatus
| Field | Type |
|---|---|
| messageId | String |
| address | String |
| actualStatus | String |
| firstSentDate | Date |
| lastSentDate | Date |
| received | Boolean |
| bounced | Boolean |
| opened | Boolean |
| clicked | Boolean |
MNDeliveryPolicy
| Field | Type |
|---|---|
| idPolicy | String |
| name | String |
Notification messages
EmailMessage
| Field | Type | Description |
|---|---|---|
| fromemail | String | email address to put inside 'From:' header |
| fromname (optional) | String | from name, to be put inside the 'From:' header |
| to | String | email address to send the email to (optional if usecontactemail option is given) |
| replyto | String | email address to use for the 'Reply-To:' header |
| subject | String | subject of the email |
| chartset (optional) | String | preferred charset for the email (if you leave it empty or unset the default of your account will be used). Common values are 'utf-8' or 'windows-1252' |
| htmlbody (optional) | String | whether set, represents the text/html content of the email; it can contain [contact:xxx] placeholders, image references ( [image:mylogo.gif from=global], [image:mylogo.gif from=website]) or service links ([link:unsubscribe], [link:subscribe]) |
| textbody (optional) | String | whether set, represents text/plain content of the email; it can contain [contact:xxx] placeholders, or service links ([link:unsubscribe], [link:subscribe]) |
| header | list of FieldValue | additional headers for the email |
| attachment | list of Attachment | additional attachments for the email |
| idmessagetype (optional) | String | used to group messages in order to create reports. Insert the numeric ID of message type. Use method getAllSimpleMessageTypes to get all simpleMessages types |
| tempvar (optional) | list of TypedValue | used to pass temp vars in communication templates |
| externalId (optional) | String | used to assign an external ID to a notification message |
| inputparam (optional) | list of TypedValue | used to pass input parameters in communication templates. To use inputparam you have to declare them first and you must write them lowercase. |
Attachment
| Field | Type | description |
|---|---|---|
| filename | String | Name of the file attached to the received message |
| contenttype | String | MIME of the attached file |
| body | Byte[] | Binary body of the attachment |
SmsMessage
| Field | Type | Description |
|---|---|---|
| from | String | sender phone for the message, alphanumeric phone (11 characters) or numeric phone (16 characters) |
| to | String | phone number to send the sms to (optional if usecontactcell option is given) |
| smsbody | String | content of the message, it can contain [contact:xxx] placeholders, or service links ([link:unsubscribe], [link:subscribe]) |
| idmessagetype (optional) | String | used to group messages in order to create reports |
| tempvar (optional) | list of TypedValue | used to pass temp vars in communication templates |
| externalId (optional) | String | used to assign an external ID to a notification message |
MNSimpleMessageStatus
| Field | Type | Description |
|---|---|---|
| messageId | String | ID of the transactional message |
| address | String | Email/sms recipient |
| actualStatus | String | 'internalError', 'hardBounce', 'waiting', 'sent', 'notSent', 'softBounce', 'sending' |
| sentDate | Date | Delivery date |
| opened | Boolean | true, if message is opened |
| lastOpenedTs | Date | Date of the last message open |
| clicked | Boolean | true, if message is clicked |
| lastClickedTs | Date | Date of the last message click |
| converted | Boolean | true, if message generated a conversion |
| lastConversionTs | Date | Date of the last conversion |
| expectedDeliveryTs | Date | Expected delivery date. Not null only for message which should be sent, for messages which are already sent this field is empty |
| idbouncecategory | Integer | ID of the bounce category |
| complainted | Boolean | true is the contact reported a complaint on a message |
| notSentCause | String | Detailed cause in the case of actualStatus='notSent', valid values are:
|
| externalId (optional) | String | Used to assign an external ID to a notification message |
MNSendEmailResult
| Field | Type | Description |
|---|---|---|
| emailsent | boolean | |
| emailaddress | String | |
| idsimplemessage | int |
SendSimpleMessageOperation
| Field | Type | Description |
|---|---|---|
| customdata | string | |
| debug | String | |
| idcontact | string | |
| idMessage | string |
BatchEmailMessage
| Field | Type | Description |
|---|---|---|
| message | EmailMessage | The message to send |
| options | List<Option> | See sendEmailMessage for the full list of options available. |
| customdata | String | Optional data which will be sent back in BatchEmailMessageOperation |
BatchSmsMessage
| Field | Type | Description |
|---|---|---|
| message | SmsMessage | The sms to send |
| options | List<Option> | See sendSmsMessage for the full list of options available. |
| customdata | String | Optional data which will be sent back in BatchSmsMessageOperation |
BatchEmailMessageOperation
| Field | Type | Description |
|---|---|---|
| idmessage | String | |
| customdata | String | See BatchEmailMessage |
| ok | Boolean | |
| debug | String | Filled in case of error |
BatchSmsMessageOperation
| Field | Type | Description |
|---|---|---|
| idmessage | String | |
| customdata | String | See BatchSmsMessage |
| ok | Boolean | |
| debug | String | Filled in case of error |
TypedValue
| Field | Type | Description |
|---|---|---|
| name | String | Name of parameter |
| value | String | Value of parameter |
| valueType | String | Type of parameter: "int","string","boolean","date","datetime". To use "date" and "datetime" see formatting dates and date-times. |
MNSimpleMessageType
| Field | Type | Description |
|---|---|---|
| idMessageType | String | ID of the message type |
| idMessageCategory | String | ID of the message category |
| name | String | Name of the message type |
MNSimpleMessageTypeReport
| Field | Type | Description |
|---|---|---|
| idMessageType | String | ID of the message type |
| sent | int | |
| received | int | |
| opened | int | |
| clicked | int | |
| complainted | int | |
| converted | int | |
| unsubscribed | int | |
| hardBounced | int | |
| softBounced | int | |
| totalOpens | int | |
| totalClicks | int | |
| totalConversions | int |
MNSimpleMessageCategory
| Field | Type | Description |
|---|---|---|
| idMessageCategory | String | ID of the message category |
| name | String | Name of the message category |