|
1
|
|
|
2
|
|
|
3
|
|
|
4
|
|
|
5
|
|
|
6
|
|
|
7
|
|
|
8
|
|
|
9
|
Contact Everyone®
|
|
10
|
Manuel utilisateur Web Services (API)
|
|
11
|
SOMMAIRE
|
|
12
|
1 Introduction 4
|
|
13
|
2 Présentation du Web Service MultiDiffusionWS 4
|
|
14
|
3 Utilisation du Web Service MultiDiffusionWS coté client 5
|
|
15
|
3.1 WSDL - Le contrat d’interface entre le client et le serveur 5
|
|
16
|
3.2 Prérequis environnement applicatif pour l’accès à L'API de Contact
|
|
17
|
Everyone 6
|
|
18
|
3.3 Exigences de sécurité pour l’accès à l'API de Contact Everyone 7
|
|
19
|
3.3.1 Authentification 7
|
|
20
|
3.3.2 Confidentialité 7
|
|
21
|
3.3.3 Intégrité du contenu 7
|
|
22
|
3.3.4 Garanties du respect de la vie privée 7
|
|
23
|
3.4 Modalités pour Mise en place d'un accès à l'API de Contact Everyone
|
|
24
|
8
|
|
25
|
4 Tests de mise en service 9
|
|
26
|
4.1 Principe 9
|
|
27
|
4.2 Tests de connexion 9
|
|
28
|
5 Descriptifs des méthodes de L’API 10
|
|
29
|
5.1 Multidiffusion 10
|
|
30
|
5.1.1 Récupérer un ensemble d’informations concernant le compte client
|
|
31
|
et valider le custID 10
|
|
32
|
5.1.2 Envoi d'un message multimédia 11
|
|
33
|
5.1.3 Envoi d'un message multimédia étendu 15
|
|
34
|
5.1.4 Ajout d’une pièce jointe à la demande de diffusion 17
|
|
35
|
5.1.5 Récupérer le résumé du compte rendu d’une ou plusieurs
|
|
36
|
diffusions 18
|
|
37
|
5.1.6 Récupérer le compte rendu détaillé d’une ou plusieurs
|
|
38
|
diffusions 20
|
|
39
|
5.1.7 Lister les listes de destinataires 22
|
|
40
|
5.1.8 Créer une liste de diffusion 23
|
|
41
|
5.1.9 Modifier une liste de diffusion 24
|
|
42
|
5.1.10 Supprimer une liste de diffusion 25
|
|
43
|
5.1.11 Stopper la diffusion d’un message 26
|
|
44
|
5.1.12 Récupération des MO (Mobile Originated) 27
|
|
45
|
5.1.13 Récupération des MO24s (Mobile Originated 24h) 29
|
|
46
|
5.2 Provisioning 30
|
|
47
|
5.2.1 Créer un nouveau diffuseur 30
|
|
48
|
5.2.2 Modifier un diffuseur 33
|
|
49
|
5.2.3 Supprimer un diffuseur 34
|
|
50
|
5.2.4 Retrouver les informations d’un diffuseur 35
|
|
51
|
5.2.5 Changer le mot de passe d’un diffuseur 37
|
|
52
|
6 Gestion des erreurs 38
|
|
53
|
6.1 sur les pièces jointes 38
|
|
54
|
6.2 Gestion des autres erreurs : erreur 901 38
|
|
55
|
7 Concept des données manipulées 39
|
|
56
|
7.1 Liste des destinataires (en entrée de sendMessage) 39
|
|
57
|
7.2 Liste de comptes rendus résumés de la diffusion de messages (en
|
|
58
|
sortie de WSResultReport) 41
|
|
59
|
7.3 Liste de comptes rendus détaillés de la diffusion de messages (en
|
|
60
|
sortie de WSListFullResultReport) 42
|
|
61
|
7.3.1 Exemples flux XML retourné 44
|
|
62
|
7.3.2 Codes retour du diagnostic 45
|
|
63
|
7.4 Tableau de descripteurs de listes de destinataires (en sortie de
|
|
64
|
WSListDescriptor) 48
|
|
65
|
8 ANNEXES 49
|
|
66
|
8.1 Exemples flux XML 49
|
|
67
|
8.1.1 Exemple de flux XML pour l’appel de la méthode sendMessage 49
|
|
68
|
8.1.2 Exemple de flux XML pour l’appel de la méthode
|
|
69
|
sendAdvancedMessage 51
|
|
70
|
8.1.3 Exemple de flux XML pour l’appel de la méthode listResults 53
|
|
71
|
8.1.4 Exemple de flux XML pour l’appel de la méthode stopMessage 54
|
|
72
|
8.1.5 Appel de la méthode createDispatcher 54
|
|
73
|
8.1.6 Retour suite à l’Appel de la méthode createDispatcher : 55
|
|
74
|
8.1.7 Retour suite à l’Appel de la méthode createDispatcher en cas
|
|
75
|
d’erreur : 55
|
|
76
|
8.1.8 Appel de la méthode removeDispatcher : 56
|
|
77
|
8.1.9 Retour suite a l’appel de la méthode removeDispatcher 56
|
|
78
|
8.2 Personnalisation des messages 57
|
|
79
|
8.2.1 Variables prédéfinies 57
|
|
80
|
8.2.2 Personnalisation des variables 57
|
|
81
|
|
|
82
|
|
|
83
|
|
|
84
|
|
|
85
|
Introduction
|
|
86
|
|
|
87
|
|
|
88
|
Le but de ce document est de fournir un guide à l’utilisation de l’API web
|
|
89
|
service MultiDiffusionWS mis en œuvre pour le service Contact Everyone.
|
|
90
|
|
|
91
|
Les destinataires de cette documentation sont des développeurs, éditeurs de
|
|
92
|
logiciel, intégrateurs de service qui pourront intégrer la fonction de
|
|
93
|
diffusion multimédia à leur application en fédérant les différents services
|
|
94
|
offerts par le web service MultiDiffusionWS (sous condition d’avoir
|
|
95
|
souscrit à l’option API web service).
|
|
96
|
|
|
97
|
|
|
98
|
|
|
99
|
|
|
100
|
|
|
101
|
|
|
102
|
|
|
103
|
Présentation du Web Service MultiDiffusionWS
|
|
104
|
|
|
105
|
|
|
106
|
Ce Web Service offre les services suivants :
|
|
107
|
|
|
108
|
Multidiffusion
|
|
109
|
▪ Récupération de la version du Web Service et s'assurer que
|
|
110
|
l'authentification du client à base de certificat se déroule
|
|
111
|
correctement,
|
|
112
|
▪ Information sur la configuration du compte client.
|
|
113
|
▪ Diffusion d’un message,
|
|
114
|
▪ Diffusion de message avancé (différé, avec paramétrage durée, …),
|
|
115
|
▪ Résultats de diffusion,
|
|
116
|
▪ Résultats détaillés de diffusion (par destinataires),
|
|
117
|
▪ Gestion des listes de destinataires (listage, création,
|
|
118
|
modification et suppression). Les listes de destinataires ainsi
|
|
119
|
définies peuvent être utilisées pour une diffusion activée
|
|
120
|
manuellement via l'interface Web de Contact Everyone.
|
|
121
|
▪ Stopper la diffusion d’un message
|
|
122
|
▪ Récupération des MO, Mobile Originated (option SMS+)
|
|
123
|
▪ Récupération des « Réponses sms » (option)
|
|
124
|
Provisioning
|
|
125
|
▪ Ajout d’un nouveau diffuseur
|
|
126
|
▪ Modification d’un diffuseur existant
|
|
127
|
▪ Suppression d’un diffuseur existant
|
|
128
|
▪ Récupération des informations d’un diffuseur
|
|
129
|
▪ Changement du mot de passe d’un diffuseur
|
|
130
|
|
|
131
|
Utilisation du Web Service MultiDiffusionWS coté client
|
|
132
|
|
|
133
|
|
|
134
|
1 WSDL - Le contrat d’interface entre le client et le serveur
|
|
135
|
|
|
136
|
Les informations nécessaires coté client d’un web service sont condensées
|
|
137
|
dans le WSDL (Web Service Description Layer).
|
|
138
|
|
|
139
|
Ce WSDL décrit notamment les méthodes exposées du web service, les
|
|
140
|
paramètres entrants et sortant de chaque méthode ainsi que son URL d’accès.
|
|
141
|
|
|
142
|
|
|
143
|
Multidiffusion : il peut être récupéré à l’adresse suivante :
|
|
144
|
https://www.api-contact-everyone.fr.orange-
|
|
145
|
business.com/ContactEveryone/services/MultiDiffusionWS?wsdl
|
|
146
|
|
|
147
|
Provisioning : il peut être récupéré à l’adresse suivante :
|
|
148
|
https://www.api-contact-everyone.fr.orange-
|
|
149
|
business.com/ContactEveryone/services/Provisioning?wsdl
|
|
150
|
|
|
151
|
Le message « cette connexion n’est pas certifiée » peut apparaitre dans le
|
|
152
|
navigateur car le certificat racine est auto-signé.
|
|
153
|
|
|
154
|
Extrait du WSDL pour la méthode sendMessage(wsMessage) :
|
|
155
|
|
|
156
|
1. la méthode
|
|
157
|
|
|
158
|
|
|
159
|
<wsdl:operation name="sendMessage" parameterOrder="wsMessage">
|
|
160
|
<wsdl:input message="impl:sendMessageRequest"
|
|
161
|
name="sendMessageRequest"/>
|
|
162
|
<wsdl:output message="impl:sendMessageResponse"
|
|
163
|
name="sendMessageResponse"/>
|
|
164
|
</wsdl:operation>
|
|
165
|
|
|
166
|
|
|
167
|
2. le paramètre entrant
|
|
168
|
|
|
169
|
|
|
170
|
<complexType name="WSMessage">
|
|
171
|
<sequence>
|
|
172
|
<element name="content" nillable="true" type="soapenc:string"/>
|
|
173
|
<element name="custId" nillable="true" type="soapenc:string"/>
|
|
174
|
<element name="from" nillable="true" type="soapenc:string"/>
|
|
175
|
<element name="fullContenu" type="xsd:boolean"/>
|
|
176
|
<element name="orgName" nillable="true" type="soapenc:string"/>
|
|
177
|
<element name="resumeContent" nillable="true" type="soapenc:string"/>
|
|
178
|
<element name="sendProfiles" nillable="true" type="soapenc:string"/>
|
|
179
|
<element name="strategy" nillable="true" type="soapenc:string"/>
|
|
180
|
<element name="subject" nillable="true" type="soapenc:string"/>
|
|
181
|
<element name="to" nillable="true" type="soapenc:string"/>
|
|
182
|
</sequence>
|
|
183
|
</complexType>
|
|
184
|
|
|
185
|
3. le paramètre sortant
|
|
186
|
|
|
187
|
<complexType name="WSSendReport">
|
|
188
|
<sequence>
|
|
189
|
<element name="msgId" nillable="true" type="soapenc:string"/>
|
|
190
|
</sequence>
|
|
191
|
</complexType>
|
|
192
|
|
|
193
|
|
|
194
|
4. l’ URL d’accès :
|
|
195
|
|
|
196
|
|
|
197
|
<wsdl:service name="IMultiDiffusionWSService">
|
|
198
|
<wsdl:port binding="impl:MultiDiffusionWSSoapBinding"
|
|
199
|
name="MultiDiffusionWS">
|
|
200
|
<wsdlsoap:address location=”https://www.api-contact-
|
|
201
|
everyone.fr.orange-
|
|
202
|
business.com/ContactEveryone/services/MultiDiffusionWS"/>
|
|
203
|
</wsdl:port>
|
|
204
|
</wsdl:service>
|
|
205
|
|
|
206
|
|
|
207
|
2 Prérequis environnement applicatif pour l’accès à L'API de Contact
|
|
208
|
Everyone
|
|
209
|
|
|
210
|
|
|
211
|
Orange Business Services s'est assuré de l'interopérabilité de son Web
|
|
212
|
Service avec les moteurs de Web Services pour les solutions Java Axis
|
|
213
|
(Environnement J2EE) et .NET (Microsoft).
|
|
214
|
|
|
215
|
A noter que nous proposons et recommandons d'utiliser la librairie Axis
|
|
216
|
(moteur de Web Services) au dessus des serveurs d'application J2EE tels que
|
|
217
|
WebSphere, WebLogic, Jonas ou Tomcat.
|
|
218
|
|
|
219
|
Il est également possible, dans un autre environnement supportant
|
|
220
|
l'approche Web Service, de générer les classes/proxys permettant l'appel du
|
|
221
|
Web Service à partir du contrat d'interface WSDL fourni. Afin d'assurer au
|
|
222
|
mieux la compatibilité avec les différents environnements de
|
|
223
|
développements récents du marché, Orange Business Services s'est assuré de
|
|
224
|
la validité de son contrat d'interface WSDL du Web Service Contact
|
|
225
|
Everyone au moyen des derniers tests d'interopérabilité WS-I.
|
|
226
|
|
|
227
|
En dernier recours, pour des environnements plus anciens n'offrant pas la
|
|
228
|
possibilité de faire tourner un moteur Web Services compatible avec les
|
|
229
|
standards WS-I, il sera alors nécessaire de développer un applicatif
|
|
230
|
intermédiaire de médiation entre l'applicatif client et le Web Service de
|
|
231
|
Contact Everyone.
|
|
232
|
|
|
233
|
Ce cas de figure (composant intermédiaire de médiation) peut également être
|
|
234
|
mis en œuvre pour réaliser un accès centralisé au Web Service de Contact
|
|
235
|
Everyone par plusieurs applicatifs clients (cf schéma ci-dessous).
|
|
236
|
|
|
237
|
[pic]
|
|
238
|
|
|
239
|
Figure 1 : Mise en œuvre d'un serveur de médiation pour accès à l'API du
|
|
240
|
Web Service pour le service Contact Everyone
|
|
241
|
|
|
242
|
|
|
243
|
|
|
244
|
3 Exigences de sécurité pour l’accès à l'API de Contact Everyone
|
|
245
|
|
|
246
|
|
|
247
|
Des mécanismes de protection permettant de garantir l'authentification, la
|
|
248
|
confidentialité, l'intégrité du contenu et le respect de la vie privée, qui
|
|
249
|
sont des exigences essentielles du point de vue de Orange Business
|
|
250
|
Services, sont mis en œuvre pour l'accès par les applicatifs clients
|
|
251
|
externe à Contact Everyone via son API Web Service.
|
|
252
|
|
|
253
|
|
|
254
|
1 Authentification
|
|
255
|
|
|
256
|
Deux possibilités d’authentification sont offertes, une authentification
|
|
257
|
par certificat SSL ou une authentification par identifiant / mot de passe.
|
|
258
|
|
|
259
|
Authentification par certificat
|
|
260
|
Orange Business Services a choisi de mettre en place un système à
|
|
261
|
base d'Authentification forte (par certificat client). Ces
|
|
262
|
certificats sont attribués lors de la création du compte. Lorsqu’un
|
|
263
|
applicatif souhaite entreprendre des actions via l'API, il doit
|
|
264
|
s'authentifier en présentant le certificat qui lui a été délivré.
|
|
265
|
Une authentification par certificat ne permet pas de différencier les
|
|
266
|
diffuseurs d’un compte client dans les statistiques.
|
|
267
|
Authentification par identifiant / mot de passe
|
|
268
|
Dans le but de pouvoir différencier les diffuseurs d’un compte client
|
|
269
|
qui auraient diffusés depuis l’API, il est possible de s’authentifier
|
|
270
|
en passant l’identifiant et le mot de passe du diffuseur (identique à
|
|
271
|
l’interface Web) dans l’entête SOAP du flux XML envoyé à Contact
|
|
272
|
Everyone. Il sera ainsi possible de visualiser les diffusions
|
|
273
|
effectuées par chaque diffuseur dans les statistiques.
|
|
274
|
Remarque : En JAVA, il est nécessaire également d’utiliser le
|
|
275
|
certificat contacteveryone.jks (fournit avec le kit de certificat)
|
|
276
|
qui contient la clé publique de l’autorité de confiance qui a créé le
|
|
277
|
certificat. Il ne permet pas de s’authentifier mais simplement
|
|
278
|
d’autoriser la connexion avec le serveur de Contact Everyone.
|
|
279
|
|
|
280
|
2 Confidentialité
|
|
281
|
|
|
282
|
|
|
283
|
Les données échangées sur Internet entre l'applicatif et le Web Service ne
|
|
284
|
circulent pas en clair. Le dialogue entre l'applicatif et le Web Service
|
|
285
|
est chiffré et s'effectue en HTTPS basé sur SSL (Secure Socket Layer).
|
|
286
|
|
|
287
|
|
|
288
|
|
|
289
|
3 Intégrité du contenu
|
|
290
|
|
|
291
|
|
|
292
|
Le protocole de communication SSL vérifient l’intégrité des données
|
|
293
|
transmises et assurent que les données ne soient pas corrompues.
|
|
294
|
|
|
295
|
|
|
296
|
4 Garanties du respect de la vie privée
|
|
297
|
|
|
298
|
|
|
299
|
De par le cadre juridique français et notre sensibilité d'opérateur
|
|
300
|
téléphonique le respect de la vie privée est au cœur de nos préoccupations
|
|
301
|
sur cette offre de service de Contact Everyone. Le service est conçu pour
|
|
302
|
mettre en œuvre de façon très fine des stratégies de diffusion qui
|
|
303
|
s'adaptent aux exigences du contexte client et aux préférences des
|
|
304
|
destinataires à joindre.
|
|
305
|
|
|
306
|
|
|
307
|
|
|
308
|
4 Modalités pour Mise en place d'un accès à l'API de Contact Everyone
|
|
309
|
|
|
310
|
Lors de la configuration d'un accès à l'API Web Service de Contact
|
|
311
|
Everyone pour un applicatif client, les éléments suivants sont mis en
|
|
312
|
place :
|
|
313
|
|
|
314
|
Un certificat pour le compte client est généré et délivré au partenaire
|
|
315
|
intégrateur ou au client. Ce certificat a pour objectif de permettre à
|
|
316
|
l'applicatif client de s'authentifier auprès du Web Service du service
|
|
317
|
Contact Everyone.
|
|
318
|
|
|
319
|
|
|
320
|
Un identifiant de compte client est produit et également remis au
|
|
321
|
partenaire intégrateur ainsi que les paramètres d'accès et le manuel
|
|
322
|
utilisateur de l'interface web standard de Contact Everyone. A ce compte
|
|
323
|
client sont rattachées des stratégies de diffusion. Les stratégies doivent
|
|
324
|
être ensuite désignées par leur nom dans le fichier de configuration lors
|
|
325
|
des diffusions de messages. Elles sont modifiables via l'interface Web du
|
|
326
|
service ;
|
|
327
|
|
|
328
|
Il est à noter qu’en cas d’indisponibilité de Contact Everyone, il revient
|
|
329
|
à la charge du client de réémettre les envois via l’API.
|
|
330
|
|
|
331
|
Attention : un changement de nom client au niveau de l’IHM doit se traduire
|
|
332
|
par la demande d’un nouveau certificat. Sinon le certificat ne sera plus
|
|
333
|
reconnu et les diffusions par l’API ne se réaliseront plus.
|
|
334
|
|
|
335
|
|
|
336
|
Tests de mise en service
|
|
337
|
|
|
338
|
|
|
339
|
1 Principe
|
|
340
|
|
|
341
|
L’API de Contact Everyone permet
|
|
342
|
|
|
343
|
- de gérer des diffusions sur les media de type mail, sms, vocal et/ou fax.
|
|
344
|
|
|
345
|
- de gérer les diffuseurs
|
|
346
|
|
|
347
|
|
|
348
|
2 Tests de connexion
|
|
349
|
|
|
350
|
Le test de connexion se fait par la méthode « about »
|
|
351
|
|
|
352
|
• Installation des certificats Java ou .Net
|
|
353
|
• Configurer les clients Java ou .Net. L’URL d’accès au service API est
|
|
354
|
la suivante :
|
|
355
|
https://www.api-contact-everyone.fr.orange-
|
|
356
|
business.com/ContactEveryone/services/MultiDiffusionWS
|
|
357
|
• Effectuer le test de connectivité avec la méthode about
|
|
358
|
|
|
359
|
Paramètres d'entrée :
|
|
360
|
|
|
361
|
aucun
|
|
362
|
|
|
363
|
|
|
364
|
Paramètres en sortie :
|
|
365
|
|
|
366
|
|Paramètre de sortie |Type |Description |
|
|
367
|
|aboutReturn |Chaîne |API Webservice de l’offre CEO |
|
|
368
|
|
|
369
|
|
|
370
|
|
|
371
|
|
|
372
|
|
|
373
|
|
|
374
|
|
|
375
|
|
|
376
|
Descriptifs des méthodes de L’API
|
|
377
|
|
|
378
|
|
|
379
|
1 Multidiffusion
|
|
380
|
|
|
381
|
|
|
382
|
1 Récupérer un ensemble d’informations concernant le compte client et
|
|
383
|
valider le custID
|
|
384
|
|
|
385
|
• méthode getAccountInformation.
|
|
386
|
|
|
387
|
|
|
388
|
Paramètres en entrée :
|
|
389
|
|
|
390
|
|Paramètre|Type |Description |Requis |Contraintes |
|
|
391
|
|d'entrée | | | | |
|
|
392
|
|custId |Chaîne |Nom du compte client ou|Oui |32 caractères |
|
|
393
|
| | |numéro de contrat | |maximum |
|
|
394
|
|
|
395
|
|
|
396
|
|
|
397
|
Paramètres en sortie :
|
|
398
|
|
|
399
|
|Paramètre de sortie |Type |Description |
|
|
400
|
|custId |Chaîne |Nom du compte client. |
|
|
401
|
|archiveTime |Chaîne |Délai d'archivage des messages |
|
|
402
|
| | |en jour. |
|
|
403
|
|status |Chaîne |Le statut de l'espace du |
|
|
404
|
| | |client. |
|
|
405
|
| | |Valeurs possibles : |
|
|
406
|
| | |actif, inactif (suspendu), |
|
|
407
|
| | |supprimé(résilié). |
|
|
408
|
|strategy |Tableau de |Stratégie accessible pour le |
|
|
409
|
| |chaîne |compte. |
|
|
410
|
|
|
411
|
|
|
412
|
Remarque : Le custId correspond au nom du compte client ou au numéro de
|
|
413
|
contrat (3 lettres + 6 chiffres). Il est possible de le vérifier dans
|
|
414
|
l’onglet « Gestion », « mon compte » ou dans l’entête du mail « Kit de
|
|
415
|
livraison » qui vous a été envoyé avec votre mot de passe :
|
|
416
|
|
|
417
|
[pic]
|
|
418
|
|
|
419
|
|
|
420
|
Exceptions :
|
|
421
|
Lorsqu’un problème survient dans l’utilisation du web service, un code
|
|
422
|
d’erreur est retourné pour aider à identifier le problème.
|
|
423
|
|
|
424
|
|
|
425
|
|Description et code |Paramètres d'entrée|
|
|
426
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
427
|
| |SoapHeaderCredentia|
|
|
428
|
| |ls |
|
|
429
|
|Erreur du gestionnaire de Multi-Diffusion (900). |- |
|
|
430
|
|
|
431
|
|
|
432
|
2 Envoi d'un message multimédia
|
|
433
|
|
|
434
|
• méthode sendMessage.
|
|
435
|
|
|
436
|
|
|
437
|
Paramètres d'entrée :
|
|
438
|
|
|
439
|
|Paramètre |Description |Type |Requis |Contraintes |
|
|
440
|
|d'entrée | | | | |
|
|
441
|
|custId |Nom du compte |Chaîne |Oui |32 caractères maximum |
|
|
442
|
| |client ou numéro de| | | |
|
|
443
|
| |contrat | | | |
|
|
444
|
|orgName |Paramètre inutilisé| |Non | |
|
|
445
|
| |dans Contact | | | |
|
|
446
|
| |Everyone : ne pas | | | |
|
|
447
|
| |renseigner | | | |
|
|
448
|
|sendProfiles |Liste des |Chaîne |Oui | |
|
|
449
|
| |destinataires. |Voir ex | | |
|
|
450
|
| | |ci-après | | |
|
|
451
|
|from |Alias du mail si | |Non |40 caractères maximum |
|
|
452
|
| |renseigné , sinon | | | |
|
|
453
|
| |l’alias est le nom | | | |
|
|
454
|
| |du compte client. | | | |
|
|
455
|
|to |Paramètre inutilisé| |Non | |
|
|
456
|
| |dans Contact | | | |
|
|
457
|
| |Everyone : ne pas | | | |
|
|
458
|
| |renseigner | | | |
|
|
459
|
|subject |Sujet du message |Chaîne |Oui (*) |256 caractères maximum |
|
|
460
|
| |(pour media de type| | | |
|
|
461
|
| |mail). | | | |
|
|
462
|
|content |Contenu détaillé du|Chaîne |Oui (*) |100 000 caractères |
|
|
463
|
| |message(pour media | | |maximum excepté pour le |
|
|
464
|
| |de type fax, mail, | | |média vocal car limité à |
|
|
465
|
| |vocal). | | |1500 caractères |
|
|
466
|
|resumeContent |Résumé du message |Chaîne |Oui (*) |160 caractères maximum |
|
|
467
|
| |(pour media de type| | |(459 si option SMS LONG) |
|
|
468
|
| |sms). | | | |
|
|
469
|
|strategy |Désignation d'une |Chaîne |Oui |32 caractères maximum |
|
|
470
|
| |des stratégies de | | | |
|
|
471
|
| |diffusion du compte| | | |
|
|
472
|
| |client. | | | |
|
|
473
|
|
|
474
|
|
|
475
|
* : Les paramètres subject, content, resumeContent sont requis selon
|
|
476
|
le type de media indiqué en colonne Description
|
|
477
|
|
|
478
|
|
|
479
|
Un exemple de liste de destinataires : cette liste ne comporte qu’un
|
|
480
|
destinataire avec 2 média mail et sms.
|
|
481
|
|
|
482
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
483
|
<PROFILE_LIST>
|
|
484
|
<PROFILE>
|
|
485
|
<DEST_NAME>DUDRET</DEST_NAME>
|
|
486
|
<DEST_FORENAME>François</DEST_FORENAME>
|
|
487
|
<DEST_ID>ID_Profile1</DEST_ID>
|
|
488
|
<TERMINAL_GROUP>
|
|
489
|
<TERMINAL>
|
|
490
|
<TERMINAL_NAME>personnal_messaging</TERMINAL_NAME>
|
|
491
|
<TERMINAL_ADDR>
|
|
492
|
francois.dupont@orange.com</TERMINAL_ADDR>
|
|
493
|
<MEDIA_TYPE_GROUP>
|
|
494
|
<MEDIA_TYPE>mail</MEDIA_TYPE>
|
|
495
|
</MEDIA_TYPE_GROUP>
|
|
496
|
</TERMINAL>
|
|
497
|
<TERMINAL>
|
|
498
|
<TERMINAL_NAME>personnal_mobile</TERMINAL_NAME>
|
|
499
|
<TERMINAL_ADDR>0612345678</TERMINAL_ADDR>
|
|
500
|
<MEDIA_TYPE_GROUP>
|
|
501
|
<MEDIA_TYPE>tel</MEDIA_TYPE>
|
|
502
|
<MEDIA_TYPE>sms</MEDIA_TYPE>
|
|
503
|
</MEDIA_TYPE_GROUP>
|
|
504
|
</TERMINAL>
|
|
505
|
</TERMINAL_GROUP>
|
|
506
|
</PROFILE>
|
|
507
|
</PROFILE_LIST>
|
|
508
|
|
|
509
|
|
|
510
|
|
|
511
|
|
|
512
|
Il faut s’assurer que l’entête XML comporte bien : encoding="ISO-8859-
|
|
513
|
1" .
|
|
514
|
|
|
515
|
|
|
516
|
Un PROFILE_LIST peut contenir plusieurs PROFILE.
|
|
517
|
|
|
518
|
|
|
519
|
Un PROFILE peut contenir des champs personnalisés tels que :
|
|
520
|
- Cc : Liste des adresses des destinataires en copie d’un mail
|
|
521
|
séparées par un point virgule.
|
|
522
|
- Cci : Liste des adresses des destinataires en copie cachée d’un mail
|
|
523
|
séparées par un point virgule.
|
|
524
|
Ces champs ne seront pris en compte que dans le cas d’un mail. Ils ne
|
|
525
|
sont en aucun cas obligatoires.
|
|
526
|
L’ensemble des Cc + Cci est limité à 10.
|
|
527
|
|
|
528
|
|
|
529
|
Exemple :
|
|
530
|
|
|
531
|
|
|
532
|
Un exemple de liste de destinataires : cette liste ne comporte qu’un
|
|
533
|
destinataire avec personnalisation.
|
|
534
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
535
|
<PROFILE_LIST>
|
|
536
|
<PROFILE>
|
|
537
|
<DEST_NAME>DUDRET</DEST_NAME>
|
|
538
|
<DEST_FORENAME>François</DEST_FORENAME>
|
|
539
|
<DEST_ID>ID_Profile1</DEST_ID>
|
|
540
|
<PERSONALIZATION_LIST>
|
|
541
|
<PERSONALIZATION>
|
|
542
|
<NAME>CC</NAME>
|
|
543
|
|
|
544
|
<VALUE>adresseCc1@orange.com;adresseCc2@orange.com
|
|
545
|
</VALUE>
|
|
546
|
</PERSONALIZATION>
|
|
547
|
<PERSONALIZATION>
|
|
548
|
<NAME>CCI</NAME>
|
|
549
|
|
|
550
|
<VALUE>adresseCci1@orange.com;adresseCci2@orange.com
|
|
551
|
</VALUE>
|
|
552
|
</PERSONALIZATION>
|
|
553
|
</PERSONALIZATION_LIST>
|
|
554
|
<TERMINAL_GROUP>
|
|
555
|
...
|
|
556
|
|
|
557
|
|
|
558
|
|
|
559
|
Un TERMINAL_GROUP peut contenir plusieurs TERMINAL.
|
|
560
|
|
|
561
|
TERMINAL_NAME peut prendre plusieurs valeurs :
|
|
562
|
|
|
563
|
- mail | personnal_messaging | email
|
|
564
|
|
|
565
|
- office | home | phone1 => correspondant au téléphone fixe 1
|
|
566
|
|
|
567
|
- phone2 => correspondant au téléphone fixe 2
|
|
568
|
|
|
569
|
- personnal_fax
|
|
570
|
|
|
571
|
- personnal_mobile | professional_mobile | mobile1 => on doit trouver
|
|
572
|
pour cette balise MEDIA_TYPE_GROUP, celle-ci permet d'orienter
|
|
573
|
l'utilisation du mobile soit pour le vocal (tel) soit pour le sms
|
|
574
|
(sms), soit pour les deux.
|
|
575
|
|
|
576
|
- mobile2 => correspondant au téléphone mobile 2
|
|
577
|
|
|
578
|
|
|
579
|
Paramètres en sortie : WSSendReport
|
|
580
|
|
|
581
|
|Paramètre de sortie |Type |Description |
|
|
582
|
|WSSendReport |msgId |Chaîne |Identifiant de diffusion.|
|
|
583
|
|
|
584
|
|
|
585
|
Remarque : l'association message à diffuser / média(s) de réception du
|
|
586
|
destinataire est fixée par la stratégie. L'autorisation de diffusion
|
|
587
|
'vocale' 'sms' 'email' 'fax' ne peut être gérée que via l'IHM web de
|
|
588
|
Contact Everyone en paramétrant les différentes stratégies de votre
|
|
589
|
compte client.
|
|
590
|
|
|
591
|
|
|
592
|
Remarque PHP : Pour le développement en PHP, il est important de
|
|
593
|
renseigner le paramètre d’entrée fullContenu (n’apparaissant pas dans le
|
|
594
|
tableau ci-dessus) à true. De plus, il est conseillé de passer le
|
|
595
|
paramètre sendProfiles en chaîne de caractères et non d’utiliser un
|
|
596
|
fichier XML.
|
|
597
|
|
|
598
|
|
|
599
|
Exceptions :
|
|
600
|
|
|
601
|
|Description et code |Paramètres d'entrée|
|
|
602
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
603
|
| |soapHeaderCredentia|
|
|
604
|
| |ls |
|
|
605
|
|Diffusion impossible car dépasse votre quota (111) |custId |
|
|
606
|
|valable uniquement pour un compte de démo | |
|
|
607
|
|La liste des destinataires est manquante (200). |sendProfiles |
|
|
608
|
|La liste des destinataires n’est pas valide (201). |sendProfiles |
|
|
609
|
|Le nom des champs de personnalisation ne doit pas |sendProfiles |
|
|
610
|
|dépasser 30 caractères (202). | |
|
|
611
|
|La valeur des champs de personnalisation ne doit pas |sendProfiles |
|
|
612
|
|dépasser 256 caractères (203). | |
|
|
613
|
|Le nom d'un terminal de la liste des destinataires n'est |sendProfiles |
|
|
614
|
|pas valide (cf. page 41) (210) | |
|
|
615
|
|Le nombre de destinataires en copie et/ou copie cachée |sendProfiles |
|
|
616
|
|est supérieur au maximum autorisé (10). Paramètre : | |
|
|
617
|
|Personalization (CC/CCI) (250) | |
|
|
618
|
|L'email n'est pas valide. Paramètre : Personalization (CC|sendProfiles |
|
|
619
|
|ou CCi – adresse invalide) (251) | |
|
|
620
|
|La stratégie de diffusion est manquante (300). |sendProfiles |
|
|
621
|
|La stratégie de diffusion n'est pas valide pour le compte|sendProfiles |
|
|
622
|
|client (301). | |
|
|
623
|
|Diffusion impossible car elle dépasserait votre seuil |sendProfiles |
|
|
624
|
|bloquant de SMS (302) | |
|
|
625
|
|Le message à diffuser est manquant (400) |strategy |
|
|
626
|
|Le champ content est anormalement vide pour la stratégie |custId, strategy |
|
|
627
|
|de diffusion (401). | |
|
|
628
|
|Le champ resumeContent est anormalement vide pour la |resumeContent |
|
|
629
|
|stratégie de diffusion (402) | |
|
|
630
|
|Le champ subject est anormalement vide pour la stratégie |subject |
|
|
631
|
|de diffusion (403) | |
|
|
632
|
|Le sujet du message n'est pas valide (413). |content, |
|
|
633
|
|Le contenu du message n'est pas valide (414). |resumeContent |
|
|
634
|
|Le résumé du message n'est pas valide (415). |content |
|
|
635
|
| | |
|
|
636
|
| | |
|
|
637
|
| | |
|
|
638
|
3 Envoi d'un message multimédia étendu
|
|
639
|
|
|
640
|
• méthode sendAdvancedMessage.
|
|
641
|
|
|
642
|
|
|
643
|
Paramètres d'entrée :
|
|
644
|
|
|
645
|
|Paramètre |Description |Type |Requis|Contraintes |
|
|
646
|
|d'entrée | | | | |
|
|
647
|
|custId |Nom du compte client ou |Chaîne |Oui |32 caractères |
|
|
648
|
| |numéro de contrat | | |maximum |
|
|
649
|
|orgName |Paramètre inutilisé dans | |Non | |
|
|
650
|
| |Contact Everyone : ne pas | | | |
|
|
651
|
| |renseigner. | | | |
|
|
652
|
|sendProfiles |Liste des destinataires. |Chaîne |Oui | |
|
|
653
|
| | |Voir ex dans| | |
|
|
654
|
| | |sendMessage | | |
|
|
655
|
|from |Alias du mail si | |Non |40 caractères |
|
|
656
|
| |renseigné , sinon l’alias | | |maximum |
|
|
657
|
| |est le nom du compte | | | |
|
|
658
|
| |client. | | | |
|
|
659
|
|to |Paramètre inutilisé dans | |Non | |
|
|
660
|
| |Contact Everyone : ne pas | | | |
|
|
661
|
| |renseigner | | | |
|
|
662
|
|subject |Sujet du message (pour |Chaîne |Oui |256 caractères |
|
|
663
|
| |media de type mail). | |(*) |maximum |
|
|
664
|
|content |Contenu détaillé du message|Chaîne |Oui |100 000 caractères |
|
|
665
|
| |(pour media de type | |(*) |maximum |
|
|
666
|
| |fax,mail, vocal). | | | |
|
|
667
|
|resumeContent |Résumé du message(pour |Chaîne |Oui |160 caractères |
|
|
668
|
| |media de type sms). | |(*) |maximum |
|
|
669
|
| | | | |(459 si option SMS |
|
|
670
|
| | | | |LONG) |
|
|
671
|
|mailReplyTo |Adresse e-mail de retour |Chaîne |Non |128 caractères |
|
|
672
|
| | | | |maximum et format |
|
|
673
|
| | | | |email |
|
|
674
|
|telReplyTo |Numéro présenté |Chaîne |Non |10 chiffres maximum,|
|
|
675
|
| | | | |format national |
|
|
676
|
| | | | |français |
|
|
677
|
|smsReplyTo |Nom émetteur sms |Chaîne |Non |11 caractères |
|
|
678
|
| |personnalisé (souscription | | |maximum |
|
|
679
|
| |option nécessaire, valeur | | | |
|
|
680
|
| |par défaut) | | | |
|
|
681
|
|faxReplyTo |Pour usage ultérieur |Chaîne |Non |Non utilisé |
|
|
682
|
|strategy |Désignation d'une des |Chaîne |Oui |32 caractères |
|
|
683
|
| |stratégies de diffusion du | | |maximum |
|
|
684
|
| |compte client. | | | |
|
|
685
|
|startCall |Date de début de diffusion |Calendar |Non |Cf. remarques |
|
|
686
|
| | | | |ci-après |
|
|
687
|
|validityPeriod|Durée de validité de la |Chaîne |Non |Cf. remarques |
|
|
688
|
| |diffusion | | |ci-après |
|
|
689
|
|
|
690
|
|
|
691
|
* : Les paramètres subject, content, resumeContent sont requis selon
|
|
692
|
le type de media indiqué en colonne Description
|
|
693
|
|
|
694
|
Remarque : l'association message à diffuser / média(s) de réception du
|
|
695
|
destinataire est fixée par la stratégie. L'autorisation de diffusion
|
|
696
|
'vocale' 'sms' 'email' 'fax' ne peut être gérée que via l'IHM web de
|
|
697
|
Contact Everyone en paramétrant les différentes stratégies de votre
|
|
698
|
compte client.
|
|
699
|
|
|
700
|
- La date de début de diffusion est une date précise. Si cette date de
|
|
701
|
début n'est pas renseignée alors il s'agit d'une diffusion immédiate.
|
|
702
|
Dans le cas où elle est fournie, la différence entre la date courante et
|
|
703
|
la date de début doit être comprise entre 1 minute et 90 jours. C'est-à-
|
|
704
|
dire qu'elle doit être supérieure à la date courante + 1 minute et ne
|
|
705
|
doit dépasser date courante + 90 jours.
|
|
706
|
|
|
707
|
- La diffusion peut être différée d’un minimum d’une minute soit 60000 ms
|
|
708
|
et d’un maximum d’un an soit 776000000 ms (90 jours). Le Type correspond
|
|
709
|
à un Calendar .
|
|
710
|
|
|
711
|
- La durée de validité d'une diffusion est exprimée en relatif par rapport
|
|
712
|
à l'heure de prise en compte de la requête de diffusion. Le format
|
|
713
|
correspond à une chaîne désignant le nombre de minutes de la durée de
|
|
714
|
validité. La durée de validité d'une diffusion doit être comprise entre
|
|
715
|
60 minutes (1 heure) et 4320 minutes (3 jours). Par défaut si le
|
|
716
|
paramètre n'est pas renseigné la durée de validité est fixée à 240
|
|
717
|
minutes (4 heures) ;
|
|
718
|
|
|
719
|
|
|
720
|
|
|
721
|
Paramètres en sortie : WSSendReport
|
|
722
|
|
|
723
|
|Paramètre de sortie |Type |Description |
|
|
724
|
|WSSendReport |msgId |Chaîne |Identifiant de diffusion.|
|
|
725
|
|
|
726
|
|
|
727
|
|
|
728
|
Exceptions :
|
|
729
|
|
|
730
|
Les exceptions de la méthode sendMessage sont également applicables et ne
|
|
731
|
sont pas recopiées ici. Seules les exceptions spécifiques à
|
|
732
|
sendAdvancedMessage sont listées ci-dessous.
|
|
733
|
|
|
734
|
|Description et code |Paramètres d'entrée|
|
|
735
|
|L’email de retour n’est pas valide (416) |mailReplyTo |
|
|
736
|
|Le téléphone de retour n’est pas valide (417) |telReplyTo |
|
|
737
|
|Le fax de retour n’est pas valide (419) |faxReplyTo |
|
|
738
|
|La date différée n’est pas valide (en dehors des |startCall |
|
|
739
|
|valeurs autorisées min : date courante + 1 minute, max| |
|
|
740
|
|date courante + 90 jours) (420) | |
|
|
741
|
|La durée de validité n’est pas valide (min 2H, max |validityPeriod |
|
|
742
|
|72H). (421) | |
|
|
743
|
|
|
744
|
|
|
745
|
|
|
746
|
|
|
747
|
|
|
748
|
|
|
749
|
|
|
750
|
|
|
751
|
|
|
752
|
|
|
753
|
6 Ajout d’une pièce jointe à la demande de diffusion
|
|
754
|
|
|
755
|
|
|
756
|
Certaines medias peuvent s’accompagner de fichiers binaires pour leur
|
|
757
|
envoie.
|
|
758
|
L’ajout de pièces jointes dans un email, d’un fichier audio pour une
|
|
759
|
diffusion vocale ou d’un document pour un fax. Ces fichiers ne sont pas
|
|
760
|
stockées dans la structure d’envoi de données mais au niveau de la trame
|
|
761
|
SOAP.
|
|
762
|
|
|
763
|
Les méthodes varies d’un langage, d’un environnement, d’une bibliothèque
|
|
764
|
voire d’une version à l’autre. Il n’est donc pas possible de donner un
|
|
765
|
descriptif commun d’usage. On notera toutefois la présence fréquente d’une
|
|
766
|
méthode addAttachement
|
|
767
|
|
|
768
|
Exemple de code java / Axis
|
|
769
|
FileDataSource file = new FileDataSource("C/repertoire/exemple.txt");
|
|
770
|
DataHandler data = new DataHandler(file);
|
|
771
|
AttachmentPart attachmentPart = new AttachmentPart(data);
|
|
772
|
attachmentPart.setContentId("mdws-attached/exemple.txt");
|
|
773
|
myStubService.addAttachment(attachmentPart);
|
|
774
|
|
|
775
|
myStubService.sendMessage(myMessage);
|
|
776
|
|
|
777
|
Chaque fichier attaché est désigné par un identifiant dont le nom est
|
|
778
|
normalisé comme suit :
|
|
779
|
mdws-audio/nom.ext pour un fichier audio. Lié au media vocal.
|
|
780
|
msws-attached/nom.ext pour un fichier autre.
|
|
781
|
|
|
782
|
Les pièces jointes sont limitées en nombre et en taille en fonction du
|
|
783
|
media utilisé.
|
|
784
|
|
|
785
|
|
|
786
|
Exceptions :
|
|
787
|
|
|
788
|
Les exceptions suivantes sont applicables aux méthodes ’sendMessage’ et
|
|
789
|
‘sendAdvancedMessage’’ uniquement dans le cas d’ajout de pièces jointes.
|
|
790
|
|
|
791
|
|
|
792
|
|Description et code lié aux pièces jointes |Paramètres d'entrée|
|
|
793
|
|La taille de la pièce jointe audio dépasse la taille |audioFile |
|
|
794
|
|maximum autorisée (500). | |
|
|
795
|
|Le nombre de pièce jointe audio dépasse le nombre maximum|audioFile |
|
|
796
|
|admis maximum 1 pièce jointe audio (501). | |
|
|
797
|
|La taille de la pièce jointe autre dépasse la taille |attachedFile |
|
|
798
|
|maximum autorisée (520). | |
|
|
799
|
|Le nombre de pièce jointe autre dépasse le nombre maximum|attachedFile |
|
|
800
|
|admis maximum 1 pièce jointe autre (521). | |
|
|
801
|
|Le nombre de pièces jointes dépasse le seuil autorisé qui|audioFile, |
|
|
802
|
|est de 2 (551) |attachedFile |
|
|
803
|
|Le fichier audio doit avoir une extension autoriséé |audioFile |
|
|
804
|
|(.wav) (552). | |
|
|
805
|
|La pièce jointe a une extension non autorisée (553) |attachedFile |
|
|
806
|
|La pièce jointe n’est pas valide (554) |audioFile ou |
|
|
807
|
| |attachedFile |
|
|
808
|
|
|
809
|
Remarque : si une requête comporte plusieurs pièces jointes portant le même
|
|
810
|
nom, celle-ci sera refusée pour pièce jointe non valide.
|
|
811
|
|
|
812
|
7 Récupérer le résumé du compte rendu d’une ou plusieurs diffusions
|
|
813
|
|
|
814
|
suivant un filtre permettant de désigner ces diffusions.
|
|
815
|
|
|
816
|
|
|
817
|
|
|
818
|
▪ méthode listResults.
|
|
819
|
|
|
820
|
|
|
821
|
|
|
822
|
Paramètres en entrée :
|
|
823
|
|
|
824
|
|Paramètre |Type |Description |Requis |Contrainte|
|
|
825
|
|d'entrée | | | |s |
|
|
826
|
|custId |Chaîne |Nom du compte client ou |Oui |32 |
|
|
827
|
| | |numéro de contrat | |caractères|
|
|
828
|
| | | | |maximum |
|
|
829
|
|msgIds |Tableau |Liste des identifiants |Liste des | |
|
|
830
|
| |de Chaîne|pour les diffusions |identifian| |
|
|
831
|
| | |demandées. |ts | |
|
|
832
|
| | | | | |
|
|
833
|
| | | |ou | |
|
|
834
|
| | | | | |
|
|
835
|
| | | |Le filtre | |
|
|
836
|
| | | |(au | |
|
|
837
|
| | | |minimum | |
|
|
838
|
| | | |une date | |
|
|
839
|
| | | |de début) | |
|
|
840
|
|from | |Paramètre inutilisé dans | | |
|
|
841
|
| | |Contact Everyone : ne pas | | |
|
|
842
|
| | |renseigner. | | |
|
|
843
|
|to | |Paramètre inutilisé dans | | |
|
|
844
|
| | |Contact Everyone : ne pas | | |
|
|
845
|
| | |renseigner. | | |
|
|
846
|
|dateBegin |Date |Une date précise de | | |
|
|
847
|
| | |diffusion ou la date de | | |
|
|
848
|
| | |début dans le cas d'une | | |
|
|
849
|
| | |plage calendaire de | | |
|
|
850
|
| | |diffusion. | | |
|
|
851
|
|dateEnd |Date |La date de fin dans le cas| | |
|
|
852
|
| | |d'une plage calendaire de | | |
|
|
853
|
| | |diffusion. | | |
|
|
854
|
|status |Chaîne |Le statut de diffusion. | | |
|
|
855
|
|
|
856
|
Remarques :
|
|
857
|
- S'il existe à la fois une liste d'identifiants et un filtre de sélection,
|
|
858
|
seule la liste des identifiants est prise en compte ;
|
|
859
|
- L'applicatif client peut spécifier dans le filtre de sélection soit une
|
|
860
|
date précise en utilisant le paramètre dateBegin soit une plage
|
|
861
|
calendaire en utilisant les paramètres dateBegin et dateEnd. En
|
|
862
|
conséquence, il n'est pas possible d'utiliser seul le paramètre dateEnd.
|
|
863
|
Dans le cas où le seul le paramètre dateEnd est renseigné alors le filtre
|
|
864
|
est considéré comme vide.
|
|
865
|
- La précision des dates utilisées pour le filtre se limite à la minute.
|
|
866
|
- On peut ajouter au filtre de recherche le statut de(s) diffusion(s). La
|
|
867
|
liste des libellés des statuts des campagnes est INSERTED_IN_DATABASE,
|
|
868
|
SENT_TO_NOTILUS, RUNNING, REJECTED, CANCELED, COMPLETED, FAILED_NOTILUS,
|
|
869
|
CANCELING, PARTIALLY_SENT_TO_NOTILUS, FAILED_CANCEL. Les statuts
|
|
870
|
REJECTED, CANCELED, COMPLETED sont des statuts finaux.
|
|
871
|
|
|
872
|
|
|
873
|
[pic]
|
|
874
|
|
|
875
|
|
|
876
|
Paramètres en sortie :
|
|
877
|
|
|
878
|
|Paramètre de |Type |Description |
|
|
879
|
|sortie | | |
|
|
880
|
|reports |Tableau de |Une liste de résumés de comptes |
|
|
881
|
| |ResultReport |rendus de la diffusion de messages.|
|
|
882
|
| | |La description d’un résumé de |
|
|
883
|
| | |compte rendu est fournie dans la |
|
|
884
|
| | |section. |
|
|
885
|
|
|
886
|
|
|
887
|
Remarques :
|
|
888
|
- Dans le cas où aucun message ne correspond aux critères de sélection
|
|
889
|
fournis, le compte rendu retourné correspondra à une liste vide.
|
|
890
|
- Tant que la diffusion d’un message n’est pas achevée, le compte rendu
|
|
891
|
n’est qu’une capture à un moment donné de l’état de diffusion et doit
|
|
892
|
être redemandé ultérieurement pour bénéficier des éventuelles évolutions.
|
|
893
|
Exceptions :
|
|
894
|
|
|
895
|
|Description et code |Paramètres d'entrée|
|
|
896
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
897
|
| |soapHeaderCredentia|
|
|
898
|
| |ls |
|
|
899
|
|Le filtre de sélection est manquant (600). |custId |
|
|
900
|
|Il n'existe pas d'identifiant ou de filtre de recherche |custId |
|
|
901
|
|(601). | |
|
|
902
|
|Le ou les identifiants fournis ne sont pas connus pour le|DName, custId |
|
|
903
|
|compte client (602). | |
|
|
904
|
|Le statut n'est pas valide (603). | |
|
|
905
|
|La date de début de recherche doit être renseigée (604). | |
|
|
906
|
| |msgIds,custId |
|
|
907
|
| |status |
|
|
908
|
8 Récupérer le compte rendu détaillé d’une ou plusieurs diffusions
|
|
909
|
|
|
910
|
suivant un filtre permettant de désigner ces diffusions.
|
|
911
|
|
|
912
|
|
|
913
|
▪ méthode listFullResults.
|
|
914
|
|
|
915
|
Paramètres en entrée :
|
|
916
|
|
|
917
|
|Paramètre |Type |Description |Requis |Contrainte|
|
|
918
|
|d'entrée | | | |s |
|
|
919
|
|custId |Chaîne |Nom du compte client ou |Oui |32 |
|
|
920
|
| | |numéro de contrat | |caractères|
|
|
921
|
| | | | |maximum |
|
|
922
|
|msgIds |Tableau |Liste des identifiants |Liste des | |
|
|
923
|
| |de Chaîne|pour les diffusions |identifian| |
|
|
924
|
| | |demandées. |ts | |
|
|
925
|
| | | | | |
|
|
926
|
| | | |ou | |
|
|
927
|
| | | | | |
|
|
928
|
| | | |Le filtre | |
|
|
929
|
| | | |(au | |
|
|
930
|
| | | |minimum | |
|
|
931
|
| | | |une date | |
|
|
932
|
| | | |de début | |
|
|
933
|
|Fi|from | |Paramètre inutilisé dans | | |
|
|
934
|
|lt| | |Contact Everyone : ne pas | | |
|
|
935
|
|re| | |renseigner. | | |
|
|
936
|
| |to | |Paramètre inutilisé dans | | |
|
|
937
|
| | | |Contact Everyone : ne pas | | |
|
|
938
|
| | | |renseigner. | | |
|
|
939
|
| |dateBegin|Date |Une date précise de | | |
|
|
940
|
| | | |diffusion ou la date de | | |
|
|
941
|
| | | |début dans le cas d'une | | |
|
|
942
|
| | | |plage calendaire de | | |
|
|
943
|
| | | |diffusion. | | |
|
|
944
|
| |dateEnd |Date |La date de fin dans le cas| | |
|
|
945
|
| | | |d'une plage calendaire de | | |
|
|
946
|
| | | |diffusion. | | |
|
|
947
|
| |status |Chaîne |Le statut de diffusion. | | |
|
|
948
|
|
|
949
|
|
|
950
|
A la différence de la méthode ListResult, la méthode ListFullResult
|
|
951
|
permettant d’obtenir le compte rendu détaillé qui contient en plus la
|
|
952
|
liste des destinataires.
|
|
953
|
Remarques :
|
|
954
|
|
|
955
|
- S'il existe à la fois une liste d'identifiants et un filtre de sélection,
|
|
956
|
seule la liste des identifiants est prise en compte ;
|
|
957
|
- L'applicatif client peut spécifier dans le filtre de sélection soit une
|
|
958
|
date précise en utilisant le paramètre dateBegin soit une plage
|
|
959
|
calendaire en utilisant les paramètres dateBegin et dateEnd. En
|
|
960
|
conséquence, il n'est pas possible d'utiliser seul le paramètre dateEnd.
|
|
961
|
Dans le cas où le seul le paramètre dateEnd est renseigné alors le filtre
|
|
962
|
est considéré comme vide.
|
|
963
|
- La précision des dates utilisées pour le filtre se limite à la minute.
|
|
964
|
- On peut ajouter au filtre de recherche le statut de(s) diffusion(s). La
|
|
965
|
liste des libellés des statuts des campagnes est INSERTED_IN_DATABASE,
|
|
966
|
SENT_TO_NOTILUS, RUNNING, REJECTED, CANCELED, COMPLETED, FAILED_NOTILUS,
|
|
967
|
CANCELING, PARTIALLY_SENT_TO_NOTILUS, FAILED_CANCEL. Les statuts
|
|
968
|
REJECTED, CANCELED, COMPLETED sont des statuts finaux.
|
|
969
|
|
|
970
|
|
|
971
|
|
|
972
|
Paramètres en sortie :
|
|
973
|
|
|
974
|
|Paramètre de |Type |Description |
|
|
975
|
|sortie | | |
|
|
976
|
|fullReports |Tableau de |Une liste de comptes rendus |
|
|
977
|
| |FullResultReport|détaillés de la diffusion de |
|
|
978
|
| | |messages. La description d'un |
|
|
979
|
| | |compte rendu est fournie dans la |
|
|
980
|
| | |section 7.3 |
|
|
981
|
|
|
982
|
|
|
983
|
Tableau 1 : Liste des paramètres de sortie pour le cas d'utilisation
|
|
984
|
|
|
985
|
|
|
986
|
|
|
987
|
|
|
988
|
Remarques :
|
|
989
|
|
|
990
|
- Tant que la diffusion d'un message n'est pas achevée, le compte rendu
|
|
991
|
n'est qu'une capture à un moment donné de l'état de la diffusion et doit
|
|
992
|
être redemandé ultérieurement pour bénéficier des éventuelles
|
|
993
|
évolutions ;
|
|
994
|
- Dans certains cas, le compte rendu détaillé peut retourner une liste des
|
|
995
|
destinataires vide. Ce cas peut par exemple arriver lors d'un appel qui a
|
|
996
|
échoué ;
|
|
997
|
- Dans le cas où aucun message ne correspond aux critères de sélection
|
|
998
|
fournis, le compte rendu retourné correspondra à une liste vide.
|
|
999
|
|
|
1000
|
Exceptions :
|
|
1001
|
|
|
1002
|
|Description et code |Paramètres d'entrée|
|
|
1003
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1004
|
| |soapHeaderCredentia|
|
|
1005
|
| |ls |
|
|
1006
|
|Le filtre de sélection est manquant (600). |custId |
|
|
1007
|
|Il n'existe pas d'identifiant ou de filtre de recherche |custId |
|
|
1008
|
|(601). | |
|
|
1009
|
|Le ou les identifiants fournis ne sont pas connus pour le|DName, custId |
|
|
1010
|
|compte client (602). | |
|
|
1011
|
|Le statut n'est pas valide (603). | |
|
|
1012
|
|La date de début de recherche doit être renseigée (604). | |
|
|
1013
|
| |msgIds,custId |
|
|
1014
|
| |status |
|
|
1015
|
| | |
|
|
1016
|
|
|
1017
|
|
|
1018
|
|
|
1019
|
|
|
1020
|
|
|
1021
|
|
|
1022
|
|
|
1023
|
|
|
1024
|
Nota : après une diffusion, on appliquera l’algorithme suivant pour
|
|
1025
|
récupérer l’état de la diffusion
|
|
1026
|
|
|
1027
|
|
|
1028
|
Pour avoir tous les états définitifs des appels, il est impératif que la
|
|
1029
|
diffusion soit dans un état final ( COMPLETED, REJECTED ou CANCELED ). Le
|
|
1030
|
listFullResults est, dans ce cas, totalement probant.
|
|
1031
|
Si le listFullResults est lancé avant, vous n'aurez que des résultats
|
|
1032
|
partiels.
|
|
1033
|
Le délai moyen de mise à jour du journal (et donc des diffusions ) est de 4-
|
|
1034
|
5 minutes environ.
|
|
1035
|
|
|
1036
|
En conséquence, l'algorithme doit être le suivant :
|
|
1037
|
|
|
1038
|
1 ) lancement de la diffusion
|
|
1039
|
2 ) tempo de 5 minutes
|
|
1040
|
3 ) lancement de listResults pour obtenir le statut de la diffusion
|
|
1041
|
4 ) si statut final
|
|
1042
|
lancement de listFullResults et récupération des états et
|
|
1043
|
diagnostics de chaque appel
|
|
1044
|
fin
|
|
1045
|
5 ) sinon
|
|
1046
|
tempo de 1 minute
|
|
1047
|
retour en 3
|
|
1048
|
6 ) fin
|
|
1049
|
|
|
1050
|
Les listResults ou listFullResults peuvent être lancés pour une liste de
|
|
1051
|
diffusions ( liste de msgIds 1000 maximum ). Cela permet d’éviter les trop
|
|
1052
|
nombreuses requêtes vers le serveur API.
|
|
1053
|
|
|
1054
|
|
|
1055
|
|
|
1056
|
|
|
1057
|
|
|
1058
|
|
|
1059
|
13 Lister les listes de destinataires
|
|
1060
|
|
|
1061
|
• méthode getListDescriptors.
|
|
1062
|
|
|
1063
|
|
|
1064
|
Paramètres d'entrée :
|
|
1065
|
|
|
1066
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1067
|
|d'entrée | | | | |
|
|
1068
|
|custId |Chaîne |Nom du compte client ou |Oui |32 caractères |
|
|
1069
|
| | |numéro de contrat | |maximum |
|
|
1070
|
|
|
1071
|
|
|
1072
|
|
|
1073
|
|
|
1074
|
Paramètres en sortie :
|
|
1075
|
|
|
1076
|
|Paramètre de |Type |Description |
|
|
1077
|
|sortie | | |
|
|
1078
|
|listDescriptors |Tableau de |Un tableau de descripteurs de |
|
|
1079
|
| |listDescriptor |listes de destinataires. La |
|
|
1080
|
| | |description d'un descripteur de |
|
|
1081
|
| | |liste de destinataires est fournie|
|
|
1082
|
| | |dans la section 7.4. |
|
|
1083
|
|
|
1084
|
|
|
1085
|
Remarques :
|
|
1086
|
|
|
1087
|
Dans le cas où un compte client ne possède aucune liste de destinataires,
|
|
1088
|
le Web Service retournera une liste vide.
|
|
1089
|
|
|
1090
|
Post-conditions
|
|
1091
|
• Récupération par l'applicatif client du tableau des listes de
|
|
1092
|
destinataires
|
|
1093
|
|
|
1094
|
|
|
1095
|
|
|
1096
|
|
|
1097
|
|
|
1098
|
Exceptions :
|
|
1099
|
|
|
1100
|
|Description et code |Paramètres d'entrée|
|
|
1101
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1102
|
| |soapHeaderCredentia|
|
|
1103
|
| |ls |
|
|
1104
|
| | |
|
|
1105
|
| | |
|
|
1106
|
|
|
1107
|
|
|
1108
|
|
|
1109
|
|
|
1110
|
|
|
1111
|
|
|
1112
|
14 Créer une liste de diffusion
|
|
1113
|
|
|
1114
|
• méthode addListDescriptor.
|
|
1115
|
|
|
1116
|
|
|
1117
|
Paramètres d'entrée :
|
|
1118
|
|
|
1119
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1120
|
|d'entrée | | | | |
|
|
1121
|
|custId |Chaîne |Nom du compte client ou |Oui |32 |
|
|
1122
|
| | |numéro de contrat | |caractères |
|
|
1123
|
| | | | |maximum |
|
|
1124
|
|list |WSListDescrip|Constitué de listName : |Oui | |
|
|
1125
|
| |tor |32 caractères maximum, | | |
|
|
1126
|
| | |listDescription : 1024 | | |
|
|
1127
|
| | |caractères maximum | | |
|
|
1128
|
|sendProfiles|Chaîne |Liste des destinataires. |Oui | |
|
|
1129
|
|
|
1130
|
|
|
1131
|
|
|
1132
|
|
|
1133
|
Paramètres en sortie :
|
|
1134
|
|
|
1135
|
|Paramètre de sortie |Type |Description |
|
|
1136
|
|listId |Chaîne |Identifiant de la liste |
|
|
1137
|
|
|
1138
|
|
|
1139
|
Remarques :
|
|
1140
|
|
|
1141
|
L'identifiant de la liste désigne une liste de manière unique pour un
|
|
1142
|
compte client donné.
|
|
1143
|
|
|
1144
|
|
|
1145
|
Exceptions :
|
|
1146
|
|
|
1147
|
|Description et code |Paramètres d'entrée|
|
|
1148
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1149
|
| |soapHeaderCredentia|
|
|
1150
|
| |ls |
|
|
1151
|
|La liste des destinataires est manquante (200). |sendProfiles |
|
|
1152
|
|La liste des destinataires n’est pas valide (201). |sendProfiles |
|
|
1153
|
|Le nom des champs de personnalisation ne doit pas |sendProfiles |
|
|
1154
|
|dépasser 30 caractères (202). | |
|
|
1155
|
|La valeur des champs de personnalisation ne doit pas |sendProfiles |
|
|
1156
|
|dépasser 256 caractères (203). | |
|
|
1157
|
|Le nom d'un terminal de la liste des destinataires n'est |sendProfiles |
|
|
1158
|
|pas valide (cf. page 41) (210) | |
|
|
1159
|
|Le nom de la liste de destinataires existe déjà (232). |sendProfiles |
|
|
1160
|
|La description détaillée de la liste de destinataires est|sendProfiles |
|
|
1161
|
|manquante (240). | |
|
|
1162
|
|La description détaillée de la liste de destinataires |sendProfiles |
|
|
1163
|
|n'est pas valide (241). | |
|
|
1164
|
|La description détaillée de la liste de destinataires |listName de list |
|
|
1165
|
|existe déjà (242). | |
|
|
1166
|
|Erreur du gestionnaire de Multi-Diffusion (900). |listDescription de |
|
|
1167
|
| |list |
|
|
1168
|
| |listDescription de |
|
|
1169
|
| |list |
|
|
1170
|
| |listDescription de |
|
|
1171
|
| |list |
|
|
1172
|
| |list |
|
|
1173
|
|
|
1174
|
|
|
1175
|
|
|
1176
|
|
|
1177
|
|
|
1178
|
|
|
1179
|
|
|
1180
|
|
|
1181
|
|
|
1182
|
|
|
1183
|
17 Modifier une liste de diffusion
|
|
1184
|
|
|
1185
|
• méthode modifyListDescriptor
|
|
1186
|
|
|
1187
|
|
|
1188
|
Paramètres d'entrée :
|
|
1189
|
|
|
1190
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1191
|
|d'entrée | | | | |
|
|
1192
|
|custId |Chaîne |Nom du compte client ou |Oui |32 caractères |
|
|
1193
|
| | |numéro de contrat | |maximum |
|
|
1194
|
|list |WSListDes|Constitué de |Oui | |
|
|
1195
|
| |criptor |listId : caractères | | |
|
|
1196
|
| | |numériques | | |
|
|
1197
|
| | |listName : 32 caractères| | |
|
|
1198
|
| | |maximum, | | |
|
|
1199
|
| | |listDescription : 1024 | | |
|
|
1200
|
| | |caractères maximum | | |
|
|
1201
|
|sendProfiles |Chaîne |Liste des destinataires.|Oui | |
|
|
1202
|
|
|
1203
|
Remarques :
|
|
1204
|
|
|
1205
|
- L'identifiant de la liste désigne une liste de manière unique pour un
|
|
1206
|
compte client donné ;
|
|
1207
|
- L'intitulé de la liste fourni remplace l'intitulé existant ;
|
|
1208
|
- La description détaillée de la liste fournie remplace la description
|
|
1209
|
détaillée existante ;
|
|
1210
|
- La liste de destinataires fournie annule/remplace en totalité la liste de
|
|
1211
|
destinataires existante ;
|
|
1212
|
- Un applicatif client ne peut modifier que les listes importées avec le
|
|
1213
|
même CustId.
|
|
1214
|
|
|
1215
|
Paramètres en sortie :
|
|
1216
|
• Aucun
|
|
1217
|
|
|
1218
|
|
|
1219
|
Exceptions :
|
|
1220
|
|
|
1221
|
|Description et code |Paramètres d'entrée|
|
|
1222
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1223
|
| |soapHeaderCredentia|
|
|
1224
|
| |ls |
|
|
1225
|
|La liste des destinataires est manquante (200). |sendProfiles |
|
|
1226
|
|La liste des destinataires n’est pas valide (201). |sendProfiles |
|
|
1227
|
|Le nom des champs de personnalisation ne doit pas |sendProfiles |
|
|
1228
|
|dépasser 30 caractères (202). | |
|
|
1229
|
|La valeur des champs de personnalisation ne doit pas |sendProfiles |
|
|
1230
|
|dépasser 256 caractères (203). | |
|
|
1231
|
|Le nom d'un terminal de la liste des destinataires n'est |sendProfiles |
|
|
1232
|
|pas valide (cf. page 41) (210) | |
|
|
1233
|
|Le nom de la liste de destinataires est manquant (230). |listName de list |
|
|
1234
|
|Le nom de la liste de destinataires n'est pas valide |listName de list |
|
|
1235
|
|(231). | |
|
|
1236
|
|Le nom de la liste de destinataires existe déjà (232). |listName de list |
|
|
1237
|
|La description détaillée de la liste de destinataires est|listDescription de |
|
|
1238
|
|manquante (240). |list |
|
|
1239
|
|La description détaillée de la liste de destinataires |listDescription de |
|
|
1240
|
|n'est pas valide (241). |list |
|
|
1241
|
|La description détaillée de la liste de destinataires |listDescription de |
|
|
1242
|
|existe déjà (242). |list |
|
|
1243
|
|Erreur du gestionnaire de Multi-Diffusion (900). |list |
|
|
1244
|
| | |
|
|
1245
|
| | |
|
|
1246
|
| | |
|
|
1247
|
|
|
1248
|
|
|
1249
|
|
|
1250
|
|
|
1251
|
19 Supprimer une liste de diffusion
|
|
1252
|
|
|
1253
|
• méthode removeListDescriptor.
|
|
1254
|
|
|
1255
|
|
|
1256
|
Paramètres d'entrée :
|
|
1257
|
|
|
1258
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1259
|
|d'entrée | | | | |
|
|
1260
|
|custId |Chaîne |Nom du compte client ou |Oui |32 caractères |
|
|
1261
|
| | |numéro de contrat | |maximum |
|
|
1262
|
|listId |Chaîne |Identifiant de la liste |Oui |caractères |
|
|
1263
|
| | | | |numériques |
|
|
1264
|
|
|
1265
|
Remarques :
|
|
1266
|
|
|
1267
|
- L'identifiant de liste désigne une liste de manière unique pour un compte
|
|
1268
|
client donné ;
|
|
1269
|
- Un applicatif client ne peut supprimer que les listes importées avec le
|
|
1270
|
même CustId.
|
|
1271
|
|
|
1272
|
Paramètre en sortie :
|
|
1273
|
• Aucun
|
|
1274
|
|
|
1275
|
Exceptions :
|
|
1276
|
|
|
1277
|
|Description |Paramètres d'entrée|
|
|
1278
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1279
|
| |soapHeaderCredentia|
|
|
1280
|
| |ls |
|
|
1281
|
|L’identifiant de la liste de destinataires est manquant |listId |
|
|
1282
|
|(220). | |
|
|
1283
|
|L’identifiant de la liste de destinataires n’est pas |listId |
|
|
1284
|
|valide (221). | |
|
|
1285
|
|L’identifiant de la liste de destinataires n’est pas |listId, custId |
|
|
1286
|
|associé à votre compte client (222). | |
|
|
1287
|
| | |
|
|
1288
|
| | |
|
|
1289
|
| | |
|
|
1290
|
|
|
1291
|
|
|
1292
|
|
|
1293
|
|
|
1294
|
|
|
1295
|
|
|
1296
|
|
|
1297
|
21 Stopper la diffusion d’un message
|
|
1298
|
|
|
1299
|
• utiliser la méthode stopMessage.
|
|
1300
|
|
|
1301
|
|
|
1302
|
Paramètres d'entrée :
|
|
1303
|
|
|
1304
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1305
|
|d'entrée | | | | |
|
|
1306
|
|custId |Chaîne |Nom du compte client ou |Oui |32 caractères |
|
|
1307
|
| | |numéro de contrat | |maximum |
|
|
1308
|
|idMessage |int |Identifiant du message |Oui | |
|
|
1309
|
|
|
1310
|
Remarques :
|
|
1311
|
|
|
1312
|
- L'identifiant de message désigne un message de manière unique pour un
|
|
1313
|
compte client donné ;
|
|
1314
|
- Un applicatif client ne peut supprimer que les messages avec le même
|
|
1315
|
CustId.
|
|
1316
|
|
|
1317
|
Paramètres en sortie : WSSendReport
|
|
1318
|
|
|
1319
|
|Paramètre de sortie |Type |Description |
|
|
1320
|
|WSSendReport |msgId |Chaîn|Identifiant de |
|
|
1321
|
| | |e |diffusion. |
|
|
1322
|
|
|
1323
|
|
|
1324
|
|
|
1325
|
|
|
1326
|
|
|
1327
|
Exceptions :
|
|
1328
|
|
|
1329
|
|Description |Paramètres d'entrée|
|
|
1330
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1331
|
| |soapHeaderCredentia|
|
|
1332
|
| |ls |
|
|
1333
|
|L’identifiant du message n’est pas connu pour le compte |idMessage |
|
|
1334
|
|client (602). | |
|
|
1335
|
| | |
|
|
1336
|
| | |
|
|
1337
|
| | |
|
|
1338
|
|
|
1339
|
|
|
1340
|
22 Récupération des MO (Mobile Originated)
|
|
1341
|
|
|
1342
|
• utiliser la méthode listMOs.
|
|
1343
|
|
|
1344
|
|
|
1345
|
Paramètres d'entrée :
|
|
1346
|
|
|
1347
|
|Paramètre |Type |Description |Requis |Contraint|
|
|
1348
|
|d'entrée | | | |ess |
|
|
1349
|
|dateBegin |Date |Une date précise de |Le filtre | |
|
|
1350
|
| | |réception ou la date de |(au | |
|
|
1351
|
| | |début dans le cas d'une |minimum | |
|
|
1352
|
| | |plage calendaire de |une date | |
|
|
1353
|
| | |réception. |de début) | |
|
|
1354
|
|dateEnd |Date |La date de fin dans le cas| | |
|
|
1355
|
| | |d'une plage calendaire de | | |
|
|
1356
|
| | |réception. | | |
|
|
1357
|
|shortNumber |Chaîne |Numéro court | | |
|
|
1358
|
|primaryKeyWord |Chaîne |Mot Clé primaire | | |
|
|
1359
|
|secondaryKeyWord|Chaîne |Mot Clé secondaire | | |
|
|
1360
|
|
|
1361
|
|
|
1362
|
Remarques :
|
|
1363
|
|
|
1364
|
- L'applicatif client peut spécifier dans le filtre de sélection soit une
|
|
1365
|
date précise en utilisant le paramètre dateBegin soit une plage
|
|
1366
|
calendaire en utilisant les paramètres dateBegin et dateEnd. En
|
|
1367
|
conséquence, il n'est pas possible d'utiliser seul le paramètre dateEnd.
|
|
1368
|
Dans le cas où le seul le paramètre dateEnd est renseigné alors le filtre
|
|
1369
|
est considéré comme vide.
|
|
1370
|
- La précision des dates utilisées pour le filtre est de l’ordre de la
|
|
1371
|
seconde.
|
|
1372
|
|
|
1373
|
Paramètres en sortie :
|
|
1374
|
|
|
1375
|
|Paramètre de |Type |Description |
|
|
1376
|
|sortie | | |
|
|
1377
|
|WSResultsMO |Tableau de |Un tableau de MO du compte client |
|
|
1378
|
| |WSResultMO | |
|
|
1379
|
|
|
1380
|
Un tableau de WSResultMO est une collection WSResultMO pour le compte
|
|
1381
|
client. Le WSResultMO est défini par les caractéristiques suivantes :
|
|
1382
|
|
|
1383
|
|Nom attribut |Type |Description |
|
|
1384
|
|WSRe|receiveDate |Date |Date et heure de réception du MO |
|
|
1385
|
|sult| | | |
|
|
1386
|
|MO | | | |
|
|
1387
|
| |shortNumber |Chaîne |Numéro court |
|
|
1388
|
| |primaryKeyword |Chaîne |premier mot clé |
|
|
1389
|
| |secondaryKeyword |Chaîne |second mot clé |
|
|
1390
|
| |alias |Chaîne |Un alias ou le N° de mobile de |
|
|
1391
|
| | | |l’émetteur si SID dédié |
|
|
1392
|
| |message |Chaîne |Le sms réponse |
|
|
1393
|
| |campaignName |Chaine |Nom de la campagne de diffusion |
|
|
1394
|
| | | |associée à la réception du MO |
|
|
1395
|
|
|
1396
|
Remarques :
|
|
1397
|
- Dans le cas où aucun message ne correspond aux critères de sélection
|
|
1398
|
fournis, le compte rendu retourné correspondra à une liste vide.
|
|
1399
|
|
|
1400
|
Exceptions :
|
|
1401
|
|
|
1402
|
|Description et code |Paramètres d'entrée|
|
|
1403
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1404
|
| |soapHeaderCredentia|
|
|
1405
|
| |ls |
|
|
1406
|
|Le filtre de sélection est manquant (600). | |
|
|
1407
|
|La date de début de recherche doit être renseignée (604).| |
|
|
1408
|
|Le compte client n’a pas de configuration pour cette |shortNumber |
|
|
1409
|
|requête (700) |primaryKeyWord |
|
|
1410
|
| |secondaryKeyWord |
|
|
1411
|
|
|
1412
|
|
|
1413
|
|
|
1414
|
|
|
1415
|
|
|
1416
|
|
|
1417
|
|
|
1418
|
|
|
1419
|
|
|
1420
|
24 Récupération des MO24s (Mobile Originated 24h)
|
|
1421
|
|
|
1422
|
• utiliser la méthode listMO24s.
|
|
1423
|
|
|
1424
|
|
|
1425
|
Paramètres d'entrée :
|
|
1426
|
|
|
1427
|
|Paramètre |Type |Description |Requis |Contraint|
|
|
1428
|
|d'entrée | | | |ess |
|
|
1429
|
|dateBegin |Date |Une date précise de |Le filtre | |
|
|
1430
|
| | |réception ou la date de |(au | |
|
|
1431
|
| | |début dans le cas d'une |minimum | |
|
|
1432
|
| | |plage calendaire de |une date | |
|
|
1433
|
| | |réception. |de début) | |
|
|
1434
|
|dateEnd |Date |La date de fin dans le cas| | |
|
|
1435
|
| | |d'une plage calendaire de | | |
|
|
1436
|
| | |réception. | | |
|
|
1437
|
|
|
1438
|
Remarques :
|
|
1439
|
|
|
1440
|
- L'applicatif client peut spécifier dans le filtre de sélection soit une
|
|
1441
|
date précise en utilisant le paramètre dateBegin soit une plage
|
|
1442
|
calendaire en utilisant les paramètres dateBegin et dateEnd. En
|
|
1443
|
conséquence, il n'est pas possible d'utiliser seul le paramètre dateEnd.
|
|
1444
|
Dans le cas où le seul le paramètre dateEnd est renseigné alors le filtre
|
|
1445
|
est considéré comme vide.
|
|
1446
|
- La précision des dates utilisées pour le filtre est de l’ordre de la
|
|
1447
|
seconde.
|
|
1448
|
|
|
1449
|
Paramètres en sortie :
|
|
1450
|
|
|
1451
|
|Paramètre de |Type |Description |
|
|
1452
|
|sortie | | |
|
|
1453
|
|WSResultMO24 |Tableau de |Un tableau de MO24 du compte client|
|
|
1454
|
| |WSResultMO24 | |
|
|
1455
|
|
|
1456
|
Un tableau de WSResultMO24 est une collection WSResultMO24 pour le compte
|
|
1457
|
client. Le WSResultMO24 est défini par les caractéristiques suivantes :
|
|
1458
|
|
|
1459
|
|Nom attribut |Type |Description |
|
|
1460
|
|WSRe|messageMo |Chaîne |Le sms réponse |
|
|
1461
|
|sult| | | |
|
|
1462
|
|MO24| | | |
|
|
1463
|
| |number |Chaîne |Numéro court |
|
|
1464
|
| |receiveDateMo |Date |Date et heure de réception du MO |
|
|
1465
|
| |wsResultsMt24 |Tableau de |Une liste de messages MT à |
|
|
1466
|
| | |wsResultMt2|l’origine du Message MO avec leur |
|
|
1467
|
| | |4 |date de réception |
|
|
1468
|
| | | | |
|
|
1469
|
|
|
1470
|
Remarques :
|
|
1471
|
- Dans le cas où aucun message ne correspond aux critères de sélection
|
|
1472
|
fournis, le compte rendu retourné correspondra à une liste vide.
|
|
1473
|
|
|
1474
|
Exceptions :
|
|
1475
|
|
|
1476
|
|Description et code |Paramètres d'entrée|
|
|
1477
|
|Votre applicatif client n’est pas authentifié (100). |DName, |
|
|
1478
|
| |soapHeaderCredentia|
|
|
1479
|
| |ls |
|
|
1480
|
|La date de début de recherche doit être renseignée (604).| |
|
|
1481
|
|La date de fin de recherche doit être renseignée (605). | |
|
|
1482
|
|Erreur du Web Service du Service de Multi-Diffusion, | |
|
|
1483
|
|option SMS24 pour listMO24 non disponible (902) | |
|
|
1484
|
|
|
1485
|
|
|
1486
|
|
|
1487
|
2 Provisioning
|
|
1488
|
|
|
1489
|
|
|
1490
|
1 Créer un nouveau diffuseur
|
|
1491
|
|
|
1492
|
• méthode createDispatcher
|
|
1493
|
|
|
1494
|
|
|
1495
|
Paramètres d'entrée :
|
|
1496
|
|
|
1497
|
|
|
1498
|
[pic]
|
|
1499
|
|
|
1500
|
|Nom |Type |Description |Requis|Contraintes |
|
|
1501
|
|custId |Chaîne |Nom du compte client ou|Oui |32 caractères |
|
|
1502
|
| | |numéro de contrat | |maximum |
|
|
1503
|
| | |(CVOnnnnnn) | | |
|
|
1504
|
|Be|login |Chaîne |Identifiant du |Oui |256 caractères |
|
|
1505
|
|an| | |diffuseur | |maximum |
|
|
1506
|
|Di| | | | |doit être unique |
|
|
1507
|
|sp| | | | | |
|
|
1508
|
|at| | | | | |
|
|
1509
|
|ch| | | | | |
|
|
1510
|
|er| | | | | |
|
|
1511
|
| |firstname |Chaîne |Prénom du diffuseur |Oui |32 caractères |
|
|
1512
|
| | | | | |maximum |
|
|
1513
|
| |lastname |Chaîne |Nom du diffuseur |Oui |64 caractères |
|
|
1514
|
| | | | | |maximum |
|
|
1515
|
| |status |Chaîne |Activation du compte |Non |0 : activé |
|
|
1516
|
| | | | | |1 : désactivé |
|
|
1517
|
| | | | | |2 : supprimé |
|
|
1518
|
| |language |Chaîne |Langue du diffuseur |Non |fr : Français |
|
|
1519
|
| | | | | |en : Anglais |
|
|
1520
|
| |address |Chaîne |Adresse du diffuseur |Non |256 caractères |
|
|
1521
|
| | | | | |maximum |
|
|
1522
|
| |zipCode |Chaîne |Code postal du |Non |32 caractères |
|
|
1523
|
| | | |diffuseur | |maximum |
|
|
1524
|
| |city |Chaîne |Ville du diffuseur |Non |64 caractères |
|
|
1525
|
| | | | | |maximum |
|
|
1526
|
| |codeCountry |Chaîne |Pays du diffuseur |Non |Doit correspondre à|
|
|
1527
|
| | | | | |un nom de pays |
|
|
1528
|
| | | | | |valide |
|
|
1529
|
| |thresholdSms |Entier |Seuil mensuel de SMS |Non |Une valeur négative|
|
|
1530
|
| | | | | |désactive le seuil.|
|
|
1531
|
| |thresholdMail |Entier |Seuil mensuel de mail |Non | |
|
|
1532
|
| |thresholdFax |Entier |Seuil mensuel de Fax |Non | |
|
|
1533
|
| |thresholdVocal |Entier |Seuil mensuel de |Non | |
|
|
1534
|
| | | |messages vocaux | | |
|
|
1535
|
| |thresholdMms |Entier |Seuil mensuel de MMS |Non | |
|
|
1536
|
| |smsThresholdType|Booléen|Type de seuil pour le |Non |true : seuil |
|
|
1537
|
| | | |média SMS | |bloquant |
|
|
1538
|
| | | | | |false : seuil |
|
|
1539
|
| | | | | |indicatif |
|
|
1540
|
| |phone1 |Chaîne |Numéro de téléphone |Oui* |Doit correspondre à|
|
|
1541
|
| | | |fixe 1 | |un numéro de |
|
|
1542
|
| | | | | |téléphone valide |
|
|
1543
|
| | | | | |* : au moins un des|
|
|
1544
|
| | | | | |5 numéros doit être|
|
|
1545
|
| | | | | |renseigné |
|
|
1546
|
| |phone2 |Chaîne |Numéro de téléphone |Oui* | |
|
|
1547
|
| | | |fixe 2 | | |
|
|
1548
|
| |mobile1 |Chaîne |Numéro de téléphone |Oui* | |
|
|
1549
|
| | | |mobile 1 | | |
|
|
1550
|
| |mobile2 |Chaîne |Numéro de téléphone |Oui* | |
|
|
1551
|
| | | |mobile 2 | | |
|
|
1552
|
| |fax |Chaîne |Numéro de fax |Oui* | |
|
|
1553
|
| |mail |Chaîne |adresse mail du |Oui |256 caractères |
|
|
1554
|
| | | |destinataire | |maximum |
|
|
1555
|
| | | | | |Doit correspondre à|
|
|
1556
|
| | | | | |une adresse mail |
|
|
1557
|
| | | | | |valide |
|
|
1558
|
| | | | | |(nom@fournisseur.co|
|
|
1559
|
| | | | | |m par exemple) |
|
|
1560
|
|
|
1561
|
|
|
1562
|
Remarques :
|
|
1563
|
• Pour les différents seuils, la valeur que vous fournissez correspond
|
|
1564
|
au nombre maximal d’envoi que le diffuseur est autorisé à envoyer
|
|
1565
|
chaque mois. Si vous ne souhaitez pas mettre de seuil, spécifiez une
|
|
1566
|
valeur négative (-1 par exemple).
|
|
1567
|
• Lorsque certains champs facultatifs ne sont pas renseignés,
|
|
1568
|
l’application utilisera les valeurs par défaut suivantes :
|
|
1569
|
|
|
1570
|
|
|
1571
|
|Paramètre d'entrée|Valeur par défaut|
|
|
1572
|
|status |0 (actif) |
|
|
1573
|
|language |fr |
|
|
1574
|
|codeCountry |France |
|
|
1575
|
|smsThresholdType |false |
|
|
1576
|
| |(indicatif) |
|
|
1577
|
|
|
1578
|
|
|
1579
|
|
|
1580
|
|
|
1581
|
|
|
1582
|
|
|
1583
|
|
|
1584
|
|
|
1585
|
|
|
1586
|
|
|
1587
|
Paramètres en sortie :
|
|
1588
|
|
|
1589
|
[pic]
|
|
1590
|
|
|
1591
|
|Nom |Type |Description |
|
|
1592
|
|BeanDispatcherResponse|login |chaîne |identifiant du diffuseur |
|
|
1593
|
| |password |chaîne |mot de passe associé au |
|
|
1594
|
| | | |login du diffuseur |
|
|
1595
|
|
|
1596
|
Remarques :
|
|
1597
|
• Assurez-vous de conservez le mot de passe retourné : il est conservé
|
|
1598
|
de manière cryptée dans notre base de données et nous ne pourrions
|
|
1599
|
vous le rappeler en cas de perte.
|
|
1600
|
|
|
1601
|
|
|
1602
|
Exceptions :
|
|
1603
|
|
|
1604
|
[pic]
|
|
1605
|
|
|
1606
|
|
|
1607
|
|
|
1608
|
|Code |Description (message) |Paramètres |
|
|
1609
|
| | |concernés |
|
|
1610
|
|100 |Votre applicatif client n’est pas authentifié |DName, |
|
|
1611
|
| | |SoapHeaderCredentia|
|
|
1612
|
| | |ls |
|
|
1613
|
|1000 |Le format du login n'est pas valide |login |
|
|
1614
|
|1002 |Le login est déjà utilisé |login |
|
|
1615
|
|1003 |Le login est une chaîne vide |login |
|
|
1616
|
|1004 |Le login est "NULL" |login |
|
|
1617
|
|2000 |Le nom est une chaîne vide ou dépassant 64 |lastname |
|
|
1618
|
| |caractères | |
|
|
1619
|
|2001 |Le nom est "NULL" |lastname |
|
|
1620
|
|2002 |Le prénom est une chaîne vide ou dépassant 32 |firstname |
|
|
1621
|
| |caractères | |
|
|
1622
|
|2003 |Le prénom est "NULL" |firstname |
|
|
1623
|
|2004 |La valeur du statut n’est pas valide |status |
|
|
1624
|
|2005 |L'adresse dépasse 256 caractères |adress |
|
|
1625
|
|2006 |Le code postal dépasse 32 caractères |zipCode |
|
|
1626
|
|3000 |Le nom pays n'est pas reconnu |codeCountry |
|
|
1627
|
|3001 |La langue est inconnue |language |
|
|
1628
|
|3002 |L’adresse mail dépasse 256 caractères |mail |
|
|
1629
|
|3003 |L’adresse mail n’set pas valide |mail |
|
|
1630
|
|3004 |L'adresse mail est "NULL". |mail |
|
|
1631
|
|3005 |Le nom de la ville dépasse 64 caractères. |city |
|
|
1632
|
|3006 |Pas de numéro de téléphone valide. |phone1, mobile1 ou |
|
|
1633
|
| | |fax |
|
|
1634
|
|3007 |Le numéro de téléphone n’est pas valide. |phone1, phone2, |
|
|
1635
|
| | |mobile1 ou mobile2 |
|
|
1636
|
|3008 |Le numéro de fax n’est pas valide. |fax |
|
|
1637
|
|4000 |Problème lors de la sauvegarde du diffuseur. | |
|
|
1638
|
|4001 |Problème lors de la sauvegarde des seuils. | |
|
|
1639
|
|9001 |Erreur du webservice de gestion des diffuseurs | |
|
|
1640
|
|
|
1641
|
|
|
1642
|
3 Modifier un diffuseur
|
|
1643
|
|
|
1644
|
• méthode modifyDispatcher
|
|
1645
|
|
|
1646
|
Paramètres d’entrée :
|
|
1647
|
|
|
1648
|
|
|
1649
|
Les paramètres d’entrée sont identiques à ceux de la méthode
|
|
1650
|
createDispatcher, référez-vous au paragraphe 5.2.1.
|
|
1651
|
|
|
1652
|
|
|
1653
|
Remarques :
|
|
1654
|
• Le login ne peut pas être modifié : c’est le champ qui permet
|
|
1655
|
d’identifier le diffuseur à modifier.
|
|
1656
|
• Les valeurs précédentes des autres champs ne sont pas conservées : si
|
|
1657
|
un champ n’est pas spécifié lors de la modification, les valeurs par
|
|
1658
|
défaut lui sont appliquées. Il est donc important de renseigner
|
|
1659
|
l’ensemble des champs, même ceux dont vous ne souhaitez pas changer la
|
|
1660
|
valeur. Vous pouvez utiliser la méthode retrieveDispatcher décrite
|
|
1661
|
page 36 pour retrouver ces informations.
|
|
1662
|
Par exemple : si vous ne précisez pas de numéro de fax qu’il était
|
|
1663
|
précédemment renseigné, il n’y aura plus de numéro de fax associé au
|
|
1664
|
diffuseur après modification.
|
|
1665
|
• Lors de la modification d’un diffuseur, la valeur courante de chaque
|
|
1666
|
seuil est conservée (sauf si le seuil est désactivé).
|
|
1667
|
|
|
1668
|
Paramètres en sortie :
|
|
1669
|
Aucun
|
|
1670
|
|
|
1671
|
|
|
1672
|
|
|
1673
|
Exceptions :
|
|
1674
|
|
|
1675
|
[pic]
|
|
1676
|
|
|
1677
|
|
|
1678
|
|
|
1679
|
En plus des exceptions communes avec la méthode createDispatcher indiquées
|
|
1680
|
au paragraphe 5.2.1, les codes d’erreur suivants peuvent survenir :
|
|
1681
|
|
|
1682
|
|Code |Description (message) |Paramètres |
|
|
1683
|
| | |concernés |
|
|
1684
|
|100 |Votre applicatif client n’est pas authentifié |DName, |
|
|
1685
|
| | |SoapHeaderCredentia|
|
|
1686
|
| | |ls |
|
|
1687
|
|4002 |Problème lors de la modification du diffuseur | |
|
|
1688
|
|4003 |Le diffuseur associé au login spécifié n’a pas |login |
|
|
1689
|
| |été trouvé | |
|
|
1690
|
|4005 |Les seuils du diffuseur n’ont pas pu être | |
|
|
1691
|
| |retrouvés | |
|
|
1692
|
|
|
1693
|
|
|
1694
|
4 Supprimer un diffuseur
|
|
1695
|
|
|
1696
|
• utiliser la méthode removeDispatcher
|
|
1697
|
|
|
1698
|
|
|
1699
|
Paramètres d’entrée :
|
|
1700
|
|
|
1701
|
[pic]
|
|
1702
|
|
|
1703
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1704
|
|d'entrée | | | | |
|
|
1705
|
|custId |Chaîne |Nom du compte client|Oui |32 caractères |
|
|
1706
|
| | |ou numéro de contrat| |maximum |
|
|
1707
|
| | |(CVOnnnnnn) | | |
|
|
1708
|
|login |Chaîne |Identifiant du |Oui |256 caractères |
|
|
1709
|
| | |diffuseur | |maximum |
|
|
1710
|
| | | | |doit être unique |
|
|
1711
|
|
|
1712
|
Remarques :
|
|
1713
|
• Toutes les informations relatives au diffuseur sont supprimées, il
|
|
1714
|
n’est pas possible d’y accéder après suppression.
|
|
1715
|
|
|
1716
|
|
|
1717
|
Paramètres en sortie :
|
|
1718
|
Aucun
|
|
1719
|
|
|
1720
|
|
|
1721
|
|
|
1722
|
Exceptions :
|
|
1723
|
|
|
1724
|
|Code |Description (message) |Paramètres |
|
|
1725
|
| | |concernés |
|
|
1726
|
|100 |Votre applicatif client n’est pas authentifié |DName, |
|
|
1727
|
| | |SoapHeaderCredentia|
|
|
1728
|
| | |ls |
|
|
1729
|
|4003 |Le diffuseur associé au login spécifié n’a pas |login |
|
|
1730
|
| |été trouvé | |
|
|
1731
|
|4004 |Problème lors de la suppression du diffuseur | |
|
|
1732
|
|9001 |Erreur du webservice de gestion des diffuseurs | |
|
|
1733
|
| | | |
|
|
1734
|
| | | |
|
|
1735
|
| | | |
|
|
1736
|
5 Retrouver les informations d’un diffuseur
|
|
1737
|
|
|
1738
|
• méthode retrieveDispatcher
|
|
1739
|
|
|
1740
|
|
|
1741
|
Paramètres d’entrée :
|
|
1742
|
|
|
1743
|
|
|
1744
|
|
|
1745
|
[pic]
|
|
1746
|
|
|
1747
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1748
|
|d'entrée | | | | |
|
|
1749
|
|custId |Chaîne|Nom du compte |Oui |32 caractères |
|
|
1750
|
| | |client ou numéro | |maximum |
|
|
1751
|
| | |de contrat | | |
|
|
1752
|
| | |(CVOnnnnnn) | | |
|
|
1753
|
|login |Chaîne|Identifiant du |Oui |256 caractères |
|
|
1754
|
| | |diffuseur | |maximum |
|
|
1755
|
| | | | |doit être unique |
|
|
1756
|
|
|
1757
|
Remarques :
|
|
1758
|
• Cette méthode peut être utilisée en vu de conserver les informations
|
|
1759
|
d’un diffuseur lors de la modification de celui-ci
|
|
1760
|
|
|
1761
|
Paramètres en sortie :
|
|
1762
|
|
|
1763
|
[pic]
|
|
1764
|
|
|
1765
|
|
|
1766
|
|Nom |Type |Description |
|
|
1767
|
|Be|login |Chaîne |Identifiant du diffuseur |
|
|
1768
|
|an| | | |
|
|
1769
|
|Di| | | |
|
|
1770
|
|sp| | | |
|
|
1771
|
|at| | | |
|
|
1772
|
|ch| | | |
|
|
1773
|
|er| | | |
|
|
1774
|
| |firstname |Chaîne |Prénom du diffuseur |
|
|
1775
|
| |lastname |Chaîne |Nom du diffuseur |
|
|
1776
|
| |status |Chaîne |Activation du compte |
|
|
1777
|
| |language |Chaîne |Langue du diffuseur |
|
|
1778
|
| |address |Chaîne |Adresse du diffuseur |
|
|
1779
|
| |zipCode |Chaîne |Code postal du diffuseur |
|
|
1780
|
| |city |Chaîne |Ville du diffuseur |
|
|
1781
|
| |codeCountry |Chaîne |Pays du diffuseur |
|
|
1782
|
| |thresholdSms |Entier |Seuil mensuel de SMS |
|
|
1783
|
| |thresholdMail |Entier |Seuil mensuel de mail |
|
|
1784
|
| |thresholdFax |Entier |Seuil mensuel de Fax |
|
|
1785
|
| |thresholdVocal |Entier |Seuil mensuel de messages |
|
|
1786
|
| | | |vocaux |
|
|
1787
|
| |thresholdMms |Entier |Seuil mensuel de MMS |
|
|
1788
|
| |smsThresholdType|Booléen|Type de seuil pour le |
|
|
1789
|
| | | |média SMS |
|
|
1790
|
| |phone1 |Chaîne |Numéro de téléphone fixe 1|
|
|
1791
|
| |phone2 |Chaîne |Numéro de téléphone fixe 2|
|
|
1792
|
| |mobile1 |Chaîne |Numéro de téléphone mobile|
|
|
1793
|
| | | |1 |
|
|
1794
|
| |mobile2 |Chaîne |Numéro de téléphone mobile|
|
|
1795
|
| | | |2 |
|
|
1796
|
| |fax |Chaîne |Numéro de fax |
|
|
1797
|
| |mail |Chaîne |adresse mail du |
|
|
1798
|
| | | |destinataire |
|
|
1799
|
|
|
1800
|
|
|
1801
|
|
|
1802
|
|
|
1803
|
|
|
1804
|
|
|
1805
|
Exceptions :
|
|
1806
|
|
|
1807
|
|Code |Description (message) |Paramètres |
|
|
1808
|
| | |concernés |
|
|
1809
|
|100 |Votre applicatif client n’est pas authentifié | DName, |
|
|
1810
|
| | |SoapHeaderCredentia|
|
|
1811
|
| | |ls |
|
|
1812
|
|4003 |Le diffuseur associé au login spécifié n’a pas |login |
|
|
1813
|
| |été trouvé | |
|
|
1814
|
|4005 |Les seuils du diffuseur n’ont pas pu être | |
|
|
1815
|
| |retrouvés | |
|
|
1816
|
|9001 |Erreur du webservice de gestion des diffuseurs | |
|
|
1817
|
| | | |
|
|
1818
|
| | | |
|
|
1819
|
7 Changer le mot de passe d’un diffuseur
|
|
1820
|
|
|
1821
|
• méthode changeDispatcherPassword
|
|
1822
|
|
|
1823
|
|
|
1824
|
Paramètres d’entrée :
|
|
1825
|
|
|
1826
|
[pic]
|
|
1827
|
|
|
1828
|
|Paramètre |Type |Description |Requis |Contraintes |
|
|
1829
|
|d'entrée | | | | |
|
|
1830
|
|custId |Chaîne|Nom du compte |Oui |32 caractères |
|
|
1831
|
| | |client ou numéro | |maximum |
|
|
1832
|
| | |de contrat | | |
|
|
1833
|
| | |(CVOnnnnnn) | | |
|
|
1834
|
|login |Chaîne|Identifiant du |Oui |256 caractères |
|
|
1835
|
| | |diffuseur | |maximum |
|
|
1836
|
| | | | |doit être unique |
|
|
1837
|
|
|
1838
|
|
|
1839
|
|
|
1840
|
Paramètres en sortie :
|
|
1841
|
|
|
1842
|
[pic]
|
|
1843
|
|
|
1844
|
|Nom |Type |Description |
|
|
1845
|
|BeanDispatcherResponse|login |chaîne |identifiant du diffuseur |
|
|
1846
|
| |password |chaîne |mot de passe associé au login |
|
|
1847
|
| | | |du diffuseur |
|
|
1848
|
|
|
1849
|
Remarques :
|
|
1850
|
• Assurez-vous de conservez le mot de passe retourné : il est conservé
|
|
1851
|
de manière cryptée dans notre base de données et nous ne pourrions
|
|
1852
|
vous le rappeler en cas de perte.
|
|
1853
|
|
|
1854
|
|
|
1855
|
|
|
1856
|
|
|
1857
|
Exceptions :
|
|
1858
|
|
|
1859
|
|Code |Description (message) |Paramètres |
|
|
1860
|
| | |concernés |
|
|
1861
|
|100 |Votre applicatif client n’est pas authentifié |DName, |
|
|
1862
|
| | |SoapHeaderCredentia|
|
|
1863
|
| | |ls |
|
|
1864
|
|4003 |Le diffuseur associé au login spécifié n’a pas |login |
|
|
1865
|
| |été trouvé | |
|
|
1866
|
|4000 |Problème lors de la sauvegarde du diffuseur. | |
|
|
1867
|
Gestion des erreurs
|
|
1868
|
|
|
1869
|
|
|
1870
|
1 sur les pièces jointes
|
|
1871
|
|
|
1872
|
|
|
1873
|
|
|
1874
|
Exceptions :
|
|
1875
|
|
|
1876
|
|Description |Paramètres d'entrée|
|
|
1877
|
|La taille de la pièce jointe audio dépasse la taille |audioFile |
|
|
1878
|
|maximum autorisée : 1Mo (500). | |
|
|
1879
|
|Le nombre de pièce jointe audio dépasse le nombre maximum|audioFile |
|
|
1880
|
|admis (maximum 1 pièce jointe audio). (501). | |
|
|
1881
|
|La taille de la pièce jointe autre dépasse la taille |attachedFile |
|
|
1882
|
|maximum autorisée : 1Mo (520) | |
|
|
1883
|
|Le nombre de pièce jointe dépasse le nombre maximum admis|attachedFile |
|
|
1884
|
|(maximum 1 pièce jointe autre) (521) | |
|
|
1885
|
|Le nombre de pièce(s) jointe(s) dépassent le seuil |audioFile ou |
|
|
1886
|
|autorisé (maximum 2) (551) |attachedFile |
|
|
1887
|
|Le fichier audio doit avoir une extension autorisée | |
|
|
1888
|
|(.wav) (552). | |
|
|
1889
|
|La pièce jointe à une extension non autorisée (553). | |
|
|
1890
|
|La pièce jointe n'est pas valide. Paramètre : audioFile |audioFile ou |
|
|
1891
|
|ou attachedFile (554). |attachedFile |
|
|
1892
|
|Celui-ci doit avoir la forme suivante : | |
|
|
1893
|
|mdws-audio/{name.ext} ou mdws-attached/{name.ext} | |
|
|
1894
|
|où {name.ext} est le nom de la pièce jointe | |
|
|
1895
|
| | |
|
|
1896
|
|Pour un fichier word "test.doc" la PJ doit être nommée :| |
|
|
1897
|
|"mdws-attached/test.doc" | |
|
|
1898
|
|Pour un fichier audio "test.wav" la PJ doit être nommée :| |
|
|
1899
|
|"mdws-audio/test.wav" | |
|
|
1900
|
|
|
1901
|
|
|
1902
|
Précision sur les formats de fichiers autorisés ou interdits :
|
|
1903
|
|
|
1904
|
extension de fichier vocal autorisée : .wav
|
|
1905
|
|
|
1906
|
extensions de fichiers joints non autorisées pour les diffusions de mail :
|
|
1907
|
.ade,.adp,.app,.asp,.asx,.bas,.bat,.cer,.chm,.cmd,.com,.cpl,.crt,.csh,.exe,.
|
|
1908
|
fxp,.hlp,.hta,.inf,.ins,.isp,.js,.jse,.ksh,.lnk,.mda,.mdb,.mdt,.mdw,.mde,.md
|
|
1909
|
z,.msc,.msi,.msp,.mst,.ops,.pcd,.pif,.prf,.prg,.pst,.reg,.scf,.scr,.sct,.shb
|
|
1910
|
,.shs,.tmp,.url,.vb,.vbe,.vbs,.vsmacros,.vss,.vst,.vsw,.ws,.wsc,.wsf,.wsh
|
|
1911
|
|
|
1912
|
extensions autorisées de fichiers joints aux diffusions de fax :
|
|
1913
|
.pdf,.txt,.doc,.docx,.xls,.xlsx,.tif,.tiff,.jpg,.jpeg,.htm,.html,.ppt,.pptx,
|
|
1914
|
.rtf
|
|
1915
|
|
|
1916
|
2 Gestion des autres erreurs : erreur 901
|
|
1917
|
|
|
1918
|
|
|
1919
|
L’erreur 901 est l’exception par défaut.
|
|
1920
|
|
|
1921
|
|
|
1922
|
|
|
1923
|
|
|
1924
|
|
|
1925
|
|
|
1926
|
Concept des données manipulées
|
|
1927
|
|
|
1928
|
|
|
1929
|
Nous présentons ici les concepts de données manipulés par Contact Everyone.
|
|
1930
|
Certaines caractéristiques servent pour initier une diffusion de message,
|
|
1931
|
d'autres n'ont de sens que pour présenter les résultats de diffusion.
|
|
1932
|
|
|
1933
|
1 Liste des destinataires (en entrée de sendMessage)
|
|
1934
|
|
|
1935
|
|
|
1936
|
|
|
1937
|
|Nom attribut |Type |Description |
|
|
1938
|
|Liste des destinataires |
|
|
1939
|
|Dest|destId |Chaîne |Identifiant du destinataire |
|
|
1940
|
|inat| | |(identifiant unique, cf. |
|
|
1941
|
|aire| | |ci-dessous) |
|
|
1942
|
| |destName |Chaîne |Nom du destinataire (64 caractères|
|
|
1943
|
| | | |maximum, tronqué si plus de 64 |
|
|
1944
|
| | | |caractères) |
|
|
1945
|
| |destForeName |Chaîne |Prénom du destinataire (32 car. |
|
|
1946
|
| | | |maximum, tronqué si plus de 32 |
|
|
1947
|
| | | |caractères) |
|
|
1948
|
| |Liste de terminaux utilisés pour le destinataire |
|
|
1949
|
| |Termi|name |Chaîne |Nom du terminal (énumération : cf.|
|
|
1950
|
| |nal | | |ci-dessous) |
|
|
1951
|
| | |addr |Chaîne |Adresse du terminal ( adresse mail|
|
|
1952
|
| | | | |ou num.tel ) |
|
|
1953
|
| | |Liste des média disponibles sur le terminal |
|
|
1954
|
| | |Me|type |Chaîne |Type de média (énumération : |
|
|
1955
|
| | |di| | |mail_html, mail, tel, fax, sms) |
|
|
1956
|
| | |a | | | |
|
|
1957
|
|
|
1958
|
Identifiant du destinataire (champ destId)
|
|
1959
|
|
|
1960
|
Pour assurer le bon fonctionnement de la Diffusion et de son suivi, le
|
|
1961
|
champ destId doit systématiquement être unique.
|
|
1962
|
|
|
1963
|
Ce champ destId est de type ID (dérive de NCName et doit être unique).
|
|
1964
|
Cela implique qu'il doit commencer par une lettre ou le caractère '_' et
|
|
1965
|
n'accepte pas le caractère ':' (cf. spécifications XML Schéma :
|
|
1966
|
http://www.w3.org/TR/1999/REC-xml-names-19990114/#NT-NCName).
|
|
1967
|
|
|
1968
|
|[4]|NCName |::= |(Letter | '_') (NCNameChar)* |/*An XML Name, |
|
|
1969
|
| | | | |minus the ":" */ |
|
|
1970
|
|[5]|NCNameChar|::= |Letter | Digit | '.' | '-' | |
|
|
1971
|
| | | || '_' | CombiningChar | |
|
|
1972
|
| | | || Extender | |
|
|
1973
|
|
|
1974
|
|
|
1975
|
|
|
1976
|
Exemple d'identifiants de destinataire erronés : 2ListeApp (l'identifiant
|
|
1977
|
commence par un chiffre), App:Profiles (le caractère ':' n'est pas
|
|
1978
|
accepte).
|
|
1979
|
|
|
1980
|
Exemple d'identifiants de destinataire valides : App-Profiles,
|
|
1981
|
IDProfile1.
|
|
1982
|
|
|
1983
|
Enumération des noms de terminaux (champ Terminal.name)
|
|
1984
|
|
|
1985
|
- mail | personnal_messaging | email
|
|
1986
|
|
|
1987
|
- office | home | phone1 => correspondant au téléphone fixe 1
|
|
1988
|
|
|
1989
|
- phone2 => correspondant au téléphone fixe 2
|
|
1990
|
|
|
1991
|
- personnal_fax
|
|
1992
|
|
|
1993
|
- personnal_mobile | professional_mobile | mobile1 => on doit trouver
|
|
1994
|
pour cette balise MEDIA_TYPE_GROUP, celle-ci permet d'orienter
|
|
1995
|
l'utilisation du mobile soit pour le vocal (tel) soit pour le sms
|
|
1996
|
(sms), soit pour les deux.
|
|
1997
|
|
|
1998
|
- mobile2 => correspondant au téléphone mobile 2
|
|
1999
|
|
|
2000
|
Les adresses des terminaux doivent suivre les syntaxes suivantes :
|
|
2001
|
• Tel fixe, tel mobile, fax (10 chiffres) : [0-9]{10,10}
|
|
2002
|
• Tel ou Fax International : ^[+][1-9]{1,3}[0-9]{6,19}
|
|
2003
|
• Email : ([\-\w_.'+])+@(([\-\w])+\.)+([\w]{2,4})
|
|
2004
|
|
|
2005
|
i.e : un numéro français pourra être de la forme 06nnnnnnnn ou +336nnnnnnnn
|
|
2006
|
( 02nnnnnnnn ou +332nnnnnnnn )
|
|
2007
|
un numéro international de la forme + (ind pays) (num tel)
|
|
2008
|
ex :+324nnnnnnnnnnn
|
|
2009
|
|
|
2010
|
|
|
2011
|
Les expressions régulières fournies suivent la syntaxe de Perl.
|
|
2012
|
|
|
2013
|
La liste des destinataires correspond à une chaîne de caractères
|
|
2014
|
représentant le flux XML pour cette liste de destinataires.
|
|
2015
|
Nous donnons ci-dessous un exemple de flux XML attendu :
|
|
2016
|
Remarque :
|
|
2017
|
Dans les exemples xml, les couleurs n’ont pas de signification et ne sont
|
|
2018
|
utilisées que pour faciliter la lecture.
|
|
2019
|
|
|
2020
|
|
|
2021
|
<?xml version="1.0" ?>
|
|
2022
|
<PROFILE_LIST>
|
|
2023
|
<PROFILE>
|
|
2024
|
<DEST_NAME>Dupond</DEST_NAME>
|
|
2025
|
<DEST_FORENAME>Martine</DEST_FORENAME>
|
|
2026
|
<DEST_ID>ID_Profile1</DEST_ID>
|
|
2027
|
<TERMINAL_GROUP>
|
|
2028
|
<TERMINAL>
|
|
2029
|
<TERMINAL_NAME>personnal_messaging</TERMINAL_NAME>
|
|
2030
|
<TERMINAL_ADDR>
|
|
2031
|
martine.dupond@domicile.tm.fr</TERMINAL_ADDR>
|
|
2032
|
<MEDIA_TYPE_GROUP>
|
|
2033
|
<MEDIA_TYPE>mail</MEDIA_TYPE>
|
|
2034
|
</MEDIA_TYPE_GROUP>
|
|
2035
|
</TERMINAL>
|
|
2036
|
</TERMINAL_GROUP>
|
|
2037
|
</PROFILE>
|
|
2038
|
<PROFILE>
|
|
2039
|
<DEST_NAME>Dupond</DEST_NAME>
|
|
2040
|
<DEST_FORENAME> Martine</DEST_FORENAME>
|
|
2041
|
<DEST_ID>ID_Profile2</DEST_ID>
|
|
2042
|
<TERMINAL_GROUP>
|
|
2043
|
<TERMINAL>
|
|
2044
|
<TERMINAL_NAME>home</TERMINAL_NAME>
|
|
2045
|
<TERMINAL_ADDR>0123456789</TERMINAL_ADDR>
|
|
2046
|
<MEDIA_TYPE_GROUP>
|
|
2047
|
<MEDIA_TYPE>tel</MEDIA_TYPE>
|
|
2048
|
</MEDIA_TYPE_GROUP>
|
|
2049
|
</TERMINAL>
|
|
2050
|
</TERMINAL_GROUP>
|
|
2051
|
</PROFILE>
|
|
2052
|
</PROFILE_LIST>
|
|
2053
|
|
|
2054
|
|
|
2055
|
|
|
2056
|
2 Liste de comptes rendus résumés de la diffusion de messages (en sortie de
|
|
2057
|
WSResultReport)
|
|
2058
|
|
|
2059
|
Une liste de résumés de compte rendus est une collection de résumés de
|
|
2060
|
compte rendus de diffusion de messages. Le résumé de compte rendu de
|
|
2061
|
résultat de la diffusion d'un message est défini par les caractéristiques
|
|
2062
|
suivantes :
|
|
2063
|
|
|
2064
|
|Nom attribut |Type |Description |
|
|
2065
|
|custId |Chaîne |Nom du compte client ou numéro de |
|
|
2066
|
| | |contrat |
|
|
2067
|
|orgName |Chaîne |Identifiant de l'organisation ou |
|
|
2068
|
| | |du service émetteur (non utilisé) |
|
|
2069
|
|Mess|msgId |Chaîne |Identifiant message généré |
|
|
2070
|
|age | | | |
|
|
2071
|
| |from |Chaîne |Alias ou adresse e-mail émetteur |
|
|
2072
|
| | | |du message (pour retour mail). |
|
|
2073
|
| | | |(non utilisé) |
|
|
2074
|
| |to |Chaîne |Alias destinataires. (non utilisé)|
|
|
2075
|
| |subject |Chaîne |Sujet du message. |
|
|
2076
|
| |content |Chaîne |Contenu détaillé du message. |
|
|
2077
|
| | | |(archivé pendant 3 mois). |
|
|
2078
|
| |resumeContent |Chaine |Resumé du message. (archivé |
|
|
2079
|
| | | |pendant 3 mois). |
|
|
2080
|
| |audioFileName |Chaîne |Nom de la pièce jointe audio (si |
|
|
2081
|
| | | |alimenté lors de l'envoi). |
|
|
2082
|
| | | |(archivé pendant 3 mois). |
|
|
2083
|
| |attachedFileName |Chaîne |Nom de la pièce jointe autre (si |
|
|
2084
|
| | | |alimenté lors de l'envoi). |
|
|
2085
|
| | | |(archivé pendant 3 mois). |
|
|
2086
|
| |status |Chaîne |Status de diffusion du message |
|
|
2087
|
| | | |(énumération : CREATED, SCHEDULED,|
|
|
2088
|
| | | |RUNNING, COMPLETED, CANCELED, |
|
|
2089
|
| | | |REJECTED, FAILED_NOTILUS, |
|
|
2090
|
| | | |SENT_TO_NOTILUS, |
|
|
2091
|
| | | |INSERTED_IN_DATABASE). |
|
|
2092
|
| |Date |Date |Date et heure de demande de |
|
|
2093
|
| | | |diffusion ou la date de |
|
|
2094
|
| | | |programmation différée. |
|
|
2095
|
|strategy |Chaîne |Nom de la stratégie. |
|
|
2096
|
|nbProfiles |Chaîne |Le nombre de destinataires dans la|
|
|
2097
|
| | |liste des destinataires fournie |
|
|
2098
|
| | |lors de l'envoi de message. |
|
|
2099
|
|
|
2100
|
La seule différence (de taille) entre un résumé de compte rendu (en sortie
|
|
2101
|
de WSResultReport) et un compte rendu détaillé de la diffusion de messages
|
|
2102
|
(en sortie de WSFullResultReport), est que le résumé de compte rendu ne
|
|
2103
|
contient pas la liste des destinataires (et donc aussi les informations de
|
|
2104
|
déroulement de la diffusion par média).
|
|
2105
|
|
|
2106
|
cf algorithme § 5.1.6
|
|
2107
|
|
|
2108
|
3 Liste de comptes rendus détaillés de la diffusion de messages (en sortie
|
|
2109
|
de WSListFullResultReport)
|
|
2110
|
|
|
2111
|
Une liste de comptes-rendus détaillés est une collection de comptes-rendus
|
|
2112
|
détaillés de diffusion de messages. Le compte-rendu détaillé de résultat de
|
|
2113
|
la diffusion d'un message est défini par les caractéristiques suivantes :
|
|
2114
|
|
|
2115
|
|Nom attribut |Type |Description |
|
|
2116
|
|custId |Chaîne |Nom du compte client ou numéro de |
|
|
2117
|
| | |contrat |
|
|
2118
|
|orgName |Chaîne |(non utilisé). |
|
|
2119
|
|Mess|msgId |Chaîne |Identifiant message généré |
|
|
2120
|
|age | | | |
|
|
2121
|
| |from |Chaîne | (non utilisé). |
|
|
2122
|
| |to |Chaîne | (non utilisé) |
|
|
2123
|
| |subject |Chaîne |Sujet du message. |
|
|
2124
|
| |content |Chaîne |Contenu détaillé du message. |
|
|
2125
|
| | | |(archivé pendant 3 mois) |
|
|
2126
|
| |resumeContent |Chaine |Résumé du message. (archivé |
|
|
2127
|
| | | |pendant 3 mois) |
|
|
2128
|
| |audioFileName |Chaîne |Nom de la pièce jointe audio (si |
|
|
2129
|
| | | |alimenté lors de l'envoi). |
|
|
2130
|
| | | |(archivé pendant 3 mois) |
|
|
2131
|
| |attachedFileName |Chaîne |Nom de la pièce jointe autre (si |
|
|
2132
|
| | | |alimenté lors de l'envoi). |
|
|
2133
|
| | | |(archivé pendant 3 mois) |
|
|
2134
|
| |status |Chaîne |Status de diffusion du message |
|
|
2135
|
| | | |(énumération : CREATED, SCHEDULED,|
|
|
2136
|
| | | |RUNNING, COMPLETED, CANCELED, |
|
|
2137
|
| | | |REJECTED, FAILED_NOTILUS, |
|
|
2138
|
| | | |SENT_TO_NOTILUS, |
|
|
2139
|
| | | |INSERTED_IN_DATABASE). |
|
|
2140
|
| |date |Date |Date et heure de demande de |
|
|
2141
|
| | | |diffusion ou la date de |
|
|
2142
|
| | | |programmation différée. |
|
|
2143
|
|strategy |Chaîne |Nom de la stratégie appliquée |
|
|
2144
|
|nbProfiles |Chaîne |Le nombre de destinataires dans la|
|
|
2145
|
| | |liste des destinataires fournie |
|
|
2146
|
| | |lors de l'envoi de message |
|
|
2147
|
|
|
2148
|
|Liste des destinataires où les champs média ont été mis à jour par |
|
|
2149
|
|rapport au déroulement de la diffusion. |
|
|
2150
|
|Dest|destId |Chaîne |Identifiant du destinataire |
|
|
2151
|
|inat| | | |
|
|
2152
|
|aire| | | |
|
|
2153
|
| |destName |Chaîne |Nom du destinataire |
|
|
2154
|
| |destForeName |Chaîne |Prénom du destinataire |
|
|
2155
|
| |Liste de terminaux utilisés pour le destinataire |
|
|
2156
|
| |Termi|name |Chaîne |Nom du terminal (énumération : cf.|
|
|
2157
|
| |nal | | |section 7.1) |
|
|
2158
|
| | |addr |Chaîne |Adresse du terminal |
|
|
2159
|
| | |Liste des appels (call) effectués sur les média rattachés au |
|
|
2160
|
| | |terminal |
|
|
2161
|
| | |Call |type |Chaîne |Type de média (énumération : |
|
|
2162
|
| | |Media| | |mail_html, mail, tel, fax, sms) |
|
|
2163
|
| | | |res |Chaîne |Résultat de diffusion pour le |
|
|
2164
|
| | | | | |média issu de l'adaptateur |
|
|
2165
|
| | | |diag |Chaîne |Diagnostic complémentaire |
|
|
2166
|
| | | | | |(spécifique diffuseur[1]) |
|
|
2167
|
| | | |date |Date |Date/heure de l’enregistrement de |
|
|
2168
|
| | | | | |l'accusé de réception |
|
|
2169
|
|
|
2170
|
Enumération des résultats de messages (champ Media.res)
|
|
2171
|
|
|
2172
|
Les états possibles de résultats pour un appel vers un unique terminal :
|
|
2173
|
|
|
2174
|
SCHEDULED : appel planifié
|
|
2175
|
UNSCHEDULED : appel pas encore planifié
|
|
2176
|
FAILED : appel échoué
|
|
2177
|
SUCCEEDED : appel réussi
|
|
2178
|
STOPPED : appel arrêté (suite à une commande ARRETER)
|
|
2179
|
TIMED_OUT : absence de réponse du diffuseur concerné
|
|
2180
|
|
|
2181
|
Il est important de noter que le compte rendu détaillé peut dans certains
|
|
2182
|
cas ne pas avoir de données pour la liste des destinataires. Ce cas peut
|
|
2183
|
par exemple arriver lors d'un appel qui a échoué.
|
|
2184
|
|
|
2185
|
|
|
2186
|
cf algorithme § 5.1.6
|
|
2187
|
|
|
2188
|
|
|
2189
|
|
|
2190
|
1 Exemples flux XML retourné
|
|
2191
|
|
|
2192
|
|
|
2193
|
La liste des destinataires (attribut WSFullResultReport) correspond à une
|
|
2194
|
chaîne de caractères représentant le flux XML pour cette liste de
|
|
2195
|
destinataires. Nous donnons ci-dessous un exemple de flux XML retourné :
|
|
2196
|
,
|
|
2197
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
2198
|
|
|
2199
|
<PROFILE_LIST>
|
|
2200
|
<PROFILE>
|
|
2201
|
<DEST_ID>ID_Profile1</DEST_ID>
|
|
2202
|
<DEST_NAME>Dupond</DEST_NAME>
|
|
2203
|
<DEST_FORENAME>Martine</DEST_FORENAME>
|
|
2204
|
<TERMINAL_GROUP>
|
|
2205
|
<TERMINAL>
|
|
2206
|
<TERMINAL_NAME>personnal_messaging</TERMINAL_NAME>
|
|
2207
|
|
|
2208
|
<TERMINAL_ADDR>martine.dupond@domicile.tm.fr</TERMINAL_ADDR>
|
|
2209
|
<CALL_GROUP>
|
|
2210
|
<CALL>
|
|
2211
|
<MEDIA>
|
|
2212
|
<MEDIA_TYPE>mail</MEDIA_TYPE>
|
|
2213
|
<MEDIA_RES>SUCCEEDED</MEDIA_RES>
|
|
2214
|
<MEDIA_DIAG>000|Mail transmis au serveur : smtp-
|
|
2215
|
relais.contact-everyone.fr</MEDIA_DIAG>
|
|
2216
|
<MEDIA_DATE>2004-08-
|
|
2217
|
12T14:58:00.000+02:00</MEDIA_DATE>
|
|
2218
|
</MEDIA>
|
|
2219
|
</CALL>
|
|
2220
|
</CALL_GROUP>
|
|
2221
|
</TERMINAL>
|
|
2222
|
</TERMINAL_GROUP>
|
|
2223
|
</PROFILE>
|
|
2224
|
<PROFILE>
|
|
2225
|
<DEST_ID>ID_Profile2</DEST_ID>
|
|
2226
|
<DEST_NAME> Dupond</DEST_NAME>
|
|
2227
|
<DEST_FORENAME>Martine</DEST_FORENAME>
|
|
2228
|
<TERMINAL_GROUP>
|
|
2229
|
<TERMINAL>
|
|
2230
|
<TERMINAL_NAME>home</TERMINAL_NAME>
|
|
2231
|
<TERMINAL_ADDR>0123456789</TERMINAL_ADDR>
|
|
2232
|
<CALL_GROUP>
|
|
2233
|
<CALL>
|
|
2234
|
<MEDIA>
|
|
2235
|
<MEDIA_TYPE>tel</MEDIA_TYPE>
|
|
2236
|
<MEDIA_RES>SUCCEEDED</MEDIA_RES>
|
|
2237
|
<MEDIA_DIAG>000|Message lu;*</MEDIA_DIAG>
|
|
2238
|
<MEDIA_DATE>2004-08-
|
|
2239
|
12T14:58:00.000+02:00</MEDIA_DATE>
|
|
2240
|
</MEDIA>
|
|
2241
|
</CALL>
|
|
2242
|
</CALL_GROUP>
|
|
2243
|
</TERMINAL>
|
|
2244
|
</TERMINAL_GROUP>
|
|
2245
|
</PROFILE>
|
|
2246
|
</PROFILE_LIST>
|
|
2247
|
|
|
2248
|
|
|
2249
|
Autre exemple de flux XML suite à un appel vocal avec aboutement:
|
|
2250
|
|
|
2251
|
<PROFILE_LIST>
|
|
2252
|
<PROFILE>
|
|
2253
|
<DEST_ID>10532894</DEST_ID>
|
|
2254
|
<DEST_NAME/>
|
|
2255
|
<DEST_FORENAME/>
|
|
2256
|
<TERMINAL>
|
|
2257
|
<TERMINAL_NAME>phone1</TERMINAL_NAME>
|
|
2258
|
<TERMINAL_ADDR>numéro du destinataire</TERMINAL_ADDR>
|
|
2259
|
<CALL>
|
|
2260
|
<MEDIA>
|
|
2261
|
<MEDIA_DIAG>000|Message abouté(11);*123</MEDIA_DIAG>
|
|
2262
|
<MEDIA_DATE>2007-07-25 16:46:20.682</MEDIA_DATE>
|
|
2263
|
<MEDIA_RES>SUCCEEDED</MEDIA_RES>
|
|
2264
|
<MEDIA_TYPE>tel</MEDIA_TYPE>
|
|
2265
|
</MEDIA>
|
|
2266
|
<DURATION>00.00.39</DURATION>
|
|
2267
|
</CALL>
|
|
2268
|
</TERMINAL>
|
|
2269
|
</PROFILE>
|
|
2270
|
</PROFILE_LIST>
|
|
2271
|
|
|
2272
|
|
|
2273
|
|
|
2274
|
2 Codes retour du diagnostic
|
|
2275
|
|
|
2276
|
|
|
2277
|
|
|
2278
|
|Code |Description |
|
|
2279
|
|000 |Appel en succès (tous médias) |
|
|
2280
|
|001 |Erreur inconnue. |
|
|
2281
|
|002 |Erreur du gestionnaire de diffusion |
|
|
2282
|
|006 |Appel annulé |
|
|
2283
|
|999 |Message non remis pendant la durée de validité de la |
|
|
2284
|
| |campagne |
|
|
2285
|
|Vocal |
|
|
2286
|
|100 |Numéro incorrect ou format du numéro demandé incorrect |
|
|
2287
|
|101 |Destinataire occupé |
|
|
2288
|
|102 |Pas de réponse du destinataire |
|
|
2289
|
|103 |Numéro non attribué |
|
|
2290
|
|104 |Destinataire non atteint |
|
|
2291
|
|105 |Destinataire non atteint |
|
|
2292
|
|107 |Destinataire non atteint |
|
|
2293
|
|109 |Message non lu |
|
|
2294
|
|110 |Message non lu entièrement |
|
|
2295
|
|111 |Message non acquitté |
|
|
2296
|
|112 |Message déposé sur répondeur |
|
|
2297
|
|113 |Fax détecté |
|
|
2298
|
|150 |Message non abouté |
|
|
2299
|
|190 |File d'attente opérateur pleine |
|
|
2300
|
|SMS |
|
|
2301
|
|201 |Numéro incorrect ou format du numéro demandé incorrect |
|
|
2302
|
|202 |Carte SIM pleine |
|
|
2303
|
|203 |Ce mobile ne peut pas recevoir de SMS |
|
|
2304
|
|204 |SMS non remis |
|
|
2305
|
|205 |SMS non remis |
|
|
2306
|
|206 |SMS non remis |
|
|
2307
|
|207 |SMS non remis |
|
|
2308
|
|208 |Hors zone de couverture |
|
|
2309
|
|209 |Mobile occupé ou carte SIM pleine |
|
|
2310
|
|210 |Numéro bloqué |
|
|
2311
|
|211 |Numéro de mobile non attribué |
|
|
2312
|
|212 |Erreur opérateur |
|
|
2313
|
|213 |Numéro non conforme |
|
|
2314
|
|214 |Pas d'accusé de réception opérateur |
|
|
2315
|
|215 |STOP demandé par le destinataire |
|
|
2316
|
|Fax |
|
|
2317
|
|301 |Numéro incorrect ou format du numéro demandé incorrect |
|
|
2318
|
|304 |Fax non remis |
|
|
2319
|
|305 |Fax non remis |
|
|
2320
|
|307 |Fax non remis |
|
|
2321
|
|308 |Fax non remis |
|
|
2322
|
|309 |Numéro invalide ou format incorrect |
|
|
2323
|
|310 |Réponse vocale |
|
|
2324
|
|311 |Ligne occupée |
|
|
2325
|
|312 |Pas de réponse |
|
|
2326
|
|313 |Pas de porteuse |
|
|
2327
|
|314 |Problème réseau |
|
|
2328
|
|Mail |
|
|
2329
|
|401 |Mail non remis : format de l’adresse invalide |
|
|
2330
|
|402 |Désinscription demandée par le destinataire |
|
|
2331
|
|405 |Mail non remis |
|
|
2332
|
|406 |Mail non remis |
|
|
2333
|
|407 |Mail non remis |
|
|
2334
|
|408 |Mail envoyé au serveur SMTP |
|
|
2335
|
|409 |Mail avec AR non ouvert |
|
|
2336
|
|410 |Autre statut pour l'adresse |
|
|
2337
|
|411 |Mauvaise adresse de la boite aux lettres de destination |
|
|
2338
|
|412 |Mauvaise adresse du système de destination |
|
|
2339
|
|413 |Mauvaise syntaxe dans l'adresse de la boite aux lettres |
|
|
2340
|
| |de destination |
|
|
2341
|
|414 |Adresse ambiguë pour la boite aux lettres de destination |
|
|
2342
|
|415 |Adresse de la boite aux lettres de destination valide |
|
|
2343
|
|416 |La boite aux lettres a bougé |
|
|
2344
|
|417 |Mauvaise syntaxe pour l'adresse de la boite au lettre de |
|
|
2345
|
| |l'expéditeur |
|
|
2346
|
|418 |Mauvaise adresse du système de l'expéditeur |
|
|
2347
|
|420 |Statut de boite aux lettres autre ou indéfini |
|
|
2348
|
|421 |La boite aux lettres ne fonctionne pas; elle n'accepte |
|
|
2349
|
| |pas de messages |
|
|
2350
|
|422 |Boite aux lettres pleine |
|
|
2351
|
|423 |La longueur du message dépasse la limite |
|
|
2352
|
|424 |Problème d'accroissement de la liste de diffusion |
|
|
2353
|
|430 |Statut du système email autre ou indéfini |
|
|
2354
|
|431 |Le système email est plein |
|
|
2355
|
|432 |Le système n'accepte pas de message du réseau |
|
|
2356
|
|433 |Le système n'implémente pas les fonctionnalités |
|
|
2357
|
| |sélectionnées |
|
|
2358
|
|434 |Message trop grand pour le système |
|
|
2359
|
|440 |Statut autre ou indéfini du réseau ou du routage |
|
|
2360
|
|441 |Pas de réponse du serveur |
|
|
2361
|
|442 |Mauvaise connexion |
|
|
2362
|
|443 |Echec du serveur de routage |
|
|
2363
|
|444 |Impossibilité de router |
|
|
2364
|
|445 |Réseau encombré |
|
|
2365
|
|446 |Boucle de routage détectée |
|
|
2366
|
|447 |Temps de livraison expiré |
|
|
2367
|
|450 |Statut de protocole autre ou indéfini |
|
|
2368
|
|451 |Commande invalide |
|
|
2369
|
|452 |Erreur de syntaxe |
|
|
2370
|
|453 |Trop de destinataires |
|
|
2371
|
|454 |Arguments de commande invalides |
|
|
2372
|
|455 |Mauvaise version du protocole |
|
|
2373
|
|460 |Erreur de média autre ou indéfinie |
|
|
2374
|
|461 |Média non supporté |
|
|
2375
|
|462 |Conversion demandée et interdite |
|
|
2376
|
|463 |Conversion demandée et non supportée |
|
|
2377
|
|464 |Conversion avec perte effectuée |
|
|
2378
|
|465 |La conversion n'a pas réussi |
|
|
2379
|
|470 |Statut de sécurité autre ou indéfini |
|
|
2380
|
|471 |Livraison interdite, message refusé |
|
|
2381
|
|472 |Accroissement de la liste de diffusion interdite |
|
|
2382
|
|473 |Conversion de sécurité requise mais impossible |
|
|
2383
|
|474 |Fonctionnalités de sécurité non supportées |
|
|
2384
|
|475 |Echec du cryptage |
|
|
2385
|
|476 |Algorithme de cryptage non supporté |
|
|
2386
|
|477 |Echec sur l'intégrité du message |
|
|
2387
|
|500 |Mail non remis |
|
|
2388
|
|510 |Autre statut pour l'adresse |
|
|
2389
|
|511 |Mauvaise adresse de la boite aux lettres de destination |
|
|
2390
|
|512 |Mauvaise adresse du système de destination |
|
|
2391
|
|513 |Mauvaise syntaxe dans l'adresse de la boite aux lettres |
|
|
2392
|
| |de destination |
|
|
2393
|
|514 |Adresse ambiguë pour la boite aux lettres de destination |
|
|
2394
|
|515 |Adresse de la boite aux lettres de destination valide |
|
|
2395
|
|516 |La boite aux lettres a bougé |
|
|
2396
|
|517 |Mauvaise syntaxe pour l'adresse de la boite au lettre de |
|
|
2397
|
| |l'expéditeur |
|
|
2398
|
|518 |Mauvaise adresse du système de l'expéditeur |
|
|
2399
|
|520 |Statut de boite aux lettres autre ou indéfini |
|
|
2400
|
|521 |La boite aux lettres ne fonctionne pas; elle n'accepte |
|
|
2401
|
| |pas de messages |
|
|
2402
|
|522 |Boite aux lettres pleine |
|
|
2403
|
|523 |La longueur du message dépasse la limite |
|
|
2404
|
|524 |Problème d'accroissement de la liste de diffusion |
|
|
2405
|
|530 |Statut du système email autre ou indéfini |
|
|
2406
|
|531 |Le système email est plein |
|
|
2407
|
|532 |Le système n'accepte pas de message du réseau |
|
|
2408
|
|533 |Le système n'implémente pas les fonctionnalités |
|
|
2409
|
| |sélectionnées |
|
|
2410
|
|534 |Message trop grand pour le système |
|
|
2411
|
|540 |Statut autre ou indéfini du réseau ou du routage |
|
|
2412
|
|541 |Pas de réponse du serveur |
|
|
2413
|
|542 |Mauvaise connexion |
|
|
2414
|
|543 |Echec du serveur de routage |
|
|
2415
|
|544 |Impossibilité de router |
|
|
2416
|
|545 |Réseau encombré |
|
|
2417
|
|546 |Boucle de routage détectée |
|
|
2418
|
|547 |Temps de livraison expiré |
|
|
2419
|
|550 |Statut de protocole autre ou indéfini |
|
|
2420
|
|551 |Commande invalide |
|
|
2421
|
|552 |Erreur de syntaxe |
|
|
2422
|
|553 |Trop de destinataires |
|
|
2423
|
|554 |Arguments de commande invalides |
|
|
2424
|
|555 |Mauvaise version du protocole |
|
|
2425
|
|560 |Erreur de média autre ou indéfinie |
|
|
2426
|
|561 |Média non supporté |
|
|
2427
|
|562 |Conversion demandée et interdite |
|
|
2428
|
|563 |Conversion demandée et non supportée |
|
|
2429
|
|564 |Conversion avec perte effectuée |
|
|
2430
|
|565 |La conversion n'a pas réussi |
|
|
2431
|
|570 |Statut de sécurité autre ou indéfini |
|
|
2432
|
|571 |Livraison interdite, message refusé |
|
|
2433
|
|572 |Accroissement de la liste de diffusion interdite |
|
|
2434
|
|573 |Conversion de sécurité requise mais impossible |
|
|
2435
|
|574 |Fonctionnalités de sécurité non supportées |
|
|
2436
|
|575 |Echec du cryptage |
|
|
2437
|
|576 |Algorithme de cryptage non supporté |
|
|
2438
|
|577 |Echec sur l'intégrité du message |
|
|
2439
|
4 Tableau de descripteurs de listes de destinataires (en sortie de
|
|
2440
|
WSListDescriptor)
|
|
2441
|
|
|
2442
|
Un tableau de descripteurs de listes de destinataires est une collection de
|
|
2443
|
descripteurs de listes de destinataires. Un descripteur de liste de
|
|
2444
|
destinataires est défini par les caractéristiques suivantes :
|
|
2445
|
|
|
2446
|
|Nom attribut |Type |Description |
|
|
2447
|
|listId |Chaîne |Identifiant d'un liste accessible |
|
|
2448
|
| | |par le Web Service. |
|
|
2449
|
|listName |Chaîne |Nom d'une liste accessible par le |
|
|
2450
|
| | |Web Service. |
|
|
2451
|
|listDescription |Chaîne |Description de la liste accessible|
|
|
2452
|
| | |par le Web Service. |
|
|
2453
|
|
|
2454
|
|
|
2455
|
Remarque : L'identifiant de la liste désigne une liste de manière unique
|
|
2456
|
pour un compte client donné.
|
|
2457
|
|
|
2458
|
|
|
2459
|
ANNEXES
|
|
2460
|
|
|
2461
|
|
|
2462
|
|
|
2463
|
1 Exemples flux XML
|
|
2464
|
|
|
2465
|
|
|
2466
|
|
|
2467
|
1 Exemple de flux XML pour l’appel de la méthode sendMessage
|
|
2468
|
|
|
2469
|
|
|
2470
|
Les paramètres client sont en rouge.
|
|
2471
|
|
|
2472
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
2473
|
<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'
|
|
2474
|
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
2475
|
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
|
|
2476
|
<soapenv:Header>
|
|
2477
|
<ns1:username
|
|
2478
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2479
|
soapenv:mustUnderstand='0' xmlns:ns1='ws-security'>
|
|
2480
|
login
|
|
2481
|
</ns1:username>
|
|
2482
|
<ns2:password
|
|
2483
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2484
|
soapenv:mustUnderstand='0' xmlns:ns2='ws-security'>
|
|
2485
|
mot de passe
|
|
2486
|
</ns2:password>
|
|
2487
|
</soapenv:Header>
|
|
2488
|
<soapenv:Body>
|
|
2489
|
<sendMessage
|
|
2490
|
xmlns='http://joigneur.server.webservices.contacteveryone.dps.ft.fr'>
|
|
2491
|
<wsMessage>
|
|
2492
|
<ns3:content xmlns:ns3='MultiDiffusionWS'>
|
|
2493
|
Corps du mail, fax, vocal
|
|
2494
|
</ns3:content>
|
|
2495
|
<ns4:custId xmlns:ns4='MultiDiffusionWS'>
|
|
2496
|
custId
|
|
2497
|
</ns4:custId>
|
|
2498
|
<ns5:from xmlns:ns5='MultiDiffusionWS'>
|
|
2499
|
(non utilisée)
|
|
2500
|
</ns5:from>
|
|
2501
|
<ns6:fullContenu xmlns:ns6='MultiDiffusionWS'>
|
|
2502
|
false
|
|
2503
|
</ns6:fullContenu>
|
|
2504
|
<ns7:orgName xsi:nil='true' xmlns:ns7='MultiDiffusionWS'/>
|
|
2505
|
<ns8:resumeContent xmlns:ns8='MultiDiffusionWS'>
|
|
2506
|
Corps du SMS
|
|
2507
|
</ns8:resumeContent>
|
|
2508
|
<ns9:sendProfiles xmlns:ns9='MultiDiffusionWS'>
|
|
2509
|
<?xml version="1.0" encoding="ISO-8859-
|
|
2510
|
1"?>
|
|
2511
|
<PROFILE_LIST>
|
|
2512
|
<PROFILE>
|
|
2513
|
<DEST_NAME>dupont</DEST_NAME>
|
|
2514
|
<DEST_FORENAME>jean</DEST_FORENAME>
|
|
2515
|
<DEST_ID>ID1</DEST_ID>
|
|
2516
|
<TERMINAL_GROUP>
|
|
2517
|
<TERMINAL>
|
|
2518
|
<TERMINAL_NAME>personnal_messaging</TERMINAL_NAME>
|
|
2519
|
<TERMINAL_ADDR>jean.dupont@orange-
|
|
2520
|
ftgroup.com</TERMINAL_ADDR>
|
|
2521
|
<MEDIA_TYPE_GROUP>
|
|
2522
|
<MEDIA_TYPE>mail</MEDIA_TYPE>
|
|
2523
|
</MEDIA_TYPE_GROUP>
|
|
2524
|
</TERMINAL>
|
|
2525
|
<TERMINAL>
|
|
2526
|
<TERMINAL_NAME>office</TERMINAL_NAME>
|
|
2527
|
<TERMINAL_ADDR>0123456789</TERMINAL_ADDR>
|
|
2528
|
<MEDIA_TYPE_GROUP>
|
|
2529
|
<MEDIA_TYPE>tel</MEDIA_TYPE>
|
|
2530
|
</MEDIA_TYPE_GROUP>
|
|
2531
|
</TERMINAL>
|
|
2532
|
<TERMINAL>
|
|
2533
|
<TERMINAL_NAME>personnal_mobile</TERMINAL_NAME>
|
|
2534
|
<TERMINAL_ADDR>0612354678</TERMINAL_ADDR>
|
|
2535
|
<MEDIA_TYPE_GROUP>
|
|
2536
|
<MEDIA_TYPE>sms</MEDIA_TYPE>
|
|
2537
|
</MEDIA_TYPE_GROUP>
|
|
2538
|
</TERMINAL>
|
|
2539
|
</TERMINAL_GROUP>
|
|
2540
|
</PROFILE>
|
|
2541
|
</PROFILE_LIST>
|
|
2542
|
</ns9:sendProfiles>
|
|
2543
|
<ns10:strategy xmlns:ns10='MultiDiffusionWS'>
|
|
2544
|
Strategie utilisée
|
|
2545
|
</ns10:strategy>
|
|
2546
|
<ns11:subject xmlns:ns11='MultiDiffusionWS'>
|
|
2547
|
Sujet du mail
|
|
2548
|
</ns11:subject>
|
|
2549
|
<ns12:to xmlns:ns12='MultiDiffusionWS'>
|
|
2550
|
(non utilisée)
|
|
2551
|
</ns12:to>
|
|
2552
|
</wsMessage>
|
|
2553
|
</sendMessage>
|
|
2554
|
</soapenv:Body>
|
|
2555
|
</soapenv:Envelope>
|
|
2556
|
|
|
2557
|
|
|
2558
|
2 Exemple de flux XML pour l’appel de la méthode sendAdvancedMessage
|
|
2559
|
|
|
2560
|
|
|
2561
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
2562
|
<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'
|
|
2563
|
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
2564
|
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
|
|
2565
|
<soapenv:Header>
|
|
2566
|
<ns1:username
|
|
2567
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2568
|
soapenv:mustUnderstand='0' xmlns:ns1='ws-security'>
|
|
2569
|
login
|
|
2570
|
</ns1:username>
|
|
2571
|
<ns2:password
|
|
2572
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2573
|
soapenv:mustUnderstand='0' xmlns:ns2='ws-security'>
|
|
2574
|
Mot de passe
|
|
2575
|
</ns2:password>
|
|
2576
|
</soapenv:Header>
|
|
2577
|
<soapenv:Body>
|
|
2578
|
<sendAdvancedMessage
|
|
2579
|
xmlns='http://joigneur.server.webservices.contacteveryone.dps.ft.fr'>
|
|
2580
|
<wsAdvancedMessage>
|
|
2581
|
<ns3:content xmlns:ns3='MultiDiffusionWS'>
|
|
2582
|
Corps de texte du mail, fax, vocal
|
|
2583
|
</ns3:content>
|
|
2584
|
<ns4:custId xmlns:ns4='MultiDiffusionWS'>
|
|
2585
|
custId
|
|
2586
|
</ns4:custId>
|
|
2587
|
<ns5:faxReplyTo xmlns:ns5='MultiDiffusionWS'>
|
|
2588
|
Numéro de fax
|
|
2589
|
</ns5:faxReplyTo>
|
|
2590
|
<ns6:from xmlns:ns6='MultiDiffusionWS'>
|
|
2591
|
(non utilisée)
|
|
2592
|
</ns6:from>
|
|
2593
|
<ns7:fullContenu xmlns:ns7='MultiDiffusionWS'>
|
|
2594
|
false
|
|
2595
|
</ns7:fullContenu>
|
|
2596
|
<ns8:mailReplyTo xmlns:ns8='MultiDiffusionWS'>
|
|
2597
|
(non utilisée)
|
|
2598
|
</ns8:mailReplyTo>
|
|
2599
|
<ns9:orgName xsi:nil='true' xmlns:ns9='MultiDiffusionWS'/>
|
|
2600
|
<ns10:resumeContent xmlns:ns10='MultiDiffusionWS'>
|
|
2601
|
Corps de texte SMS
|
|
2602
|
</ns10:resumeContent>
|
|
2603
|
<ns11:sendProfiles xmlns:ns11='MultiDiffusionWS'>
|
|
2604
|
<?xml version="1.0" encoding="ISO-8859-
|
|
2605
|
1"?>
|
|
2606
|
<PROFILE_LIST>
|
|
2607
|
<PROFILE>
|
|
2608
|
<DEST_NAME>DUPONT</DEST_NAME>
|
|
2609
|
<DEST_FORENAME>Jean</DEST_FORENAME>
|
|
2610
|
<DEST_ID>id_2</DEST_ID>
|
|
2611
|
<TERMINAL_GROUP>
|
|
2612
|
<TERMINAL>
|
|
2613
|
<TERMINAL_NAME>mobile1</TERMINAL_NAME>
|
|
2614
|
<TERMINAL_ADDR>0607153514</TERMINAL_ADDR>
|
|
2615
|
<MEDIA_TYPE_GROUP>
|
|
2616
|
<MEDIA_TYPE>sms</MEDIA_TYPE>
|
|
2617
|
</MEDIA_TYPE_GROUP>
|
|
2618
|
</TERMINAL>
|
|
2619
|
</TERMINAL_GROUP>
|
|
2620
|
</PROFILE>
|
|
2621
|
</PROFILE_LIST>
|
|
2622
|
</ns11:sendProfiles>
|
|
2623
|
<ns12:smsReplyTo xmlns:ns12='MultiDiffusionWS'>
|
|
2624
|
Numéro de téléphone de retour pour SMS
|
|
2625
|
</ns12:smsReplyTo>
|
|
2626
|
<ns13:startCall xmlns:ns13='MultiDiffusionWS'>
|
|
2627
|
2007-01-17T17:26:14.060Z (date de début de filtre)
|
|
2628
|
</ns13:startCall>
|
|
2629
|
<ns14:strategy xmlns:ns14='MultiDiffusionWS'>
|
|
2630
|
strategie
|
|
2631
|
</ns14:strategy>
|
|
2632
|
<ns15:subject xmlns:ns15='MultiDiffusionWS'>
|
|
2633
|
Sujet du mail
|
|
2634
|
</ns15:subject>
|
|
2635
|
<ns16:telReplyTo xmlns:ns16='MultiDiffusionWS'>
|
|
2636
|
Numéro de téléphone pour retour vocal
|
|
2637
|
</ns16:telReplyTo>
|
|
2638
|
<ns17:to xmlns:ns17='MultiDiffusionWS'>
|
|
2639
|
(non utilisée)
|
|
2640
|
</ns17:to>
|
|
2641
|
<ns18:validFaxReplyTo xmlns:ns18='MultiDiffusionWS'>
|
|
2642
|
false
|
|
2643
|
</ns18:validFaxReplyTo>
|
|
2644
|
<ns19:validFormatMailReplyTo xmlns:ns19='MultiDiffusionWS'>
|
|
2645
|
false
|
|
2646
|
</ns19:validFormatMailReplyTo>
|
|
2647
|
<ns20:validMaxStartCall xmlns:ns20='MultiDiffusionWS'>
|
|
2648
|
false
|
|
2649
|
</ns20:validMaxStartCall>
|
|
2650
|
<ns21:validMinStartCall xmlns:ns21='MultiDiffusionWS'>
|
|
2651
|
false
|
|
2652
|
</ns21:validMinStartCall>
|
|
2653
|
<ns22:validSmsReplyTo xmlns:ns22='MultiDiffusionWS'>
|
|
2654
|
false
|
|
2655
|
</ns22:validSmsReplyTo>
|
|
2656
|
<ns23:validTelReplyTo xmlns:ns23='MultiDiffusionWS'>
|
|
2657
|
false
|
|
2658
|
</ns23:validTelReplyTo>
|
|
2659
|
<ns24:validityPeriod xsi:nil='true' xmlns:ns24='MultiDiffusionWS'/>
|
|
2660
|
</wsAdvancedMessage>
|
|
2661
|
</sendAdvancedMessage>
|
|
2662
|
</soapenv:Body>
|
|
2663
|
</soapenv:Envelope>
|
|
2664
|
|
|
2665
|
3 Exemple de flux XML pour l’appel de la méthode listResults
|
|
2666
|
|
|
2667
|
|
|
2668
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
2669
|
<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'
|
|
2670
|
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
2671
|
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
|
|
2672
|
<soapenv:Header>
|
|
2673
|
<ns1:username
|
|
2674
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2675
|
soapenv:mustUnderstand='0' xmlns:ns1='ws-security'>
|
|
2676
|
login
|
|
2677
|
</ns1:username>
|
|
2678
|
<ns2:password
|
|
2679
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2680
|
soapenv:mustUnderstand='0' xmlns:ns2='ws-security'>
|
|
2681
|
mot de passe
|
|
2682
|
</ns2:password>
|
|
2683
|
</soapenv:Header>
|
|
2684
|
<soapenv:Body>
|
|
2685
|
<listResults
|
|
2686
|
xmlns='http://joigneur.server.webservices.contacteveryone.dps.ft.fr'>
|
|
2687
|
<wsFilter>
|
|
2688
|
<ns3:custId xmlns:ns3='MultiDiffusionWS'>
|
|
2689
|
custId
|
|
2690
|
</ns3:custId>
|
|
2691
|
<ns4:dateBegin xsi:nil='true' xmlns:ns4='MultiDiffusionWS'/>
|
|
2692
|
<ns5:dateEnd xsi:nil='true' xmlns:ns5='MultiDiffusionWS'/>
|
|
2693
|
<ns6:from xsi:nil='true' xmlns:ns6='MultiDiffusionWS'/>
|
|
2694
|
<ns7:msgIds xmlns:ns7='MultiDiffusionWS'>
|
|
2695
|
Id du message1
|
|
2696
|
</ns7:msgIds>
|
|
2697
|
<ns8:msgIds xmlns:ns8='MultiDiffusionWS'>
|
|
2698
|
Id du message2
|
|
2699
|
</ns8:msgIds>
|
|
2700
|
<ns9:status xsi:nil='true' xmlns:ns9='MultiDiffusionWS'/>
|
|
2701
|
<ns10:to xsi:nil='true' xmlns:ns10='MultiDiffusionWS'/>
|
|
2702
|
</wsFilter>
|
|
2703
|
</listResults>
|
|
2704
|
</soapenv:Body>
|
|
2705
|
</soapenv:Envelope>
|
|
2706
|
|
|
2707
|
|
|
2708
|
4 Exemple de flux XML pour l’appel de la méthode stopMessage
|
|
2709
|
|
|
2710
|
|
|
2711
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
2712
|
<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'
|
|
2713
|
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
|
|
2714
|
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
|
|
2715
|
<soapenv:Header>
|
|
2716
|
<ns1:username
|
|
2717
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2718
|
soapenv:mustUnderstand='0' xmlns:ns1='ws-security'>
|
|
2719
|
login
|
|
2720
|
</ns1:username>
|
|
2721
|
<ns2:password
|
|
2722
|
soapenv:actor='http://schemas.xmlsoap.org/soap/actor/next'
|
|
2723
|
soapenv:mustUnderstand='0' xmlns:ns2='ws-security'>
|
|
2724
|
mot de passe
|
|
2725
|
</ns2:password>
|
|
2726
|
</soapenv:Header>
|
|
2727
|
<soapenv:Body>
|
|
2728
|
<stopMessage
|
|
2729
|
xmlns='http://joigneur.server.webservices.contacteveryone.dps.ft.fr'>
|
|
2730
|
<custId>
|
|
2731
|
custId
|
|
2732
|
</custId>
|
|
2733
|
<idMessage>
|
|
2734
|
id du message
|
|
2735
|
</idMessage>
|
|
2736
|
</stopMessage>
|
|
2737
|
</soapenv:Body>
|
|
2738
|
</soapenv:Envelope>
|
|
2739
|
|
|
2740
|
|
|
2741
|
|
|
2742
|
5 Appel de la méthode createDispatcher
|
|
2743
|
|
|
2744
|
|
|
2745
|
Les paramètres client sont en rouge.
|
|
2746
|
|
|
2747
|
|
|
2748
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
|
2749
|
xmlns:prov="Provisioning">
|
|
2750
|
<soapenv:Header>
|
|
2751
|
<ns1:username
|
|
2752
|
soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
|
|
2753
|
soapenv:mustUnderstand="0" xmlns:ns1="ws-security">compteclient@orange-
|
|
2754
|
ftgroup.com</ns1:username>
|
|
2755
|
<ns2:password
|
|
2756
|
soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
|
|
2757
|
soapenv:mustUnderstand="0" xmlns:ns2="ws-security">monmdp</ns2:password>
|
|
2758
|
</soapenv:Header>
|
|
2759
|
<soapenv:Body>
|
|
2760
|
<prov:createDispatcher>
|
|
2761
|
<prov:custId>NOM DU COMPTE</prov:custId>
|
|
2762
|
<prov:BeanDispatcher>
|
|
2763
|
<prov:login>MartinDupont</prov:login>
|
|
2764
|
<prov:firstname>Martin</prov:firstname>
|
|
2765
|
<prov:lastname>Dupond</prov:lastname>
|
|
2766
|
<prov:adresss>6 rue du Recteur</prov:adresss>
|
|
2767
|
<prov:zipCode>14000</prov:zipCode>
|
|
2768
|
<prov:city>Caen</prov:city>
|
|
2769
|
<prov:codeCountry>france</prov:codeCountry>
|
|
2770
|
<prov:language>fr</prov:language>
|
|
2771
|
<prov:mobile1>0637252525</prov:mobile1>
|
|
2772
|
<prov:fax>0237252525</prov:fax>
|
|
2773
|
<prov:mail> MartinDupont@orange.fr</prov:mail>
|
|
2774
|
<prov:status>0</prov:status>
|
|
2775
|
<prov:thresholdSms>10</prov:thresholdSms>
|
|
2776
|
<prov:thresholdFax>100</prov:thresholdFax>
|
|
2777
|
<prov:thresholdMail>234</prov:thresholdMail>
|
|
2778
|
<prov:thresholdMms>-1</prov:thresholdMms>
|
|
2779
|
<prov:thresholdVocal>200</prov:thresholdVocal>
|
|
2780
|
<prov:smsThresholdType>true</prov:smsThresholdType>
|
|
2781
|
</prov:BeanDispatcher>
|
|
2782
|
</prov:createDispatcher>
|
|
2783
|
</soapenv:Body>
|
|
2784
|
</soapenv:Envelope>
|
|
2785
|
|
|
2786
|
|
|
2787
|
6 Retour suite à l’Appel de la méthode createDispatcher :
|
|
2788
|
|
|
2789
|
|
|
2790
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
|
2791
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
2792
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
2793
|
<soapenv:Body>
|
|
2794
|
<createDispatcherResponse xmlns="Provisioning">
|
|
2795
|
<createDispatcherReturn>
|
|
2796
|
<login>MartinDupont</login>
|
|
2797
|
<password>spz?8N</password>
|
|
2798
|
</createDispatcherReturn>
|
|
2799
|
</createDispatcherResponse>
|
|
2800
|
</soapenv:Body>
|
|
2801
|
</soapenv:Envelope>
|
|
2802
|
|
|
2803
|
|
|
2804
|
7 Retour suite à l’Appel de la méthode createDispatcher en cas d’erreur :
|
|
2805
|
|
|
2806
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
|
2807
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
2808
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
2809
|
<soapenv:Body>
|
|
2810
|
<soapenv:Fault>
|
|
2811
|
<faultcode>soapenv:Server.generalException</faultcode>
|
|
2812
|
<faultstring>1002</faultstring>
|
|
2813
|
<faultactor>API Web Service Contact Everyone</faultactor>
|
|
2814
|
<detail>
|
|
2815
|
<ERROR>
|
|
2816
|
<code>1002</code>
|
|
2817
|
<message>Un utilisateur avec le login "MartinDupont" existe
|
|
2818
|
déjà.</message>
|
|
2819
|
<module>Web Service Provisioning</module>
|
|
2820
|
</ERROR>
|
|
2821
|
<ns1:exceptionName
|
|
2822
|
xmlns:ns1="http://xml.apache.org/axis/">fr.ft.dps.contacteveryone.webservice
|
|
2823
|
s.server.provisioning.exception.ProvisioningException</ns1:exceptionName>
|
|
2824
|
<ns2:hostname
|
|
2825
|
xmlns:ns2="http://xml.apache.org/axis/">ID401459</ns2:hostname>
|
|
2826
|
</detail>
|
|
2827
|
</soapenv:Fault>
|
|
2828
|
</soapenv:Body>
|
|
2829
|
</soapenv:Envelope>
|
|
2830
|
|
|
2831
|
|
|
2832
|
8 Appel de la méthode removeDispatcher :
|
|
2833
|
|
|
2834
|
|
|
2835
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
|
2836
|
xmlns:prov="ProvisioningWS">
|
|
2837
|
<soapenv:Header>
|
|
2838
|
<ns1:username
|
|
2839
|
soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
|
|
2840
|
soapenv:mustUnderstand="0" xmlns:ns1="ws-security">compteclient@orange-
|
|
2841
|
ftgroup.com</ns1:username>
|
|
2842
|
<ns2:password
|
|
2843
|
soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
|
|
2844
|
soapenv:mustUnderstand="0" xmlns:ns2="ws-security">monmdp</ns2:password>
|
|
2845
|
</soapenv:Header>
|
|
2846
|
<soapenv:Body>
|
|
2847
|
<prov:removeDispatcher>
|
|
2848
|
<prov:custId>NOM DU COMPTE</prov:custId>
|
|
2849
|
<prov:login>MartinDupont</prov:login>
|
|
2850
|
</prov:removeDispatcher>
|
|
2851
|
</soapenv:Body>
|
|
2852
|
</soapenv:Envelope>
|
|
2853
|
|
|
2854
|
|
|
2855
|
|
|
2856
|
|
|
2857
|
|
|
2858
|
10 Retour suite a l’appel de la méthode removeDispatcher
|
|
2859
|
|
|
2860
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
|
2861
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
2862
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
2863
|
<soapenv:Body>
|
|
2864
|
<removeDispatcherResponse xmlns="ProvisioningWS"/>
|
|
2865
|
</soapenv:Body>
|
|
2866
|
</soapenv:Envelope>
|
|
2867
|
|
|
2868
|
|
|
2869
|
2 Personnalisation des messages
|
|
2870
|
|
|
2871
|
|
|
2872
|
|
|
2873
|
1 Variables prédéfinies
|
|
2874
|
|
|
2875
|
|
|
2876
|
Il est possible de personnaliser vos messages à partir des données
|
|
2877
|
envoyées par l’intermédiaire du sendProfiles. Ainsi, il est possible
|
|
2878
|
d’utiliser les variables suivantes :
|
|
2879
|
|
|
2880
|
- Nom du destinataire renseigné entre les balises <DEST_NAME> et
|
|
2881
|
</DEST_NAME>
|
|
2882
|
- Prénom du destinataire renseigné entre les balises <DEST_FORENAME> et
|
|
2883
|
</DEST_FORENAME>
|
|
2884
|
- Adresse du terminal du destinataire renseignée entre les balises
|
|
2885
|
<TERMINAL_ADDR> et
|
|
2886
|
</TERMINAL_ADDR >
|
|
2887
|
|
|
2888
|
Elles pourront être affichées/appelées dans le contenu du message à partir
|
|
2889
|
des variables suivantes (respectivement) :
|
|
2890
|
|
|
2891
|
- <notilus_dest:DEST_NAME/>
|
|
2892
|
- <notilus_dest:DEST_FORENAME/>
|
|
2893
|
- <notilus_dest:TERMINAL_ADDR/>
|
|
2894
|
|
|
2895
|
Remarque : Les balises doivent être fermantes.
|
|
2896
|
|
|
2897
|
|
|
2898
|
|
|
2899
|
2 Personnalisation des variables
|
|
2900
|
|
|
2901
|
|
|
2902
|
Il est aussi possible de créer des champs personnels.
|
|
2903
|
|
|
2904
|
Pour cela dans le sendProfiles, au même nœud que <DEST_NAME>,
|
|
2905
|
<DEST_FORENAME> ou <DEST_ID>, il suffit d'insérer les balises suivantes :
|
|
2906
|
|
|
2907
|
<PERSONALIZATION_LIST>
|
|
2908
|
<PERSONALIZATION>
|
|
2909
|
<NAME>Nom du champ</NAME>
|
|
2910
|
<VALUE>Valeur associée au champ</VALUE>
|
|
2911
|
</PERSONALIZATION>
|
|
2912
|
</PERSONALIZATION_LIST>
|
|
2913
|
|
|
2914
|
Ensuite, dans le corps de texte du message, il suffit de rappeler vos
|
|
2915
|
variables comme ceci : <notilus_perso:EXPEDITEUR/>. (ATTENTION : La balise
|
|
2916
|
doit être fermante!)
|
|
2917
|
|
|
2918
|
Remarques :
|
|
2919
|
La valeur du champ doit être au maximum de 256 caractères.
|
|
2920
|
Le nom du champ de personnalisation ne doit pas dépasser 30 caractères ni
|
|
2921
|
contenir de caractères accentués ou spéciaux.
|
|
2922
|
|
|
2923
|
Voici ci-dessous un exemple de sendProfile :
|
|
2924
|
|
|
2925
|
<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
|
|
2926
|
<PROFILE_LIST>
|
|
2927
|
<PROFILE>
|
|
2928
|
<DEST_NAME>DUPONT</DEST_NAME>
|
|
2929
|
<DEST_FORENAME>Antoine</DEST_FORENAME>
|
|
2930
|
<DEST_ID>id_1</DEST_ID>
|
|
2931
|
<PERSONALIZATION_LIST>
|
|
2932
|
<PERSONALIZATION>
|
|
2933
|
<NAME>EXPEDITEUR</NAME>
|
|
2934
|
<VALUE>Jean DUBOIS</VALUE>
|
|
2935
|
</PERSONALIZATION>
|
|
2936
|
</PERSONALIZATION_LIST>
|
|
2937
|
<TERMINAL_GROUP>
|
|
2938
|
<TERMINAL>
|
|
2939
|
<TERMINAL_NAME>personnal_fax</TERMINAL_NAME>
|
|
2940
|
<TERMINAL_ADDR>0231000000</TERMINAL_ADDR>
|
|
2941
|
<MEDIA_TYPE_GROUP>
|
|
2942
|
<MEDIA_TYPE>fax</MEDIA_TYPE>
|
|
2943
|
</MEDIA_TYPE_GROUP>
|
|
2944
|
</TERMINAL>
|
|
2945
|
</TERMINAL_GROUP>
|
|
2946
|
</PROFILE>
|
|
2947
|
</PROFILE_LIST>
|
|
2948
|
|
|
2949
|
|
|
2950
|
-----------------------
|
|
2951
|
[1] Les différentes informations disponibles sur le diagnostic d'un appel
|
|
2952
|
dépendent fortement du terminal et donc du diffuseur utilisé lors de cet
|
|
2953
|
appel. Il n'y a pas de formalisme établi pour ce type d'information.
|
|
2954
|
|
|
2955
|
-----------------------
|
|
2956
|
Serveur de médiation
|
|
2957
|
|
|
2958
|
|
|
2959
|
|
|
2960
|
Web Service
|
|
2961
|
Contact Everyone
|
|
2962
|
|
|
2963
|
Applicatif client 1
|
|
2964
|
|
|
2965
|
Applicatif client 2
|
|
2966
|
|
|
2967
|
Code retour
|
|
2968
|
|
|
2969
|
Temps d’aboutement
|
|
2970
|
|
|
2971
|
Touches saisies : *,1 ,2 et 3
|
|
2972
|
|
|
2973
|
Durée totale de l’appel
|
|
2974
|
|
|
2975
|
|
|
2976
|
-----------------------
|
|
2977
|
Page 58 sur 58
|
|
2978
|
|
|
2979
|
|