| Service de gestion des statistiques sms |
|
DéfinitionLe 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 |
|
| Les valeurs renvoyées |
|
|
Nom de la méthode : GetRecipientCette méthode permet de récupérer les informations concernant un destinataire
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
SmsRecipient | Les informations du destinataire demandé |
|
|
Liste des messages par templateNom de la méthode : GetMessageTicketListByTemplateIDCette méthode permet de récupérer la liste des messages sms envoyés par template
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Les objets du service de gestion des statistiques sms |
GetRecipientListByTemplateIDRequest |
|
| Champ | Type | Description |
|---|
| DateBegin | dateTime | Date de début | | DateEnd | dateTime | Date de fin | | IntervalType | IntervalType | Le 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 | | StatisticType | SmsRecipientStatus | Le type des stastistiques. Valeurs possibles:
- Undefined = tout
- Delivery = aboutis
- Unsubscribe = désabonnés
- Unreachable = injoignable | | TemplateID | int | Identifiant du template |
|
GetRecipientListByTemplateIDResult |
|
| Champ | Type | Description |
|---|
| Count | int | Nombre total de destinataires correspondant à la demande | | RecipientList | SmsRecipient[]
| Liste de destinataires |
|
SmsRecipient |
|
| Champ | Type | Description |
|---|
| LastSentDate | dateTime | La date du dernier envoi | | LastStatusDate | dateTime | La date de dernière mise à jour du statut | | Recipient | string | Numéro de mobile | | Status | SmsRecipientStatus | Statut du contact |
|
GetMessageTicketListByTemplateIDRequest |
|
| Champ | Type | Description |
|---|
| DateBegin | dateTime | Date de début | | DateEnd | dateTime | Date de fin | | IntervalType | IntervalType | Le 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 | | MaxResult | int | Nombre de résultats maximum escompté | | Offset | int | Position de départ dans la liste | | StatisticType | SmsMessageStatisticsType | Le 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 | | TemplateID | int | Identifiant du template |
|
GetMessageTicketListByTemplateIDResult |
|
| Champ | Type | Description |
|---|
| Count | int | Nombre de tickets correspondant à la demande | | Tickets | SmsMessageInfo[]
| Liste de message avec information | | Total | int | Nombre total de tickets |
|
SmsMessageInfo |
|
| Champ | Type | Description |
|---|
| LastStatusDate | dateTime | Date de dernière mise à jour du statut | | SentDate | dateTime | Date d'envoi | | Status | SmsDeliveryStatus | Statut du message | | Ticket | string | Ticket du message |
|
ServiceException |
|
| Champ | Type | Description |
|---|
| Ticket | string | Un numéro identifiant l'exception, utilisé pour le suivi de l'erreur | | Message | string | Le message décrivant l'erreur | | Description | string | La description détaillée de l'erreur | | ErrorCode | ErrorCodeType | Code identifiant le type d'erreur (se référrer à la doc pour la liste des codes possibles) |
|
AuthenticationTokenContext |
|
| Champ | Type | Description |
|---|
| AccountID | int | Identifiant du client | | Key | string | Clé du jeton d'authentification | | ListID | int | Identifiant du client: obsolète. Utilisez AccountID à la place |
|
Liste des erreurs communes |
|
| Code | Nom | Description |
|---|
| 0 | UnexpectedException | Erreur inattendue | | 1 | AuthenticationException | Erreur d'authentification | | 2 | NullTokenException | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 3 | NullRequestException | L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée | | 5 | InvalidArgumentException | Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité | | 6 | BadRequestException | La requête n'est pas correcte | | 7 | NothingToDoException | La 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 | | 8 | InvalidDataTypeException | Le type de donnée n'est pas valide | | 9 | UnknownTicketException | Le ticket n'est pas connu, vérifiez la valeur de celui-ci | | 10 | UnavailableTicketResultException | Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard. | | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | | 999998 | TokenNull | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 999999 | TokenNotAuthorized | L'objet 'token' n'est pas autorisé, vérifiez les propriétés |
|