Mentions légales
Contrat WSDLhttp://api.dolist.net/V2/SmsService.svc?wsdl
Exemple disponible

Définition

Le site api.dolist.net est édité par Dolist.net et déclaré à la Cnil sous le numéro : 1028443.

DOLIST.NET
16, avenue Pythagore Pelus Plaza
Immeuble 1 Hall B
33700 MERIGNAC

France Société par Actions Simplifiée au capital de 26 112 €
N° SIREN : 432 711 521
N° APE : 722 C

Directeur de la Publication : Jean-Paul LIEUX, Président de la société Dolist.net.

Contact

Nous vous invitons à nous contacter par courrier électronique à l'adresse info@dolist.net ou par courrier postal pour toutes vos questions ou demandes d'information.

Informations techniques

L'utilisation du site api.dolist.net, via l'utilisation son adresse Url http://api.dolist.net/doc, implique la connaissance et l'acceptation des caractéristiques et limites d'Internet notamment en ce qui concerne les performances techniques, les temps de réponse, l'absence de protection absolue contre les risques de détournements éventuels et de contamination par d'éventuels virus circulant sur le réseau Internet. Dolist.net ne peut être tenu responsable du mauvais fonctionnement du site pour un navigateur donné. Dolist.net ne garantit pas que son service fonctionne sans interruption ou qu'il ne contienne pas d'erreurs informatiques quelconques.

Données collectées à l'occasion de la consultation du site

Notre site est susceptible de collecter des données sur la date, les pages consultées, le temps de consultation, ainsi que le fournisseur d'accès, le moteur de recherche, le lien à l'origine de la consultation. Cette collecte permet d'améliorer l'ergonomie de notre site, de simplifier votre accès à notre site.

Propriété intellectuelle

Dolist.net est seul titulaire des droits d’auteurs sur le contenu de son site api.dolist.net.
Toute reproduction ou représentation totale ou partielle, faite sans le consentement de Dolist.net constitue une contrefaçon pénalement sanctionnée. Dolist.net est titulaire des droits sur le logo de Dolist.net. Toute reproduction totale ou partielle du logo sans le consentement de Dolist.net constitue une contrefaçon pénalement sanctionnée.

Responsabilité quant aux liens hypertextes


Nom de la méthode : GetMessage

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
messageIdintIdentifiant du message
Les valeurs renvoyées
TypeDescription
MessageRenvoie l'objet "Message" demandé

Nom de la méthode : CreateMessage

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
messageMessageObjet "Message"
Les valeurs renvoyées
TypeDescription
MessageRenvoie l'objet "Message" créé

Nom de la méthode : UpdateMessage

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
messageMessageObjet "Message"

Nom de la méthode : CreateCampaign

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
messageIdintIdentifiant du message
listUsersGroupsint[] Identifiants des groupes utilisateurs
senderIdintIdentifiant de l'expéditeur personnalisé
Les valeurs renvoyées
TypeDescription
intRenvoie l'identifiant de la campagne créée

Nom de la méthode : GetCampaign

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
campaignIdintIdentifiant de la campagne
Les valeurs renvoyées
TypeDescription
SmsCampaignRenvoie l'objet "SmsCampaign"

Nom de la méthode : SendCampaignSimulate

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
requestSendCampaignSimulateRequestInformations sur la demande de simulation

Nom de la méthode : SendCampaign

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
campaignIdintIdentifiant de la campagne
segmentIdintIdentifiant du segment
sendDatedateTimeDate d'envoi
defaultPrefixstringPréfixe téléphonique international par défaut (ex: "+33" pour la France)
memberActionintAction à mener sur les contacts multiples

Nom de la méthode : SendCampaignBAT

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
campaignIdintIdentifiant de la campagne
segmentIdintIdentifiant du segment
defaultPrefixstringPréfixe téléphonique international par défaut (ex: "+33" pour la France)
memberActionintAction à mener sur les contacts multiples

Nom de la méthode : GetSender

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
senderIdintIdentifiant de l'expéditeur personnalisé
Les valeurs renvoyées
TypeDescription
SmsSenderRenvoie l'objet "Expéditeur personnalisé"

Nom de la méthode : GetSenders

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
Les valeurs renvoyées
TypeDescription
SmsSender[] Renvoie la liste des objets "Expéditeur personnalisé"

Nom de la méthode : CreateSender

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
namestringNom de l'expéditeur personnalisé
Les valeurs renvoyées
TypeDescription
intRenvoie l'identifiant de l'expéditeur personnalisé créé

Nom de la méthode : UpdateSender

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
senderSmsSenderObjet "Expéditeur personnalisé"
Les valeurs renvoyées
TypeDescription
booleanIndique si la mise à jour a été effectuée

Nom de la méthode : DeleteSender

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
senderIdintIdentifiant de l'expéditeur personnalisé
Les valeurs renvoyées
TypeDescription
booleanIndique si la suppression a été réussie

Nom de la méthode : GetCampaigns

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
filtersCampaignFilterCritères de filtrage
Les valeurs renvoyées
TypeDescription
SmsCampaign[] Liste des objets "SmsCampaign"

Nom de la méthode : GetCampaignsId

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
filtersCampaignFilterCritères de filtrage
Les valeurs renvoyées
TypeDescription
int[] Liste des identifiants de campagnes

Nom de la méthode : GetStatistics

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextAuthentification
campaignsIdint[] Liste des identifiants de campagnes SMS
Les valeurs renvoyées
TypeDescription
SmsStatistics[] Liste des objets "SmsStatistics"

AuthenticationTokenContext

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

    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

      Message

      ChampTypeDescription
      IdintIdentifiant du message
      LengthintNombre de caractères présents dans le message
      NamestringNom du message
      TextstringContenu du message
      UpdateDatedateTimeDate de la dernière modification
      UserGroupIdListint[] Identifiants des groupes utilisateurs

        SmsCampaign

        ChampTypeDescription
        ActionMembersMultipleintAction sur les contacts multiples
        DateCreatedateTimeDate de création
        DateSenddateTimeDate d'envoi
        DefaultPrefixstringPréfixe téléphonique international utilisé par défaut
        IdintIdentifiant de la campagne
        ListIdintIdentifiant de la base
        MessageMessageMessage associé
        NbMembersintNombre de contacts destinataires
        NbMembersRefusedintNombre de contacts refusés
        NbMobileDistinctintNombre distinct de contacts destinataires
        NbSMSintNombre de SMS envoyés
        NbSimulateMembersintNombre de contacts destinataires déterminés lors de la dernière simulation d'envoi
        NbSimulateMembersRefusedintNombre de contacts refusés déterminés lors de la dernière simulation d'envoi
        NbSimulateMobileDistinctintNombre distinct de mobiles déterminés lors de la dernière simulation d'envoi
        NbSimulateSMSDistinctintNombre de SMS à envoyer sur les mobiles uniques déterminés lors de la dernière simulation d'envoi
        NbSimulateSmsintNombre de SMS à envoyer déterminés lors de la dernière simulation d'envoi
        SegmentIdintIdentifiant du segment
        StatusintStatut de la campagne
        TestModebooleanIndique s'il s'agit d'un BAT

          SendCampaignSimulateRequest

          ChampTypeDescription
          CampaignIdintIdentifiant de la campagne
          DefaultPrefixstringPréfixe téléphonique international par défaut (ex: "+33" pour la France)
          SegmentIdintIdentifiant du segment

            SmsSender

            ChampTypeDescription
            IdintIdentifiant de l'expéditeur personnalisé
            NamestringNom de l'expéditeur personnalisé

              CampaignFilter

              ChampTypeDescription
              AllCampaignsbooleanToutes les campagnes
              CampaignsRecentlySentCountintLes X dernières campagnes
              DatedateTimeDate à partir de laquelle les campagnes doivent être récupérées

                SmsStatistics

                ChampTypeDescription
                CampaignIdintIdentifiant de la campagne
                SmsDeliveredCountintNombre de SMS aboutis
                SmsPendingCountintNombre de SMS en cours d’envoi ou erreur temporaire
                SmsRejectedCountintNombre de SMS en erreur définitive
                SmsSentCountintNombre de SMS envoyés
                SmsUnitInternationalSentCountintNombre de SMS unitaires envoyés à l'international
                SmsUnitNationalSentCountintNombre de SMS unitaires envoyés en France
                SmsUnitSentCountintNombre de SMS unitaires envoyés
                UnsubscribedCountintNombre de contacts désabonnés

                  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