Service de gestion des statistiques

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

Définition

Le service de gestion des statistiques vous permet de récupérer les statuts de vos contacts, la liste des ouvreurs et des cliqueurs par rapport à un template donné.

Contacts inactifs

Nom de la méthode : GetHardBounceRecipientListByTemplateID

Les 2 méthodes ci-dessous vous permettent de récupérer l'ensemble de vos contacts inactifs par rapport à un template donné.
Les contacts inactifs sont composés de "Hardbounce" et de "Softbounce".

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct en hardbounce

Nom de la méthode : GetSoftBounceRecipientListByTemplateID

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct en softbounce

Ouvertures et clics

Nom de la méthode : GetOpenedRecipientListByTemplateID

Les 2 méthodes ci-dessous vous permettent de récupérer l'ensemble de vos contacts qui ont ouvert ou cliqué le template défini en paramètre.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct ayant ouverts

Nom de la méthode : GetClickedRecipientListByTemplateID

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct ayant cliqué

Gestion des plaintes pour SPAM

Nom de la méthode : GetComplaintRecipientListByTemplateID

Les 2 méthodes suivantes vous permettent de récupérer tous les contacts ayant émis une plainte pour SPAM.
Cette première méthode vous fournit la liste des contacts ayant émis une plainte par rapport à un template donné.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct ayant envoyé une plainte

Contacts désabonnés

Nom de la méthode : GetStopRecipientListByTemplateID

Les 2 méthodes suivantes vous permettent de récupérer tous les contacts désabonnés de votre base.
La première méthode vous fournit la liste des désabonnés par rapport à un template donné.
La seconde méthode vous donnera la liste de l'ensemble de vos désabonnés.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
dateBegin	`dateTime`	La date de début d’intervalle
dateEnd	`dateTime`	La date de fin d’intervalle

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant les destinataires distinct ayant déposé une demande de désabonnement

Nom de la méthode : GetStopRecipientList

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification

Les valeurs renvoyées

Type	Description
`string[]`	Renvoie la liste de tous les destinataires distincts ayant déposés une demande de désabonnement quelque soit le template

Gestion des plaintes pour SPAM

Nom de la méthode : GetComplaintRecipientList

Cette seconde méthode vous donne la liste complète des contacts ayant émis une plainte.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification

Les valeurs renvoyées

Type	Description
`string[]`	Un tableau de string contenant la liste des destinataires

Statut des contacts

Nom de la méthode : GetRecipientStatus

Cette méthode vous donne le statut actuel du contact enregistré sur la plateforme DOLIST-EMT.

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
`RecipientStatusType`	Le statut actuel du destinataire sur la plateforme EMT, valeurs possibles : NoInformation = pas encore d'information, Delivery = abouti, SoftBounce = erreur temporaire, HardBounce= erreur définitive, Complaint = plainte, Unavailable = injoignable (multiples messages softbounces), Stop = désabonné

Les valeurs possibles de RecipientStatusType

NoInformation : pas encore d'information
Delivery : abouti
SoftBounce : erreur temporaire
HardBounce : erreur définitive
Complaint : plainte
Unavailable : injoignable (multiples messages softbounces)
Stop : désabonné

Liste des tickets disponibles

Nom de la méthode : GetMessageTicketListByTemplateID

Cette méthode retourne la liste des tickets demandés en fonction de critères tels que le type de statistiques (Envoyés / Aboutis...), l'intervalle de temps, l'offset...

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'id du template utilisé pour la recherche
statisticType	`StatisticsType`	Le type des stastistiques. valeurs possibles: Sent=envoyés, Delivered=aboutis, WaitingSent=en attente, SoftBounced=erreur temporaire, HardBounced=erreur définitive, Opened=ouverts, Clicked=cliqués, Complaint=plaintes, Stop=désabonnés, Error=en erreur
intervalType	`IntervalType`	Le type d'intervalle. valeurs possibles: Send=dates de debut et de fin d'envoi de message Event=dates de debut et de fin d'événement correspondant au type de statistiques
dateBegin	`dateTime`	La date de début d'intervalle
dateEnd	`dateTime`	La date de fin d'intervalle
offset	`int`	L'index de 1er élément à retourner. 0 par défaut. Lorsque le nombre total de résultats dépasse celui des résultats retournés (maximum autorisé), ce paramètre permet de récuperer le paquet suivant(nombre de résultats + 1)
maxResult	`int`	Le nombre de résultats à retourner. A spécifier pour récupèrer une partie des résultats

Les valeurs renvoyées

Type	Description
`StatisticsResponse`	La liste des tickets correspondants au paramètres spécifiés, le nombre de tickets retournés, le total des résultats satisfaisant la requête

Les valeurs possibles de statisticType

Sent : envoyés
Delivered : aboutis
WaitingSent : en attente
SoftBounced : erreur temporaire
HardBounced : erreur définitive
Opened : ouverts
Clicked : cliqués
Complaint : plaintes
Stop : désabonnés
Error : en erreur

UpdateStatusRecipient

Nom de la méthode : UpdateStatusRecipient

Cette méthode permet de réabonner un contact qui est en statut désabonné ou en hardbounce. Si le réabonnement n'est pas possible la méthode renvoie false, true si le réabonnement a bien été effectué.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
recipient	`string`	L'email du contact à réabonner

Les valeurs renvoyées

Type	Description
`boolean`	Renvoie true si le réabonnement est effectif.

Les objets du service de gestion des statistiques

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)

StatisticsResponse

Champ	Type	Description
Count	`int`	Le nombre de résultats retournés
Tickets	`string[]`	Liste de tickets de messages correspondants à la requête
Total	`int`	Le nombre total des résultats correspondants à la requête

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

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