| Service de gestion des templates sms |
|
DéfinitionLe service de gestion des templates sms vous permet de créer, modifier, récupérer vos templates disponibles en production et en test.
Chaque méthode est indépendante et vous pourrez gérer vos templates comme vous le souhaitez.
|
Récupération d'un template Nom de la méthode : GetTemplateByID
Cette méthode permet de récupérer les informations d'un template
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Récupération liste des templatesNom de la méthode : GetTemplateListCette méthode permet de récupérer l'ensemble des templates
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Contenu d'un template en productionNom de la méthode : GetTemplateContentProductionCette méthode permet de récupérer le contenu d'un template en production
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Contenu d'un template en testNom de la méthode : GetTemplateContentTestCette méthode permet de récupérer le contenu d'un template en test
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Mise à jour d'un templateNom de la méthode : UpdateTemplateCette méthode permet de mettre à jour les informations concernant un template
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Vrai si les informations ont bien été mises à jour |
|
|
Mise à jour du contenu de testNom de la méthode : UpdateTemplateContentTestCette méthode permet de mettre à jour le contenu de test d'un template
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la mise à jour a réussi |
|
|
Passage en production d'un templateNom de la méthode : UpdateTemplateContentTestToProductionCette méthode permet de passer en production un template actuellement en test
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Vrai si les informations ont bien été mises à jour |
|
|
Les objets du service de gestion des templates sms |
SmsTemplate |
|
| Champ | Type | Description |
|---|
| ContentProduction | SmsTemplateContent | Contenu du message en production | | ContentTest | SmsTemplateContent | Contenu du message en test | | ID | int | L'identifiant du template | | Name | string | Le nom du template | | SenderID | int | Identifiant de l'expéditeur personnalisé associé au template | | Type | SmsTemplateType | Type du template (marketing ou transactionel) | | XmlDataFormat | string | Le format des données variables à utiliser par la méthode SendMessage |
L'énumération SmsTemplateType peut prendre les valeurs suivantes :
|
SmsTemplateContent |
|
| Champ | Type | Description |
|---|
| Content | string | Contenu | | ConvertExtendedCaracters | boolean | Indique si les caractères étendus doivent être remplacé |
|
GetTemplateListRequest |
|
| Champ | Type | Description |
|---|
| MaxResult | int | Nombre maximum de template souhaité | | Offset | int | Décalage par rapport au premier template |
|
GetTemplateListResult |
|
| Champ | Type | Description |
|---|
| Count | int | Nombre de templates correspondant à la demande | | TemplateList | SmsTemplate[]
| Liste de templates | | Total | int | Nombre total de templates |
|
GetTemplateContentProductionResult |
|
|
GetTemplateContentTestResult |
|
|
UpdateTemplateSmsRequest |
|
| Champ | Type | Description |
|---|
| ID | int | L'identifiant du template | | Name | string | Le nom du template | | SenderID | int | Identifiant de l'expéditeur associé au template | | Type | SmsTemplateType | Type du message |
|
UpdateTemplateContentTestSmsRequest |
|
| Champ | Type | Description |
|---|
| Content | string | Contenu du message en test | | ConvertExtendedCaracters | boolean | Indique si les caractères étendus doivent être converti | | TemplateID | int | L'identifiant du template |
|
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 |
|
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) |
|
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 |
|