Service de gestion des messages sms

Contrat WSDL	http://api.emt.dolist.net/V3/SmsMessageService.svc?wsdl
Ce service est également disponible en SSL, remplacez simplement http par https.

Définition

Le service de gestion des messages sms vous permet d'envoyer et récupérer toutes les informations relatives aux messages.

Envoi d'un sms

Nom de la méthode : SendMessage

Cette méthode vous permet d'envoyer votre message sms via notre plateforme Dolist-EMT.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
message	`SendMessageSmsRequest`	Les données du message à envoyer

Les valeurs renvoyées

Type	Description
`string`	Ticket

Statut d'un message sms

Nom de la méthode : GetMessageStatusByTicket

Vous pouvez récupérer le statut de votre message sms en appelant cette méthode.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket du message

Les valeurs renvoyées

Type	Description
`SmsDeliveryStatus`	Le statut du message

L'énumération SmsDeliveryStatus peut prendre les valeurs suivantes :

Undefined : En cours ou en erreur temporaire

Pending : En cours ou en erreur temporaire

Rejected : En erreur définitive

Delivered : Abouti

Synthèse d'un message sms

Nom de la méthode : GetMessageByTicket

Cette méthode vous permet de récupérer l'ensemble des informations détaillés de votre message.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
ticket	`string`	Le ticket du message

Les valeurs renvoyées

Type	Description
`SmsMessage`	Les données du message envoyé

Liste des messages sms par destinataire

Nom de la méthode : GetMessageListByRecipient

Vous pouvez récupérer la liste des messages sms reçus par destinataire en appelant cette méthode.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
request	`GetMessageListByRecipientRequest`	Objet de requête contenant le numéro de mobile

Les valeurs renvoyées

Type	Description
`GetMessageListByRecipientResult`	La liste des messages envoyés au numéro passé en paramètre

Récupération d'un expéditeur

Nom de la méthode : GetSender

Cette méthode vous permet de récupérer un expéditeur à partir de son identifiant.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
senderId	`int`	L'identifiant de l'expéditeur

Les valeurs renvoyées

Type	Description
`Sender`	L'expéditeur

Récupération des expéditeurs

Nom de la méthode : GetSenderList

Cette méthode vous permet de récupérer l'ensemble des expéditeurs.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
request	`GetSenderListRequest`	Objet de requête contenant les critères de récupération des expéditeurs

Les valeurs renvoyées

Type	Description
`GetSenderListResult`	La liste des expéditeurs

Création d'un expéditeur

Nom de la méthode : CreateSender

Cette méthode vous permet de créer un nouvel expéditeur.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
request	`CreateSenderRequest`	Objet contenant les informations pour créer un expéditeur

Les valeurs renvoyées

Type	Description
`int`	L'identifiant de l'expéditeur créé

Modification d'un expéditeur

Nom de la méthode : UpdateSender

Cette méthode vous permet de modifier un expéditeur.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
request	`UpdateSenderRequest`	Objet contenant les informations nécessaires pour mettre à jour un expéditeur

Les valeurs renvoyées

Type	Description
`boolean`	Indique si la mise à jour à réussie

Suppression d'un expéditeur

Nom de la méthode : DeleteSender

Cette méthode vous permet de supprimer un expéditeur.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
request	`DeleteSenderRequest`	Objet contenant les informations nécessaires pour supprimer un expéditeur

Les valeurs renvoyées

Type	Description
`boolean`	Indique si la suppression a réussie

Les objets du service de gestion des messages sms

SendMessageSmsRequest

Champ	Type	Description
Data	`string`	Données variables du message : flux XML
Prefix	`string`	Indicatif du pays (ex : +33)
Recipient	`string`	Numéro de mobile du destinataire avec le préfixe
RecipientExternalID	`string`	(optionnel) Identifiant externe du destinataire fourni par le SI du client, par défaut le mobile
TemplateID	`int`	Identifiant du template
TestMode	`boolean`	Indique si on envoie un message de test
UniqueExternalID	`string`	(optionnel) Identifiant unique de message fourni par le SI du client

SmsMessage

Champ	Type	Description
Content	`string`	Le contenu du message
DeliveryStatus	`SmsDeliveryStatus`	Le statut de livraison actuel
ErrorDate	`dateTime`	Date d'erreur
Recipient	`string`	Numéro de mobile du destinataire
RecipientExternalID	`string`	(optionnel) Identifiant externe du destinataire fourni par le SI du client, par défaut le mobile
SentDate	`dateTime`	Date d'envoi
SmsUnitSentCount	`int`	Le nombre de partie de sms
StatusDate	`dateTime`	Date de confirmation de livraison
TemplateID	`int`	Identifiant du template
Ticket	`string`	Ticket du message
UniqueExternalID	`string`	(optionnel) Identifiant unique de message fourni par le SI du client

GetMessageListByRecipientRequest

Champ	Type	Description
MaxResults	`int`	Nombre de résultats maximum escompté
Offset	`int`	Position de départ dans la liste
Recipient	`string`	Numéro de mobile du destinataire

GetMessageListByRecipientResult

Champ	Type	Description
Count	`int`	Nombre de messages dans la liste
SmsMessageList	`SmsMessage[]`	Liste de message sms
Total	`int`	Nombre total de messages correspondant à la demande

Sender

Champ	Type	Description
ID	`int`	Identifiant de l'expéditeur
Name	`string`	Nom de l'expéditeur

GetSenderListRequest

Champ	Type	Description
MaxResult	`int`	Nombre de résultats maximum attendu
Offset	`int`	Décalage par rapport au premier expéditeur retourné

GetSenderListResult

Champ	Type	Description
Count	`int`	Nombre d'expéditeur retourné
SenderList	`Sender[]`	Liste des expéditeurs
Total	`int`	Nombre total d'expéditeurs

CreateSenderRequest

Champ	Type	Description
Name	`string`	Nom de l'expéditeur à créer

UpdateSenderRequest

Champ	Type	Description
ID	`int`	Identifiant de l'expéditeur à modifier
Name	`string`	Nouveau nom de l'expéditeur

DeleteSenderRequest

Champ	Type	Description
ID	`int`	Identifiant de l'expéditeur à supprimer

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