Service de gestion des segments
Contrat WSDLhttp://apitmapreprod.dolist.net/V2/SegmentService.svc?wsdl
Exemple disponible
  • Implémentation en PHP.

    • Définition

    Le segment est un filtre permettant de toucher une cible très fine de vos contacts.
    Notre service va vous permettre de créer des segments pour vos campagnes Test/REEL et récupérer les détails de l'ensemble de vos segments disponibles sur notre plateforme.

    Détails d'un segment

    Nom de la méthode : GetSegmentByName

    En fonction du nom du segment, cette méthode vous permet de récupérer son identifiant, sa date de création, les groupes utilisateurs autorisés à le visualiser et le nombre de contacts lors du dernier comptage.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    segmentNamestringNom du segment
    Les valeurs renvoyées
    TypeDescription
    SegmentRenvoie le segment demandé

    Nom de la méthode : GetSegmentByID

    En fonction de l'identifiant du segment, cette méthode vous permet de récupérer son nom, sa date de création, les groupes utilisateurs autorisés à le visualiser et le nombre de contacts lors du dernier comptage.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    segmentIDintIdentifiant du segment
    Les valeurs renvoyées
    TypeDescription
    SegmentRenvoie le segment demandé

    Nom de la méthode : GetAllSegments

    Récupérer l'ensemble de vos segments disponibles sur la plateforme en appelant cette méthode.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    Les valeurs renvoyées
    TypeDescription
    Segment[] Renvoyer l'ensemble des segments

    Création d'un segment Test

    Nom de la méthode : CreateSegmentTest

    Méthode permettant de créer automatiquement un segment Test. En spécifiant une liste d'e-mails tests, le segment correspondant sera automatiquement créé.

    ATTENTION : Les e-mails envoyés doivent être présents en base afin que le segment puisse fonctionner.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    emailsstring[] Liste des emails de test
    Les valeurs renvoyées
    TypeDescription
    SegmentRenvoyer les informations du segment

    Les objets du Service de gestion des segments

    AuthenticationTokenContext

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

      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

        Segment

        Objet représentant un segment.
        ChampTypeDescription
        ContactsCountintLe nombre de contacts email lors du dernier comptage effectué
        CreationDatedateTimeLa date de création du segment
        Groupsint[] Les groupes autorisés
        IdintL'identifiant du segment
        ModifiedDatedateTimeLa date de modification du segment
        NamestringLe nom du segment
        SmsContactsCountintLe nombre de contacts sms lors du dernier comptage effectué

          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