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

    • Définition

    Le service de gestion des messages vous permet de créer, modifier, récupérer ou supprimer vos maquettes HTML/Texte.
    Chaque méthode est indépendante et vous pourrez gérer vos maquettes HTML/TEXTE comme vous le souhaitez.

    Création d'un message

    Nom de la méthode : CreateMessage

    Cette méthode vous permet de créer vos messages HTML/TEXTE.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestCreateMessageRequestDonnées nécessaires à la création du message
    Les valeurs renvoyées
    TypeDescription
    intRenvoie l'identifiant du message créé

    Modification d'un message

    Nom de la méthode : UpdateMessage

    Appelez cette méthode dès que vous avez besoin d'effectuer une modification sur votre message HTML/Texte.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestUpdateMessageRequestDonnées nécessaires à la mise à jour du message
    Les valeurs renvoyées
    TypeDescription
    booleanRenvoie true si la mise à jour s'est terminée avec succès

    Suppression d'un message

    Nom de la méthode : DeleteMessage

    Cette méthode vous permet d'effacer un ou plusieurs messages HTML/TEXTE.

    ATTENTION : Ne pas supprimer un message si vous avez besoin d'envoyer une campagne e-mailing sur ce dernier.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    messageIDintIdentifiant du message à supprimer
    Les valeurs renvoyées
    TypeDescription
    booleanRenvoie true si la suppression s'est terminée avec succès

    Récupération d'un message

    Nom de la méthode : GetMessage

    Cette méthode vous permet de récupérer les détails de vos messages HTML/TEXTE.
    En fonction de l'identifiant passé, vous récupérerez le nom du message, le type de message, le contenu HTML/TEXTE et le type d'encondage.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestGetMessageRequestCritères de recherche des messages
    Les valeurs renvoyées
    TypeDescription
    GetMessageResponseRenvoie l'objet contenant la liste des messages correspondant aux critères de recherche

    Récupération d'une liste de messages

    Nom de la méthode : GetMessageList

    Cette méthode permet de récupérer une liste de messages
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestGetMessageListRequestCritères de recherche des messages
    Les valeurs renvoyées
    TypeDescription
    GetMessageListResultRenvoie l'objet contenant la liste des messages correspondant aux critères de recherche

    Les objets du service de gestion des messages

    AuthenticationTokenContext

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

      GetMessageListRequest

      la classe hérite de : BaseServiceRequest
      ChampTypeDescription
      Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
      UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
      StaticFieldListstring[] (Facultatif) - Liste de champs statiques
      StartDatestring(Facultatif) - Date de début (format : AAAA-MM-JJ)
      EndDatestring(Facultatif) - Date de fin - (format : AAAA-MM-JJ)
      SortOrderSortOrder(Facultatif) - Ordre de tri (ASC / DESC)
      Offsetint(Facultatif) - L'indice du 1er élément à récupérer
      Limitint(Facultatif) - L'indice du dernier élément à récupérer
      MessageFilterMessageFilter(Facultatif) - Champ et valeur de recherche

      La StaticFieldList peut contenir les champs suivants :
      • Name - Nom du message
      • Type - Le type du message. 1: Les images externes 2: Message Texte 3:Les images encodées dans le message
      • Encoding - Encoding du message
      • ContentTxt - Contenu texte du message
      • ContentHTML - Contenu HTML du message
      • Date - Date de création du message
      • CultureID - Identifiant de la culture du message

      BaseServiceRequest

      ChampTypeDescription
      Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
      UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur

        MessageFilter

        ChampTypeDescription
        FilterstringValeur à rechercher
        ScopeFilterScopeFilterChamp de recherche

        Le ScopeFilter peut contenir un des choix suivants :
        • Name - Tri sur le nom des messages
        • NameAndContent - Tri sur le nom ou les contenus des messages
        • Content - Tri sur les contenus (HTML et Text) des messages

        GetMessageListResult

        ChampTypeDescription
        MessagesCountintNombre de messages retournés
        MessageEmailListDetailedMessageEmail[] Liste des identifiants des messages et des champs statiques

          DetailedMessageEmail

          la classe hérite de : BaseMessages
          ChampTypeDescription
          ProjectIdintIdentifiant du message
          StaticFieldValueListStaticFieldValue[] Liste des champs voulus par l'utilisateur

            BaseMessages

            ChampTypeDescription
            ProjectIdintIdentifiant du message
            StaticFieldValueListStaticFieldValue[] Liste des champs voulus par l'utilisateur

              StaticFieldValue

              ChampTypeDescription
              NamestringNom système du champ retourné
              ValuestringValeur du champ

                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

                  CreateMessageRequest

                  ChampTypeDescription
                  ContentHtmlstringContenu HTML du message
                  ContentTextstringContenu texte du message
                  EncodingstringEncoding du message
                  MessageTypeMessageTypeIncludeEncodedImages:Les images encodées dans le message, IncludeImageLinks: Les images externes
                  NamestringNom du message

                  Vous devez définir au minimum un champ "Content".Les 2 ne sont pas obligatoires.
                  Le champ "MessageType" correspond au type de message souhaité :
                  • IncludeEncodedImages - Les images encodées dans le message.
                  • IncludeImageLinks - Les images sont externes et hébergées sur un serveur.

                  UpdateMessageRequest

                  ChampTypeDescription
                  ContentHtmlstringContenu HTML du message
                  ContentTextstringContenu texte du message
                  EncodingstringEncoding du message
                  MessageIDintIdentifiant du message
                  MessageTypeMessageTypeLe type du message. Undefined:pas de mise à jour du champ, IncludeEncodedImages:Les images encodées dans le message, IncludeImageLinks: Les images externes
                  NamestringNom du message

                  Vous devez définir au minimum un champ "Content".Les 2 ne sont pas obligatoires.
                  Le champ "MessageType" correspond au type de message souhaité :
                  • Undefined - Pas de mise à jour du champ
                  • IncludeEncodedImages - Les images encodées dans le message<
                  • IncludeImageLinks - Les images sont externes et hébergées sur un serveur.

                  GetMessageRequest

                  ChampTypeDescription
                  MessageIDintIdentifiant du message

                    GetMessageResponse

                    ChampTypeDescription
                    MessageListMessageEmail[] Liste des messages
                    MessagesCountintLe nombre de messages retournés

                      MessageEmail

                      ChampTypeDescription
                      ContentHtmlstringContenu HTML du message
                      ContentTextstringContenu texte du message
                      EncodingstringEncoding du message
                      MessageIDintIdentifiant du message
                      MessageTypeMessageTypeLe type du message. 1:Les images encodé dans le message, 2: Les images externes
                      NamestringNom du message

                      Le champ "MessageType" correspond au type de message enregistré
                      • 1 - Les images encodées dans le message
                      • 2 - Les images sont externes et hébergées sur un serveur.

                      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