| Service de gestion des campagnes e-mailing |
|
DéfinitionLe service de gestion des campagnes e-mailing vous permet de piloter la création et l'envoi de vos campagnes.
Vous pourrez ainsi créer une campagne e-mailing (définition du nom d'expéditeur, sujet...), envoyer un ou plusieurs BAT, envoyer votre campagne en mode REEL et récupérer son état d'avancement.
|
 Nom de la méthode : CreateCampaign
Cette méthode permet de créer une campagne.
Vous définirez le nom et l'adresse e-mail de l'expéditeur ainsi que le nom et l'adresse de réponse, le message HTML/Texte, le sujet de votre campagne, le nom de domaine du tracking.
Tous ces éléments sont configurables à partir de l'objet "CampaignEmail".
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
int | Renvoie l'identifiant de la campagne créée |
|
|
Nom de la méthode : SendCampaignTestCette méthode permet d'envoyer un BAT.
Précisez l'identifiant de votre campagne ainsi que l'identifiant du segment et votre campagne Test sera prise en compte dans les plus brefs délais.
|
| Les paramètres attendus en entrée |
| Champ | Type | Description |
|---|
| token | AuthenticationTokenContext | Jeton d'authentification | | campaignId | int | Identifiant de la campagne | | segmentId | int | Identifiant du segment |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
string | Renvoie le ticket de la demande |
|
|
Nom de la méthode : SendCampaignL'appel de cette méthode vous permet d'envoyer votre campagne en mode REEL à un segment de votre base de contacts. Précisez la date et le volume d'envois selon une fréquence définie et votre campagne sera envoyée dans vos conditions.  | Nous vous conseillons de faire des envois TEST avant vos envois en mode REEL. Ils sont illimités.
|
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
string | Renvoie le ticket de la demande |
|
|
Nom de la méthode : GetCampaignStatusByTicketVous pouvez récupérer le statut de votre campagne en appelant cette méthode.
Un retour vous sera effectué sur le statut de la campagne (Acceptée / Rejetée) ainsi que le nombre de contacts générés et envoyés.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Mise en pause d'une campagneNom de la méthode : PauseCampaignCette méthode vous permet de mettre en pause une campagne e-mailing en cours d'envoi.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la demande est valide et prise en compte |
|
|
Nom de la méthode : ResumeCampaignCette méthode vous permet de reprendre une campagne e-mailing si cette dernière a été mise en pause.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la demande est valide et prise en compte |
|
|
Annulation d'une campagneNom de la méthode : CancelCampaignCette méthode vous permet d'annuler une campagne e-mailing.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la demande est valide et prise en compte |
|
|
Nom de la méthode : GetCampaignsCette méthode vous permet de récupérer la liste de vos campagnes classiques et leurs propriétés en fonction des paramètres définis.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Nom de la méthode : GetCampaignsIDCette méthode vous permet de récupérer seulement les identifiants de vos campagnes classiques en fonction des paramètres définis.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Les objets du service de gestion des campagnes e-mailing |
AuthenticationTokenContext |
| Le paramètre Key doit être renseigné avec le token renvoyé par le service d'Authentification. |
| 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 |
|
CampaignEmail |
|
| Champ | Type | Description |
|---|
| Culture | string | Culture de la campagne | | FormatLinkTechnical | FormatLink | Type d'affichage pour les liens techniques (Html / Texte) | | FromAddressPrefix | string | Préfix de l'adresse de l'expéditeur | | FromName | string | Nom de l'expéditeur | | GoogleAnalyticsTracking | GoogleAnalyticsTracking | Interfaçage avec Google Analytics | | ID | int | Identifiant de la campagne | | Message | MessageEmail | Message de la campagne | | PrepaidSendingMode | PrepaidSendingMode | Mode d'envoi en prépayé si les crédit sont insuffisant à l'heure d'envoi | | ReplyAddress | string | Adresse de réponse | | ReplyName | string | Nom de réponse | | Subject | string | Sujet / Objet | | TrackingDomain | string | Domaine du tracking | | UnsubscribeFormId | int | Identifiant du lien de désabonnement | | VersionOnline | boolean | Ajout du lien pour la version en ligne |
Le paramètre "Culture" accepte les valeurs : "fr", "en". Ce paramètre est nécessaire pour les liens mis automatiquement par DOLIST (version en ligne par exemple). Le paramètre "FormatLink" accepte les valeurs : "Html", "Text" Le "domaine de tracking" nécessite la mise en place du pack délivrabilité au préalable. |
GoogleAnalyticsTracking |
| Paramètres pour un interfaçage avec Google Analytics |
| Champ | Type | Description |
|---|
| GoogleProfileID | int | Identifiant du profil Google Analytics | | GoogleVariableList | GoogleVariable[]
| Liste des variables Google Analytics |
|
GoogleVariable |
| Variables pour le tracking Google Analytics |
| Champ | Type | Description |
|---|
| ID | int | Identifiant de la variable Google Analytics | | Value | string | Valeur de la variable Google Analytics (30 caractères max et alphanumérique avec espace,-,_,/) |
Liste des variables disponible avec les ID suivants : - L'ID 1 (Obligatoire) - utm_campaign - Correspond au nom de la campagne utilisé par Google Analytics. Il sera composé du libellé saisi ici et de l'identifiant de la campagne généré
- L'ID 2 (facultatif) - utm_source - Correspond à la source de la campagne. Indique la provenance (ex: DoList) de la campagne permettant d'affiner la segmentation au niveau des statistiques
- L'ID 3 (facultatif) - utm_medium - Indique le média (ex: e-mail) par le biais duquel la campagne a été générée permettant d'affiner la segmentation au niveau des statistiques
- L'ID 4 (facultatif) - utm_term - Correspond au mot clé à associer à la campagne
|
MessageEmail |
| Vous avez la possibilité d'utiliser un message existant en renseignant le champ Id ou alors de créer un nouveau message. |
| Champ | Type | Description |
|---|
| ContentHtml | string | Contenu du message au format Html | | ContentText | string | Contenu du message au format texte | | Encoding | string | Encodage du message | | Id | int | Identifiant du message | | MessageType | MessageType | Type du message | | Name | string | Nom du message |
Dans le cas où vous créez un nouveau message, vous devez renseigner le champ ContentHtml ou ContentText. Si vous choissisez le format HTML (ContentHtml), la campagne e-mailing sera envoyée au format Multipart (HTML et TEXT). Le paramètre "Encoding" accepte les valeurs : Le paramètre "MessageType" accepte les valeurs : - utf-8
- iso-8859-1, iso-8859-2,iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7,iso-8859-8,iso-8859-9,iso-8859-13,iso-8859-15
- IncludeEncodedImages - Images encodées dans le message
- IncludeImageLinks - Message HTML avec images externes
|
Planning |
|
| Champ | Type | Description |
|---|
| SendDate | dateTime | Date d'envoi |
Le format attendu du champ SendDate est "dateTime" (ex : 2017-12-24T23:59:00). |
Frequency |
| Lors de l'envoi, vous déterminez la vitesse d'envoi. |
| Champ | Type | Description |
|---|
| Period | int | Période en secondes | | Volume | int | Nombre de message |
|
CampaignReport |
|
| Champ | Type | Description |
|---|
| CampaignId | int | Identifiant de la campagne | | OutMember | int | Nombre de contacts générés | | OutMemberSent | int | Nombre de contacts envoyés | | Status | int | Statut de la campagne | | StatusDescription | string | Description du statut |
|
GetCampaignsRequest |
|
|
CampaignFilter |
|
| Champ | Type | Description |
|---|
| AllCampaigns | boolean | Toutes les campagnes | | Date | dateTime | Date à partir de laquelle les campagnes sont récupérées | | LastCampaigns | int | Les X dernières campagnes | | Offset | int | Offset (pagination des résultats) |
Le format attendu du champ Date est "dateTime" (ex : 2017-12-24T23:59:00). Le champ Offset est obligatoire. Dans le cas de récupération de l'ensemble des campagnes, vous pouvez mettre par défaut la valeur "0". |
GetCampaignsResult |
|
| Champ | Type | Description |
|---|
| CampaignDetailsList | CampaignDetails[]
| Liste des campagnes |
|
CampaignDetails |
|
| Champ | Type | Description |
|---|
| CreationDate | dateTime | Date de création de la campagne | | FromAddressPrefix | string | Préfix de l'adresse de l'expéditeur | | FromName | string | Nom de l'expéditeur | | GoogleProfileID | int | Identifiant du profil Google Analytics de la campagne | | ID | int | Identifiant de la campagne | | MessageID | int | Identifiant du message | | MessageName | string | Nom du message | | OnlineVersion | boolean | Ajout du lien pour la version en ligne | | ReplyAddress | string | Adresse de réponse | | ReplyName | string | Nom de réponse | | SegmentID | int | Identifiant du segment | | SendDate | dateTime | Date d'envoi de la campagne | | Subject | string | Sujet / Objet | | TrackingDomain | string | Domaine du tracking | | UnsubscribeFormID | int | Identifiant du lien de désabonnement |
|
GetCampaignsIDRequest |
|
|
GetCampaignsIDResult |
|
| Champ | Type | Description |
|---|
| CampaignIDList | int[]
| Liste des identifiants de campagnes |
|
ServiceException |
|
| Champ | Type | Description |
|---|
| Ticket | string | Le numéro de ticket | | Message | string | Le message d'erreur | | Description | string | La description de l'erreur | | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | | ErrorCode | int | Code de l'erreur |
|
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 |
|