| Service de gestion des campagnes SMS |
|
DéfinitionLe service de gestion des campagnes SMS vous permet de piloter la création et l'envoi de vos campagnes SMS.
De la création du message SMS à l'envoi, vous pourrez tout gérer à partir de ce service.
|
Récupération d'un message SMS Nom de la méthode : GetMessage
Cette méthode vous permet de récupérer les détails de votre messages SMS.
En fonction de l'identifiant passé, vous récupérerez son nom, son contenu, le nombre de caractères présents, la date de la dernière modification et les identifiants des groupes utilisateurs qui ont accès à ce message.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
Message | Renvoie l'objet "Message" demandé |
|
|
Création d'un message SMSNom de la méthode : CreateMessage |
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
Message | Renvoie l'objet "Message" créé |
|
|
Mise à jour d'un message SMSNom de la méthode : UpdateMessageAppelez cette méthode dès que vous avez besoin d'effectuer une modification sur votre message SMS.
|
| Les paramètres attendus en entrée |
|
|
Création d'une campagne SMSNom de la méthode : CreateCampaignCette méthode permet de créer une campagne SMS. Vous définirez l'identifiant du message SMS et les identifiants des groupes utilisateurs qui pourront accéder à cette campagne.  | Si vous utilisez un expéditeur personnalisé, vous devez intégrer la phrase de désabonnement : STOP AU 36612.
Le 36612 sera modifié directement en fonction de l'opérateur destinataire.
|
|
| Les paramètres attendus en entrée |
| Champ | Type | Description |
|---|
| token | AuthenticationTokenContext | Authentification | | messageId | int | Identifiant du message | | listUsersGroups | int[]
| Identifiants des groupes utilisateurs | | senderId | int | Identifiant de l'expéditeur personnalisé |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
int | Renvoie l'identifiant de la campagne créée |
|
|
Statut d'une campagne SMSNom de la méthode : GetCampaignVous pouvez récupérer le statut de votre campagne en appelant cette méthode.
Un retour vous sera effectué sur le statut de la campagne, la date d'envoi de la campagne, le nombre de contacts destinataires, le nombre de sms envoyés ainsi que d'autres informations que vous retrouverez à partir de l'objet "SmsCampaign".
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
SmsCampaign | Renvoie l'objet "SmsCampaign" |
|
|
Nom de la méthode : SendCampaignSimulateCette méthode vous permet de simuler l'envoi d’une campagne SMS afin d'évaluer le nombre de contacts et de SMS générés avant l'envoi.
|
| Les paramètres attendus en entrée |
|
|
Nom de la méthode : SendCampaignL'appel de cette méthode vous permet d'envoyer votre campagne en mode REEL à un segment de votre base de contacts. Précisez la date d'envoi ainsi que le préfixe téléphonique (par défaut : +33) et votre campagne sera envoyée dans vos conditions. | L'envoi en mode TEST est obligatoire.
Vous ne pourrez pas envoyer de campagnes SMS en mode REEL si un BAT n'a pas été réalisé auparavant.
L'envoi de SMS commerciaux est formellement interdit pendant les heures comprises entre 20h30 et 8h00 les jours calendaires, le dimanche toute la journée et les jours fériés.
Cet horaire peut plus ou moins varier selon les opérateurs.
|
|
| Les paramètres attendus en entrée |
| Champ | Type | Description |
|---|
| token | AuthenticationTokenContext | Authentification | | campaignId | int | Identifiant de la campagne | | segmentId | int | Identifiant du segment | | sendDate | dateTime | Date d'envoi | | defaultPrefix | string | Préfixe téléphonique international par défaut (ex: "+33" pour la France) | | memberAction | int | Action à mener sur les contacts multiples |
|
Le paramètre "MemberAction" accepte les valeurs- 0 : Ne rien changer aux contacts. Expédier en l'état.
- 1 : Retirer les contacts présents plusieurs fois.
- 2 : Ne pas envoyer la campagne.
|
Nom de la méthode : SendCampaignBATCette méthode permet d'envoyer un BAT.
Précisez l'identifiant de votre campagne, le préfixe téléphonique ainsi que l'identifiant du segment et votre campagne Test sera prise en compte dans les plus brefs délais.
|
| Les paramètres attendus en entrée |
| Champ | Type | Description |
|---|
| token | AuthenticationTokenContext | Authentification | | campaignId | int | Identifiant de la campagne | | segmentId | int | Identifiant du segment | | defaultPrefix | string | Préfixe téléphonique international par défaut (ex: "+33" pour la France) | | memberAction | int | Action à mener sur les contacts multiples |
|
Le paramètre "MemberAction" accepte les valeurs- 0 : Ne rien changer aux contacts. Expédier en l'état.
- 1 : Retirer les contacts présents plusieurs fois.
- 2 : Ne pas envoyer la campagne.
|
Récupération d'un expéditeur personnaliséNom de la méthode : GetSenderCette méthode permet de récupérer l'identifiant et le nom d'un expéditeur personnalisé.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
SmsSender | Renvoie l'objet "Expéditeur personnalisé" |
|
|
Récupération des expéditeurs personnalisésNom de la méthode : GetSendersCette méthode permet de récupérer l'ensemble des identifiants et des noms d'expéditeurs personnalisés.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
SmsSender[]
| Renvoie la liste des objets "Expéditeur personnalisé" |
|
|
Création d'un expéditeur personnaliséNom de la méthode : CreateSenderCette méthode permet de créer un expéditeur personnalisé.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
int | Renvoie l'identifiant de l'expéditeur personnalisé créé |
|
|
Mise à jour d'un expéditeur personnaliséNom de la méthode : UpdateSenderCette méthode permet de mettre à jour un expéditeur personnalisé.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la mise à jour a été effectuée |
|
|
Suppression d'un expéditeur personnaliséNom de la méthode : DeleteSenderCette méthode permet de supprimer un expéditeur personnalisé.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | Indique si la suppression a été réussie |
|
|
Récupération des statistiques des campagnesNom de la méthode : GetCampaignsCette méthode permet de récupérer les statistiques de vos campagnes SMS
Définissez vos critères de filtrage pour récupérer les statistiques souhaitées.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
SmsCampaign[]
| Liste des objets "SmsCampaign" |
|
|
Récupération des identifiants des campagnesNom de la méthode : GetCampaignsIdCette méthode permet de récupérer les identifiants de vos campagnes SMS en fonction de critères de filtrage.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
int[]
| Liste des identifiants de campagnes |
|
|
Récupération des statistiques des campagnes en fonction de leurs identifiantsNom de la méthode : GetStatisticsCette méthode permet de récupérer les statistiques de vos campagnes SMS en fonction de leurs identifiants.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Les objets du service de gestion des campagnes SMS |
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 |
| Exception renvoyée en cas d'erreur à l'appel d'une methode. |
| Champ | Type | Description |
|---|
| Ticket | string | Le numéro de ticket | | Message | string | Le message d'erreur | | Description | string | La description de l'erreur | | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | | ErrorCode | int | Code de l'erreur |
|
Message |
| Objet représentant un message. |
| Champ | Type | Description |
|---|
| Id | int | Identifiant du message | | Length | int | Nombre de caractères présents dans le message | | Name | string | Nom du message | | Text | string | Contenu du message | | UpdateDate | dateTime | Date de la dernière modification | | UserGroupIdList | int[]
| Identifiants des groupes utilisateurs |
|
SmsCampaign |
| Objet représentant une campagne SMS. |
| Champ | Type | Description |
|---|
| ActionMembersMultiple | int | Action sur les contacts multiples | | DateCreate | dateTime | Date de création | | DateSend | dateTime | Date d'envoi | | DefaultPrefix | string | Préfixe téléphonique international utilisé par défaut | | Id | int | Identifiant de la campagne | | ListId | int | Identifiant de la base | | Message | Message | Message associé | | NbMembers | int | Nombre de contacts destinataires | | NbMembersRefused | int | Nombre de contacts refusés | | NbMobileDistinct | int | Nombre distinct de contacts destinataires | | NbSMS | int | Nombre de SMS envoyés | | NbSimulateMembers | int | Nombre de contacts destinataires déterminés lors de la dernière simulation d'envoi | | NbSimulateMembersRefused | int | Nombre de contacts refusés déterminés lors de la dernière simulation d'envoi | | NbSimulateMobileDistinct | int | Nombre distinct de mobiles déterminés lors de la dernière simulation d'envoi | | NbSimulateSMSDistinct | int | Nombre de SMS à envoyer sur les mobiles uniques déterminés lors de la dernière simulation d'envoi | | NbSimulateSms | int | Nombre de SMS à envoyer déterminés lors de la dernière simulation d'envoi | | SegmentId | int | Identifiant du segment | | Status | int | Statut de la campagne | | TestMode | boolean | Indique s'il s'agit d'un BAT |
|
SendCampaignSimulateRequest |
|
| Champ | Type | Description |
|---|
| CampaignId | int | Identifiant de la campagne | | DefaultPrefix | string | Préfixe téléphonique international par défaut (ex: "+33" pour la France) | | SegmentId | int | Identifiant du segment |
|
SmsSender |
|
| Champ | Type | Description |
|---|
| Id | int | Identifiant de l'expéditeur personnalisé | | Name | string | Nom de l'expéditeur personnalisé |
|
CampaignFilter |
|
| Champ | Type | Description |
|---|
| AllCampaigns | boolean | Toutes les campagnes | | CampaignsRecentlySentCount | int | Les X dernières campagnes | | Date | dateTime | Date à partir de laquelle les campagnes doivent être récupérées |
|
SmsStatistics |
|
| Champ | Type | Description |
|---|
| CampaignId | int | Identifiant de la campagne | | SmsDeliveredCount | int | Nombre de SMS aboutis | | SmsPendingCount | int | Nombre de SMS en cours d’envoi ou erreur temporaire | | SmsRejectedCount | int | Nombre de SMS en erreur définitive | | SmsSentCount | int | Nombre de SMS envoyés | | SmsUnitInternationalSentCount | int | Nombre de SMS unitaires envoyés à l'international | | SmsUnitNationalSentCount | int | Nombre de SMS unitaires envoyés en France | | SmsUnitSentCount | int | Nombre de SMS unitaires envoyés | | UnsubscribedCount | int | Nombre de contacts désabonnés |
|
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 |
|