Service de gestion des statistiques sms
Contrat WSDLhttp://api.emt.dolist.net/V3/SmsStatisticService.svc?wsdl
Ce service est également disponible en SSL, remplacez simplement http par https.

Définition

Le service de gestion des statistiques vous permet de récupérer les statuts de vos contacts par rapport à un template donné.

Liste des destinataires par template

Nom de la méthode : GetRecipientListByTemplateID

Cette méthode permet de récupérer la liste des destinataires par template
Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
requestGetRecipientListByTemplateIDRequestObjet contenant les informations concernant la méthode
Les valeurs renvoyées
TypeDescription
GetRecipientListByTemplateIDResultLa liste des informations des destinataires

Information destinataire

Nom de la méthode : GetRecipient

Cette méthode permet de récupérer les informations concernant un destinataire
Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
recipientstringNuméro de mobile
Les valeurs renvoyées
TypeDescription
SmsRecipientLes informations du destinataire demandé

Liste des messages par template

Nom de la méthode : GetMessageTicketListByTemplateID

Cette méthode permet de récupérer la liste des messages sms envoyés par template
Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
requestGetMessageTicketListByTemplateIDRequestObjet contenant les informations concernant la méthode
Les valeurs renvoyées
TypeDescription
GetMessageTicketListByTemplateIDResultLa liste des messages sms

Les objets du service de gestion des statistiques sms

GetRecipientListByTemplateIDRequest

ChampTypeDescription
DateBegindateTimeDate de début
DateEnddateTimeDate de fin
IntervalTypeIntervalTypeLe type d'intervalle. Valeurs possibles:
- Send = dates de début et de fin d'envoi de message sms
- Event = dates de début et de fin d'événement correspondant au type de statistiques
StatisticTypeSmsRecipientStatusLe type des stastistiques. Valeurs possibles:
- Undefined = tout
- Delivery = aboutis
- Unsubscribe = désabonnés
- Unreachable = injoignable
TemplateIDintIdentifiant du template

    GetRecipientListByTemplateIDResult

    ChampTypeDescription
    CountintNombre total de destinataires correspondant à la demande
    RecipientListSmsRecipient[] Liste de destinataires

      SmsRecipient

      ChampTypeDescription
      LastSentDatedateTimeLa date du dernier envoi
      LastStatusDatedateTimeLa date de dernière mise à jour du statut
      RecipientstringNuméro de mobile
      StatusSmsRecipientStatusStatut du contact

        GetMessageTicketListByTemplateIDRequest

        ChampTypeDescription
        DateBegindateTimeDate de début
        DateEnddateTimeDate de fin
        IntervalTypeIntervalTypeLe type d'intervalle. Valeurs possibles:
        - Send = dates de début et de fin d'envoi de message sms
        - Event = dates de début et de fin d'événement correspondant au type de statistiques
        MaxResultintNombre de résultats maximum escompté
        OffsetintPosition de départ dans la liste
        StatisticTypeSmsMessageStatisticsTypeLe type des stastistiques. valeurs possibles:
        - All = tous les types,
        - Sent = envoyé,
        - Pending = en cours ou en erreur temporaire,
        - Rejected = en erreur définitive,
        - Delivered = abouti
        TemplateIDintIdentifiant du template

          GetMessageTicketListByTemplateIDResult

          ChampTypeDescription
          CountintNombre de tickets correspondant à la demande
          TicketsSmsMessageInfo[] Liste de message avec information
          TotalintNombre total de tickets

            SmsMessageInfo

            ChampTypeDescription
            LastStatusDatedateTimeDate de dernière mise à jour du statut
            SentDatedateTimeDate d'envoi
            StatusSmsDeliveryStatusStatut du message
            TicketstringTicket du message

              ServiceException

              ChampTypeDescription
              TicketstringUn numéro identifiant l'exception, utilisé pour le suivi de l'erreur
              MessagestringLe message décrivant l'erreur
              DescriptionstringLa description détaillée de l'erreur
              ErrorCodeErrorCodeTypeCode identifiant le type d'erreur (se référrer à la doc pour la liste des codes possibles)

                AuthenticationTokenContext

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

                  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