Vai al contenuto principale
English
Help Desk

Data structures > Messages and deliveries

Aggiornato

Batch deliveries

MNSendOptions

Campo Tipo
trial Boolean
enableEmail Boolean
enableSms Boolean
enableFax Boolean
allowEmailDuplicated Boolean
allowCellDuplicated Boolean
allowFaxDuplicated Boolean
ondemand Boolean
enableSendTimeOptimization Boolean
requestedStartDate Date
speedPerMinute Integer

MNDeliveryStatus

Campo Tipo Descrizione
idNewsletter String  
idDeliveryStatus String  
requestedEmailMessages int  
requestedSmsMessages int  
requestedFaxMessages int  
status String Lista dei valori possibili:
  • "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

MNDeliveryPolicy

Campo Tipo
idPolicy String
name String

Notification messages

EmailMessage

Campo Tipo Descrizione
fromemail String indirizzo email da inserire nell'header 'From:'
fromname (optional) String nome mittente, da inserire nell'header 'From:' 
to String indirizzo email a cui inviare l'email (opzionale se fornisci usecontactemail)
replyto String indirizzo email da usare per l'header 'Reply-To:'
subject String subject dell'email
preheader String preheader dell'email (testo di anteprima)
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 header aggiuntivi per l'email
attachment list of Attachment allegati aggiuntivi per l'email
idmessagetype (optional) String Usato per raggruppare i messaggi con l'obiettivo di creare dei report. Inserisci l'ID numerico del tipo di messaggi. Usa il metodo getAllSimpleMessageTypes per avere tutti i tipi di simpleMessages
tempvar (optional) list of TypedValue utilizzato per passare le temp var nei template di comunicazione
externalId (optional) String si usa per assegnare un ID esterno a un messaggio di notifica
inputparam (optional) list of TypedValue utilizzato per passare i parametri input nei template di comunicazione. Per utilizzare inputparam è necessario dichiararli prima e scriverli in minuscolo

Attachment

Campo Tipo Descrizione
filename String Nome del file allegato all'email ricevuta
contenttype String MIME del file allegato
body Byte[] Binary body dell'allegato

SmsMessage

Campo Tipo Descrizione
from String telefono mittente per il messaggio, alfanumerico (11 caratteri) o numero di telefono (16 caratteri)
to String numero di telefono a cui inviare l'SMS (opzionale se è fornita l'opzione usecontactcell)
smsbody String contenuto del messaggio, può contenere placeholder [contact:xxx], o link di servizio ([link:unsubscribe], [link:subscribe])
idmessagetype (optional) String Usato per raggruppare messaggi per avere i report 
tempvar (optional) list of TypedValue used to pass temp vars in communication templates
externalId (optional) String Si usa per assegnare un ID esterno a un messaggio di notifica

MNSimpleMessageStatus

Campo Tipo Descrizione
messageId String ID del messaggio transazionale
address String Destinatario email/sms
actualStatus String 'internalError', 'hardBounce', 'waiting', 'sent', 'notSent', 'softBounce', 'sending'
sentDate Date Data di invio
opened Boolean true, se il messaggio è stato aperto
lastOpenedTs Date Data dell'ultimo messaggio aperto
clicked Boolean true, se il messaggio è stato cliccato
lastClickedTs Date Data dell'ultimo messaggio cliccato
converted Boolean true, se il messaggio ha generato una conversione
lastConversionTs Date Data dell'ultima conversione
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 della categoria di bounce
complainted Boolean true se il contatto ha segnalato spam su un messaggio
notSentCause String Detailed cause in the case of actualStatus='notSent', valid values are:
  • 'unknown': unknown cause
  • 'blacklisted_recipient': blacklisted recipient, destination domain is blacklisted
  • 'cancelled': cancelled message delivery
  • 'unsubscribed': unsubscribed contact
  • 'phonerecipient_notallowed': mobile recipient not allowed
  • 'maxsize_exceeded': exceeding the maximum message size
  • 'forbidden_from': from domain in the list of forbidden domains
  • 'forbidden_replyto': reply-to domain in the list of forbidden domains
  • 'forbidden_smsfrom': forbidden alphanumeric SMS sender (e.g.: alphanumeric sender not registered and delivery to Italian numbering)
  • 'forbidden_smsnumericfrom': forbidden numeric SMS sender (e.g.: numeric sender not enabled for the account)
  • 'empty_recipient': empty recipient
  • 'no_credit': out of credit
externalId (optional) String Si usa per assegnare un ID esterno a un messaggio di notifica

MNSendEmailResult

Campo Tipo Descrizione
emailsent boolean  
emailaddress String  
idsimplemessage int  

SendSimpleMessageOperation

Campo Tipo Descrizione
customdata string  
debug String  
idcontact string  
idMessage string  

BatchEmailMessage

Campo Tipo Descrizione
message EmailMessage Messaggio da inviare
options List<Option> Vedi sendEmailMessage per la lista completa delle opzioni disponibili
customdata String Dati opzionali che saranno inviati in BatchEmailMessageOperation

BatchSmsMessage

Campo Tipo Descrizione
message SmsMessage Messaggio SMS da inviare
options List<Option> Vedi sendSmsMessage per la lista completa delle opzioni disponibili
customdata String Dati opzionali che saranno inviati in BatchSmsMessageOperation

BatchEmailMessageOperation

Campo Tipo Descrizione
idmessage String  
customdata String Vedi BatchEmailMessage
ok Boolean  
debug String Pieno in caso di errore

BatchSmsMessageOperation

Campo Tipo Descrizione
idmessage String  
customdata String Vedi BatchSmsMessage
ok Boolean  
debug String Pieno in caso di errore

TypedValue

Campo Tipo Descrizione
name String Nome del parametro
value String Valore del parametro
valueType String Tipo di parametro: "int", "string", "boolean", "date", "datetime".
Per utilizzare "date" e "datetime" vedi formatting dates and date-times.

MNSimpleMessageType

Campo Tipo Descrizione
idMessageType String ID del tipo di messaggio
idMessageCategory String ID della categoria di messaggio
name String Nome del tipo di messaggio

MNSimpleMessageTypeReport

Campo Tipo Descrizione
idMessageType String ID del tipo di messaggio
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

Campo Tipo Descrizione
idMessageCategory String ID della categoria di messaggio
name String Nome della categoria di messaggio