Service de gestion des groupes de destinataires
Contrat WSDLhttp://apitmapreprod.dolist.net/RecipientGroupService.svc?wsdl
Exemple disponible
  • Implémentation en PHP

  • Définition

    Le service de gestion des groupes de destinataires vous permet de récupérer tous les groupes de destinataires et leurs e-mails définis sur la plateforme DOLIST.
    Ces groupes sont une liste d'adresses e-mails destinatrices de compte-rendus d'export et de rapport de statistiques de campagne.
    Récupérez-les et paramétrez vos rapports de statistiques de campagne à partir du service "Courriel de synthèse"

    Récupération de la liste des groupes de destinataires

    Nom de la méthode : GetRecipientGroupList

    Méthode permettant de récupérer les groupes de destinataires et leurs e-mails, définis sur la plateforme DOLIST.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestGetRecipientGroupListRequestParamètres de la requête
    Les valeurs renvoyées
    TypeDescription
    GetRecipientGroupListResultObjet contenant la liste des destinataires, ainsi que le nombre retourné

    AuthenticationTokenContext

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

      GetRecipientGroupListRequest

      ChampTypeDescription

        GetRecipientGroupListResult

        ChampTypeDescription
        CountintNombre retourné par la requête
        RecipientGroupListRecipientGroup[] Liste des groupes de destinataires

          RecipientGroup

          ChampTypeDescription
          IdintIdentifiant du groupe
          NamestringNom du groupe
          RecipientListRecipient[] Liste des destinataires
          NbExportInProgressintNombre d'export en cours pour lesquels ce groupe est destinataire
          NbCouponUsedintNombre de coupon pour lesquels ce groupe est destinataire
          NbReportUsedintNombre de courriel de synthèse pour lesquels ce groupe est destinataire

            Recipient

            ChampTypeDescription
            IdintIdentifiant du destinataire
            EmailstringE mail du destinataire

              ServiceException

              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