Service de gestion des imports de fichiers de contacts
Contrat WSDLhttp://api.dolist.net/V2/ImportService.svc?wsdl
Exemple disponible
  • Implémentation en PHP.

    • Définition

    Le service de gestion des imports de fichiers de contacts vous permet d'automatiser vos imports par FTP.
    Il vous permet de déclarer l'import d'un ou plusieurs fichiers et de consulter leurs compte-rendus.
    Déclarer votre import de fichier par la méthode "CreateImport".
    Déposer votre fichier sur le FTP Dolist
    Récupérer le compte-rendu de chargement avec la méthode "GetImportReportByID".

    Déclaration d'un import de fichier

    Nom de la méthode : CreateImport

    Cette méthode vous permet de déclarer votre fichier d'import de contacts dans notre base de données.
    Une fois la déclaration effectuée, renommer votre fichier avec le nom ("FileName") retournée par la méthode et déposer-le dans le répertoire "upload/contact/" du FTP Dolist.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    importFileImportFileObjet contenant les caractéristiques de l'import
    Les valeurs renvoyées
    TypeDescription
    ImportReportRenvoie le rapport de chargement

    Rapport de l'import de fichier

    Nom de la méthode : GetImportReportByID

    En appelant cette méthode, vous allez pouvoir récupérer le statut, le rapport complet et l'identifiant du segment de votre import de fichier.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestIDintIdentifiant de la requête de chargement
    Les valeurs renvoyées
    TypeDescription
    ImportReportRenvoie le rapport de chargement demandé

    Les objets du service de gestion des imports de fichiers de contacts

    AuthenticationTokenContext

    ChampTypeDescription
    AccountIDintIdentifiant du client
    KeystringClé du jeton d'authentification
    ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

      ImportFile

      Objet représentant un nouvel import.
      ChampTypeDescription
      CreateSegmentbooleanGénération d'un segment automatiquement
      ImportNamestringNom de l'import (et du segment : SEG-AUTO)
      InterestCenterintCentres d’intérêts
      InterestCenterListint[] Liste des identifiants des centres d'intérêts
      IsRentbooleanAdresses en location
      OptoutintOptout
      ProviderFileNamestringNom du fournisseur du fichier loué
      RentCreditintNombre d'envois autorisé si les adresses sont en location
      ReportAddressesstring[] Rapport à envoyer (4 contacts maximum)
      SegmentUserGroupIdListint[] Liste des identifiants des groupes utilisateurs à affecter au segment
      UpdateContactsbooleanMise à jour des contacts

      Les valeurs des optout possibles sont :
      • 0 : abonné.
      • 8 : désabonné (externe).
      • 9 : injoignable (externe).

      ImportReport

      ChampTypeDescription
      FileNamestringNom du fichier
      HtmlReportstringRapport de chargement au format Html
      RequestIDintIdentifiant de la requête suite au chargement
      SegmentIDintIdentifiant du segment
      StatusintStatut du chargement

      Les valeurs des status possibles sont :
      • -2 : Attente du fichier sur le FTP.
      • -1 : A traiter.
      • 0 / 200 : Chargement en erreur.
      • 100 : Chargement en cours.
      • 1 : Chargement terminé.

      ServiceException

      Exception renvoyée en cas d'erreur à l'appel d'une méthode.
      ChampTypeDescription
      TicketstringLe numéro de ticket
      MessagestringLe message d'erreur
      DescriptionstringLa description de l'erreur
      ErrorCodeTypeErrorCodeTypeType du code de l'erreur
      ErrorCodeintCode de l'erreur

        Liste des erreurs communes

        CodeNomDescription
        0UnexpectedExceptionErreur inattendue
        1AuthenticationExceptionErreur d'authentification
        2NullTokenExceptionLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        3NullRequestExceptionL'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        4ForbiddenActionExceptionL'action demandée n'est pas autorisée
        5InvalidArgumentExceptionLes arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
        6BadRequestExceptionLa requête n'est pas correcte
        7NothingToDoExceptionLa 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
        8InvalidDataTypeExceptionLe type de donnée n'est pas valide
        9UnknownTicketExceptionLe ticket n'est pas connu, vérifiez la valeur de celui-ci
        10UnavailableTicketResultExceptionLe résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
        11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
        999998TokenNullLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
        999999TokenNotAuthorizedL'objet 'token' n'est pas autorisé, vérifiez les propriétés