Service de gestion des messages

Contrat WSDL	http://api.emt.dolist.net/V3/MessageService.svc?wsdl
Ce service est également disponible en SSL, remplacez simplement http par https.

Définition

Le service de gestion des messages vous permet d'envoyer et récupérer toutes les informations relatives aux messages.
Les informations disponibles dans ce service concernent la délivrabilité complète de vos messages et les différentes actions (ouverture / clic / désabonnement...) réalisés sur ces derniers.

Envoi d'un message

Nom de la méthode : SendMessage

Cette méthode vous permet d'envoyer votre message via notre plateforme Dolist-EMT.
Communiquez-nous vos données personnalisées et le destinataire de l'envoi, nous nous chargeons d'envoyer vos messages instantanément.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
message	`SendMessageRequest`	Les données du message à envoyer

Les valeurs renvoyées

Type	Description
`string`	Renvoie une chaine de caractère contenant un ID unique d’identifiant de message

Statut d'un message

Nom de la méthode : GetMessageDeliveryStatusByTicket

Vous pouvez récupérer le statut de votre message en appelant cette méthode.
Un retour vous sera effectué sur le statut de votre message ainsi que les dates de ses différents états et les liste des clics et ouvertures si demandées.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket unique renvoyé par EMT lors de la demande d'envoi du message

Les valeurs renvoyées

Type	Description
`MessageDeliveryStatusType`	Statut actuel du message

Les valeurs possibles pour le statut du message

Pending : En attente d'envoi
InProgress : En cours de diffusion
Delivered : Abouti (si abouti au niveau SMTP et/ou le destinataire a cliqué et/ou le destinataire a ouvert)
SoftBounce : en erreur temporaire
HardBounce : en erreur définitive
Error : en erreur, ne sera pas envoyé
Complaint : une plainte a été déposée
Stop : une demande de désabonnement a été faite
SoftBounceSpam : erreur temporaire pour spam

Nom de la méthode : GetMessageStatusByTicket

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket unique renvoyé par EMT lors de la demande d'envoi du message
loadTrackingOpenList	`boolean`	si vrai renvoie la liste des ouvertures du message
loadTrackingClickList	`boolean`	si vrai renvoie la liste des clics du message

Les valeurs renvoyées

Type	Description
`GetMessageStatusResponse`	Renvoie l'état de livraison du message, son état d'activité, les dates de ses différents états et les liste des clics et ouvertures si demandées

Synthèse d'un message

Nom de la méthode : GetMessageByTicket

Cette méthode vous permet de récupérer l'ensemble des informations détaillés de votre message.
Vous disposerez de toutes les informations concernant le statut (Abouti / non abouti), les dernières dates d'ouverture, de clic, de plainte... ainsi que la liste des ouvertures et clics pour votre message.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket unique renvoyé par EMT lors de la demande d'envoi du message

Les valeurs renvoyées

Type	Description
`GetMessageResponse`	Un objet GetMessageResponse qui contient toutes les informations détaillés du message

Récupération du message

Nom de la méthode : GetMessageContentByTicket

Cette méthode vous permet de récupérer le contenu, l'expéditeur, l'adresse de réponse, le sujet ... de votre message.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket unique renvoyé par EMT lors de la demande d'envoi du message
templateContentType	`TemplateContentType`	Le type de contenu désiré

Les valeurs renvoyées

Type	Description
`GetMessageContentResponse`	Un objet GetMessageContentResponse avec le contenu du message

Les valeurs possibles pour le type de contenu

1 : Html
2 : Text

Nom de la méthode : GetMessageListByRecipient

En complément de la méthode "GetMessageByTicket", cette méthode vous permet de récupérer l'ensemble des informations détaillés des messages envoyés à un destinataire précis.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
recipient	`string`	L'email du destinataire

Les valeurs renvoyées

Type	Description
`GetMessageResponse[]`	Une liste de messages

Nom de la méthode : GetMessageActivityStatusByTicket

Cette méthode vous indique si une action (ouverture / clic) a été réalisée sur votre message.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket unique renvoyé par EMT lors de la demande d'envoi du message

Les valeurs renvoyées

Type	Description
`MessageActivityStatusType`	Le statut d'activité du message, les valeurs possibles : Open : au moins une ouverture, Click : au moins un clic, None : pas d'activité pour ce message

Les valeurs possibles pour le statut d'activité du message

Open : au moins une ouverture
Click : au moins un clic
None : pas d'activité pour ce message

Les objets du service de gestion des messages

AuthenticationTokenContext

Champ	Type	Description
AccountID	`int`	Identifiant du client
Key	`string`	Clé du jeton d'authentification
ListID	`int`	Identifiant du client: obsolète. Utilisez AccountID à la place

ServiceException

Champ	Type	Description
Ticket	`string`	Un numéro identifiant l'exception, utilisé pour le suivi de l'erreur
Message	`string`	Le message décrivant l'erreur
Description	`string`	La description détaillée de l'erreur
ErrorCode	`ErrorCodeType`	Code identifiant le type d'erreur (se référrer à la doc pour la liste des codes possibles)

SendMessageRequest

Champ	Type	Description
Attachments	`MailAttachment[]`	La collection des pièces jointes du message
Data	`string`	Données variables du message : chaine XML ( se référer à l'onglet Envoi de test dans le module de creation de campagne)
IsTest	`boolean`	(optionnel) indique si on envoie un message de test, faux par défaut (si votre template n'est pas validé, vos envois sont limités aux 10 adresses définis dans l'onglet administration
MessageContentType	`ContentType`	Le type d'envoi (string): 3 valeurs possibles -> EmailMultipart, EmailHtmlOnly, EmailTextOnly
Recipient	`string`	L'adresse du destinataire
RecipientExternalID	`string`	(optionnel) Identifiant externe du destinataire fourni par votre SI, par défaut l'email
TemplateID	`int`	L'identifiant du template
UniqueExternalID	`string`	(optionnel) Identifiant unique de message fourni par votre SI

GetMessageStatusResponse

Champ	Type	Description
ActivityStatus	`MessageActivityStatusType`	Le statut d'activité du message, les valeurs possibles : Open : au moins une ouverture, Click : au moins un clic, None : pas d'activité pour ce message
ComplaintDate	`dateTime`	Date de reception d'une plainte pour ce message, 01/01/1900 si pas de plainte
DeliveryStatus	`MessageDeliveryStatusType`	Le statut de livraison actuel du message
ErrorDate	`dateTime`	Date de mise en erreur du message, 01/01/1900 si pas en erreur
LastClickedDate	`dateTime`	Dernière date de clic sur un lien du message, 01/01/1900 si pas de clic
LastDeliveredDate	`dateTime`	Dernière date de livraison du message, 01/01/1900 si pas encore délivré
LastHardBounceDate	`dateTime`	Dernière date de mise en hardbounce du message, 01/01/1900 si jamais en hardbounce
LastOpenedDate	`dateTime`	Dernière date d'ouverture, 01/01/1900 si pas d'ouverture
LastSoftBounceDate	`dateTime`	Dernière date de mise en soft bounce du message, 01/01/1900 si jamais en softbounce
StopDate	`dateTime`	Date de reception d'une demande de désabonnement, 01/01/1900 si pas de demande de désabonnement
TrackingClickList	`TrackingClick[]`	Detail des clics
TrackingOpenList	`TrackingOpen[]`	Detail des ouvertures

Les valeurs possibles pour DeliveryStatus

Pending : En attente d'envoi
InProgress : En cours de diffusion
Delivered : Abouti (si abouti au niveau SMTP et/ou le destinataire a cliqué et/ou le destinataire a ouvert)
SoftBounce : en erreur temporaire
HardBounce : en erreur définitive
Error : en erreur, ne sera pas envoyé
Complaint : une plainte a été déposée
Stop : une demande de désabonnement a été faite
SoftBounceSpam : erreur temporaire pour spam

TrackingClick

Champ	Type	Description
Browser	`string`	Le navigateur du cliqueur
Date	`dateTime`	La date du clic
IP	`string`	L'adresse IP du cliqueur
OS	`string`	Le système d'exploitation du cliqueur
OriginalUrl	`string`	L'url du lien cliqué
ReferenceID	`int`	L'identifiant du lien sur EMT

TrackingOpen

Champ	Type	Description
Browser	`string`	Le navigateur de l'ouvreur
Date	`dateTime`	La date d'ouverture
IP	`string`	L'adresse IP de l'ouvreur
OS	`string`	Le système d'exploitation de l'ouvreur

GetMessageResponse

Champ	Type	Description
ActivityStatus	`MessageActivityStatusType`	Le statut d'activité du message, les valeurs possibles : Open : au moins une ouverture, Click : au moins un clic, None : pas d'activité pour ce message
ComplaintDate	`dateTime`	Date de reception d'une plainte
CurrentStatus	`string`	Obsolete : utilisez la propriété DeliveryStatus à la place
DeliveryStatus	`MessageDeliveryStatusType`	Le statut de livraison actuel du message
ErrorDate	`dateTime`	Date de mise en erreur du message
ErrorMessage	`string`	Message d'erreur : rempli si ErrorDate > 01/01/1900
LastClickedDate	`dateTime`	Dernière date de clic sur un lien du message
LastDeliveredDate	`dateTime`	Dernière date de confirmation de livraison du message
LastHardBounceDate	`dateTime`	Dernière date de mise en hard bounce du message
LastOpenedDate	`dateTime`	Dernière date d'ouverture
LastSoftBounceDate	`dateTime`	Dernière date de mise en soft bounce du message
MessageContentType	`ContentType`	le type de message envoyé (string) : 3 valeurs possibles -> EmailMultipart, EmailHtmlOnly, EmailTextOnly
Recipient	`string`	L'email du destinataire
RecipientExternalID	`string`	Identifiant externe du destinataire fourni par votre SI, par défaut l'email
SentDate	`dateTime`	La date d'envoi du message (fin du dialogue smtp avec serveur d'envoi)
StopDate	`dateTime`	Date de reception d'une demande de désabonnement
TemplateID	`int`	L'identifiant du template
Ticket	`string`	Le ticket unique du message
UniqueExternalID	`string`	Identifiant unique de message fourni par votre SI

Les valeurs possibles pour DeliveryStatus

Pending : En attente d'envoi
InProgress : En cours de diffusion
Delivered : Abouti (si abouti au niveau SMTP et/ou le destinataire a cliqué et/ou le destinataire a ouvert)
SoftBounce : en erreur temporaire
HardBounce : en erreur définitive
Error : en erreur, ne sera pas envoyé
Complaint : une plainte a été déposée
Stop : une demande de désabonnement a été faite
SoftBounceSpam : erreur temporaire pour spam

GetMessageContentResponse

Champ	Type	Description
Content	`string`	Le contenu du message
FromMail	`string`	Le mail from
FromName	`string`	Le nom affiché dans le from
ReplyToMail	`string`	Le mail de replyto
ReplyToName	`string`	Le nom affiché dans le reply
Subject	`string`	Le sujet

MailAttachment

Champ	Type	Description
FileExtension	`FileExtension`	L'extension du fichier. Valeurs possibles: PDF,DOC,XLS,DOCX,XLSX,PNG,RAR,ZIP,GIF,JPG,JPEG,TXT,HTML,HTM,PPT,RTF,BMP,ICS. La valeur doit être renseignée en respectant la casse (majuscules).
FileName	`string`	Le nom du fichier
FileStream	`string`	Le contenu du fichier encodé en base-64

Les valeurs possibles pour FileExtension

PDF
DOC / DOCX
XLS / XLSX
PNG
RAR / ZIP
GIF
JPG / JPEG
TXT
HTML / HTM
PPT
RTF
BMP
ICS

Liste des erreurs communes

Code	Nom	Description
0	`UnexpectedException`	Erreur inattendue
1	`AuthenticationException`	Erreur d'authentification
2	`NullTokenException`	Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
3	`NullRequestException`	L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
4	`ForbiddenActionException`	L'action demandée n'est pas autorisée
5	`InvalidArgumentException`	Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
6	`BadRequestException`	La requête n'est pas correcte
7	`NothingToDoException`	La requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois
8	`InvalidDataTypeException`	Le type de donnée n'est pas valide
9	`UnknownTicketException`	Le ticket n'est pas connu, vérifiez la valeur de celui-ci
10	`UnavailableTicketResultException`	Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
11	`InvalidDatePeriodException`	L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
999998	`TokenNull`	Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
999999	`TokenNotAuthorized`	L'objet 'token' n'est pas autorisé, vérifiez les propriétés