-
Notifications
You must be signed in to change notification settings - Fork 0
/
MonopondSOAPClient Java Docu.txt
1357 lines (1042 loc) · 42.3 KB
/
MonopondSOAPClient Java Docu.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Building A Request
To use Monopond SOAP Java Client, start by importing ApiServiceStub.java (line 2).
1. import net.utbox.client.ApiServiceStub;
2. import net.utbox.client.ApiServiceStub.*;
3. import org.apache.axiom.om.OMAbstractFactory; //for displaying response
ApiServiceStub
net.utbox.client.ApiServiceStub.ApiServiceStub
An auto-generated class from Monopond WSDL by the Apache Axis2 version 1.6.2
Constructor Summary
ApiServiceStub()
Initializes a newly created ApiService object
Method Summary
net.utbox.client.ApiServiceStub.SendFaxResponseE
.sendFax(String username, String password, net.utbox.client.ApiServiceStub.SendFaxRequestE sendFaxRequest)
sends fax/es on the platform
net.utbox.client.ApiServiceStub.FaxStatusResponseE
.faxStatus(String username, String password, net.utbox.client.ApiServiceStub.FaxStatusRequestE faxStatusRequest)
retrieves the status, details, and results of fax messages sent
net.utbox.client.ApiServiceStub.StopResponseE
.stopFax(String username, String password, net.utbox.client.ApiServiceStub.StopFaxRequestE stopFaxRequest)
stops a fax message from sending
net.utbox.client.ApiServiceStub.PauseResponseE
.pauseFax(String username, String password, net.utbox.client.ApiServiceStub.PauseFaxRequestE pauseFaxRequest)
pauses a fax message before it starts transmitting
net.utbox.client.ApiServiceStub.ResumeResponseE
.resumeFax(String username, String password, net.utbox.client.ApiServiceStub.ResumeFaxRequestE resumeFaxRequest)
resumes a paused fax message
________________
Sending A Fax Request
SendFax Request allows you to send fax/es on the platform.
Sending a single fax:
To send a fax to a single destination, a request similar to the following example can be used:
1. //create a new instance of ApiServiceStub
2. ApiServiceStub apiServiceStub = new ApiServiceStub();
3.
4. //create a new ApiFaxDocument
5. ApiFaxDocument apiFaxDocument = new ApiFaxDocument();
6.
7. //set the filedata (in base64 format) and filename
8. apiFaxDocument.setFileData("VGhpcyBpcyBhIGZheA==");
9. apiFaxDocument.setFileName("test.txt");
10. 11. Documents_type0 documentsType0 = new Documents_type0();
12. documentsType0.addDocument(apiFaxDocument);
13.
14. //create a new fax message
15. ApiFaxMessage apiFaxMessage = new ApiFaxMessage();
16. apiFaxMessage.setMessageRef("test-1-1-1");
17. apiFaxMessage.setSendTo("6011111111");
18. apiFaxMessage.setSendFrom("Test Fax");
19. apiFaxMessage.setResolution(FaxResolution.normal);
20. apiFaxMessage.setDocuments(documentsType0);
21.
22. //add the fax message to faxMessagesType1
23. FaxMessages_type1 faxMessagesType1 = new FaxMessages_type1();
24. faxMessagesType1.addFaxMessage(apiFaxMessage);
25.
26. //create an instance of SendFaxRequest
27. SendFaxRequest sendFaxRequest = new SendFaxRequest();
28. sendFaxRequest.setFaxMessages(faxMessagesType1);
29.
30. SendFaxRequestE sendFaxRequestE = new SendFaxRequestE();
31. sendFaxRequestE.setSendFaxRequest(sendFaxRequest);
32. 33. //call the sendFax method
34. SendFaxResponseE response = apiServiceStub.sendFax("myUsername",
35. "myPassword", sendFaxRequestE);
36. System.out.println(response.getOMElement(null,
37. OMAbstractFactory.getOMFactory()).toStringWithConsume());
38. }
________________
Sending multiple faxes:
To send faxes to multiple destinations, a request similar to the following example can be used. Please note the addition of another “FaxMessage”:
1. //create a new instance of ApiServiceStub
2. ApiServiceStub apiServiceStub = new ApiServiceStub();
3.
4. //create a new ApiFaxDocument
5. ApiFaxDocument apiFaxDocument = new ApiFaxDocument();
6.
7. //set the filedata (in base64 format) and filename
8. apiFaxDocument.setFileData("VGhpcyBpcyBhIGZheA==");
9. apiFaxDocument.setFileName("test.txt");
10. 11. Documents_type0 documentsType0 = new Documents_type0();
12. documentsType0.addDocument(apiFaxDocument);
13.
14. //create your fax messages
15. ApiFaxMessage apiFaxMessage1 = new ApiFaxMessage();
16. apiFaxMessage1.setMessageRef("test-1-1-1");
17. apiFaxMessage1.setSendTo("6011111111");
18. apiFaxMessage1.setSendFrom("Test Fax");
19. apiFaxMessage1.setResolution(FaxResolution.normal);
20. apiFaxMessage1.setDocuments(documentsType0);
21. 22. ApiFaxMessage apiFaxMessage2 = new ApiFaxMessage();
23. apiFaxMessage2.setMessageRef("test-1-1-1");
24. apiFaxMessage2.setSendTo("6011111111");
25. apiFaxMessage2.setSendFrom("Test Fax");
26. apiFaxMessage2.setResolution(FaxResolution.normal);
27. apiFaxMessage2.setDocuments(documentsType0);
28.
29. //add the two fax messages to faxMessagesType1
30. FaxMessages_type1 faxMessagesType1 = new FaxMessages_type1();
31. faxMessagesType1.addFaxMessage(apiFaxMessage1);
32. faxMessagesType1.addFaxMessage(apiFaxMessage2);
33.
34. //create an instance of SendFaxRequest
35. SendFaxRequest sendFaxRequest = new SendFaxRequest();
36. sendFaxRequest.setFaxMessages(faxMessagesType1);
37. 38. SendFaxRequestE sendFaxRequestE = new SendFaxRequestE();
39. sendFaxRequestE.setSendFaxRequest(sendFaxRequest);
40.
41. //call the sendFax method
42. SendFaxResponseE response = apiServiceStub.sendFax("myUsername",
43. "myPassword", sendFaxRequestE);
44. System.out.println(response.getOMElement(null,
45. OMAbstractFactory.getOMFactory()).toStringWithConsume());
Sending faxes to multiple destinations with the same document (broadcasting):
To send the same fax content to multiple destinations (broadcasting), a request similar to the example below can be used.
This method is recommended for broadcasting as it takes advantage of the multiple tiers in the send request. This eliminates the repeated parameters out of the individual fax message elements which are instead inherited from the parent send fax request.
1. //create a new instance of ApiServiceStub
2. ApiServiceStub apiServiceStub = new ApiServiceStub();
3.
4. //create a new ApiFaxDocument
5. ApiFaxDocument apiFaxDocument = new ApiFaxDocument();
6.
7. //set the filedata (in base64 format) and filename
8. apiFaxDocument.setFileData("VGhpcyBpcyBhIGZheA==");
9. apiFaxDocument.setFileName("test.txt");
10. 11. Documents_type1 documentsType1 = new Documents_type1();
12. documentsType1.addDocument(apiFaxDocument);
13.
14. //create your fax messages
15. ApiFaxMessage apiFaxMessage1 = new ApiFaxMessage();
16. apiFaxMessage1.setMessageRef("test-1-1-1");
17. apiFaxMessage1.setSendTo("6011111111");
18. 19. ApiFaxMessage apiFaxMessage2 = new ApiFaxMessage();
20. apiFaxMessage2.setMessageRef("test-1-1-1");
21. apiFaxMessage2.setSendTo("6011111111");
22.
23. //add the two fax messages to faxMessagesType1
24. FaxMessages_type1 faxMessagesType1 = new FaxMessages_type1();
25. faxMessagesType1.addFaxMessage(apiFaxMessage1);
26. faxMessagesType1.addFaxMessage(apiFaxMessage2);
27.
28. //create an instance of SendFaxRequest
29. SendFaxRequest sendFaxRequest = new SendFaxRequest();
30. sendFaxRequest.setFaxMessages(faxMessagesType1);
31. sendFaxRequest.setBroadcastRef("Broadcast-test-1");
32. sendFaxRequest.setSendRef("Send-Ref-1");
33. sendFaxRequest.setDocuments(documentsType1);
34. sendFaxRequest.setSendFrom("Test Fax");
35. 36. SendFaxRequestE sendFaxRequestE = new SendFaxRequestE();
37. sendFaxRequestE.setSendFaxRequest(sendFaxRequest);
38.
39. //call the sendFax method
40. SendFaxResponseE response = apiServiceStub.sendFax("username",
41. "password", sendFaxRequestE);
42. 43. System.out.println(response.getOMElement(null,
44. OMAbstractFactory.getOMFactory()).toStringWithConsume());
SendFaxRequestE (Wrapper)
net.utbox.client.ApiServiceStub.SendFaxRequestE
This class is used as a wrapper for sending a fax status request.
Constructor Summary
SendFaxRequestE()
Initializes a newly created SendFaxRequestE object
Method Summary
void
.setSendFaxRequest(net.utbox.client.ApiServiceStub.SendFaxRequest sendFaxRequest)
sets the send fax request
SendFaxRequest
net.utbox.client.ApiServiceStub.SendFaxRequest
SendFax Request allows you to send fax/es on the platform.
FaxStatusRequest should be wrapped in net.utbox.client.ApiServiceStub.SendFaxE to be used in ApiServiceStub.sendStatus()
Constructor Summary
SendFaxRequest()
Initializes a newly created SendFaxRequest object
Method Summary
void
.setBroadcastRef(String broadcastRef)
allows the user to tag all faxes in this request with a user-defined broadcast reference. These faxes can then be retrieved at a later point based on this reference
void
.setSendRef(String sendRef)
similar to the BroadcastRef, this allows the user to tag all faxes in this request with a send reference. The SendRef is used to represent all faxes in this request only, so naturally it must be unique
void
.setFaxMessages(net.utbox.client.ApiServiceStub.FaxMessages_type1 faxMessages)
faxMessages describe each individual fax message and its destination
Required
void
.setSendFrom(String sendFrom)
a customisable string used to identify the sender of the fax. Also known as the Transmitting Subscriber identification (TSID). The maximum string length is 32 characters
Default: Fax
void
.setDocuments(net.utbox.client.ApiServiceStub.Documents_type1)
each FaxDocument object describes a fax document to be sent. Multiple documents can be defined here which will be concatenated and sent in the same message
Required
void
.setResolution(net.utbox.client.ApiServiceStub.FaxResolution faxResolution)
resolution quality of the fax document. This option may incur additional costs. Please contact your account manager for more information
Default: normal
void
.setScheduledStartTime(String dateTime)
date and time the transmission of the fax will start
Default: Current time (immediate sending)
void
.setRetries(int retries)
number of times to retry sending the fax if it fails. Each account has a maximum number of retries that can be changed by consultation with your account manager
Default: Account default
void
.setBusyRetries(int busyRetries)
certain fax errors such as “NO_ANSWER” or “BUSY” are not included in the above retries limit and can be set separately. Each account has a maximum number of busy retries that can be changed by consultation with your account manager
Default: Account default
void
.setHeaderFormat(String headerFormat)
allows the header format that appears at the top of the transmitted fax to be changed. See below for an explanation of how to format this field
Default: From: X, To: X
FaxResolution
net.utbox.client.ApiServiceStub.FaxResolution
Method Summary
String
.getValue()
gets the resolution of fax message
Value
String
normal
String
fine
Levels
Description
normal
Normal standard resolution (98 scan lines per inch)
fine
Fine resolution (196 scan lines per inch)
FaxMessage_type1
net.utbox.client.ApiServiceStub.FaxMessages_type1
Constructor Summary
FaxMessages_type1()
Initializes a newly created FaxMessages_type1 object
Method Summary
void
.addFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxMessage faxMessage)
adds a single fax message
void
.setFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxMessage [] faxMessages)
adds an array of fax messages
ApiFaxMessage
net.utbox.client.ApiServiceStub.ApiFaxMessage
This represents a single fax message being sent to a destination.
Constructor Summary
ApiFaxMessage()
Initializes a newly created ApiFaxMessage object
Method Summary
void
.setMessageRef(String messageRef)
sets a unique user-provided identifier that is used to identify the fax message. This can be used at a later point to retrieve the results of the fax message
Required
void
.setSendTo(String sendTo)
sets the phone number the fax message will be sent to
Required
void
.setSendFrom(String sendFrom)
a customisable string used to identify the sender of the fax. Also known as the Transmitting Subscriber identification (TSID). The maximum string length is 32 characters
Default: Empty
void
.setDocuments(net.utbox.client.ApiServiceStub.Documents_type0)
each FaxDocument object describes a fax document to be sent. Multiple documents can be defined here which will be concatenated and sent in the same message
Required
void
.setResolution(net.utbox.client.ApiServiceStub.FaxResolution faxResolution)
resolution quality of the fax document. This option may incur additional costs. Please contact your account manager for more information
Default: normal
void
.setScheduledStartTime(String dateTime)
date and time the transmission of the fax will start
Default: Current time (immediate sending)
void
.setRetries(int retries)
number of times to retry sending the fax if it fails. Each account has a maximum number of retries that can be changed by consultation with your account manager
Default: Account default
void
.setBusyRetries(int busyRetries)
certain fax errors such as “NO_ANSWER” or “BUSY” are not included in the above retries limit and can be set separately. Each account has a maximum number of busy retries that can be changed by consultation with your account manager
Default: Account default
void
.setHeaderFormat(String headerFormat)
allows the header format that appears at the top of the transmitted fax to be changed. See below for an explanation of how to format this field
Default: From: X, To: X
Documents_type0
net.utbox.client.ApiServiceStub.Documents_type0
Constructor Summary
Documents_type0()
Initializes a newly created Documents_type0 object
Method Summary
void
.addFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxDocument faxDocument)
adds a single fax document
void
.setFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxDocument [] faxDocuments)
adds an array of fax documents
Documents_type1
net.utbox.client.ApiServiceStub.Documents_type1
Constructor Summary
Documents_type1()
Initializes a newly created Documents_type1 object
Method Summary
void
.addFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxDocument faxDocument)
adds a single fax document
void
.setFaxMessage(net.utbox.client.ApiServiceStub.ApiFaxDocument [] faxDocuments)
adds an array of fax documents
ApiFaxDocument
net.utbox.client.ApiServiceStub.ApiFaxDocuments
Represents a fax document to be sent through the system. Supported file types are: PDF, TIFF, PNG, JPG, GIF, TXT, PS, RTF, DOC, DOCS, XLS, XLSX, PPT, PPTX.
Constructor Summary
ApiFaxDocument()
Initializes a newly created ApiDocument object
Method Summary
void
.setFileName(String fileName)
sets the filename of the document including extension. This is important as it is used to help identify the document MIME type
Required
void
.setFileData(String fileData)
sets the document encoded in Base64 format
Required
void
.setOrder(int order)
sets the order of document. If multiple documents are defined on a message, this value will determine the order in which they will be transmitted
Header Format:
Determines the format of the header line that is printed on the top of the transmitted fax message. This is set to “From %from%, To %to%| %a %b %d %H:%M %Y” by default which produces the following:
From TSID, To 61022221234 Mon Aug 28 15:32 2012 1 of 1
The following variables can be used in the format string:
Value
Description
%from%
The value of the SendFrom field in the message
%to%
The value of the SendTo field in the message
%a
Weekday name (abbreviated)
%A
Weekday name
%b
Month name (abbreviated)
%B
Month name
%d
Day of the month as a decimal (01 - 31)
%m
Month as a decimal (01 - 12)
%y
Year as a decimal (abbreviated)
%Y
Year as a decimal
%H
Hour as a decimal using 24-hour clock (00 - 23)
%I
Hour as a decimal using 12-hour clock (01 - 12)
%M
Minute as a decimal (00 - 59)
%S
Second as a decimal (00 - 59)
%p
AM or PM
%j
Day of the year as a decimal (001 - 366)
%U
Week of the year as a decimal (Sunday as first day of the week) (00 - 53)
%W
Week of the year as a decimal (Monday as first day of the week) (00 - 53)
%w
Day of the week as a decimal (0 - 6) (Sunday being 0)
%%
A literal % character
________________
SendFaxResponseE (Wrapper)
net.utbox.client.ApiServiceStub.SendFaxResponseE
This class is used as a wrapper of SendFaxResponse.
Constructor Summary
SendFaxResponseE()
Initializes a newly created SendFaxResponseE object
Method Summary
void
.getOMElement(QName parentQname, OMFactory factory)
net.utbox.client.ApiServiceStub.SendFaxResponse
.getSendFaxResponse()
SendFaxResponse
net.utbox.client.ApiServiceStub.SendFaxResponse
The response received from a SendFaxRequest matches the response you receive when calling the FaxStatus method call with a “send” verbosity level.
Constructor Summary
SendFaxResponse()
Initializes a newly created SendFaxResponse object
________________
FaxStatus Request
net.utbox.client.ApiServiceStub.FaxStatusRequest
This function provides you with a method of retrieving the status, details, and results of fax messages sent. While this is a legitimate method of retrieving results, we strongly advise that you take advantage of our callback service, which will push these fax results to you as they are completed.
When making a status request, you must provide at least a BroadcastRef, SendRef, or MessageRef. The function will also accept a combination of these to further narrow the request query.
1. Limiting by a BroadcastRef allows you to retrieve faxes contained in a group of send requests
2. Limiting by SendRef allows you to retrieve faxes contained in a single send request
3. Limitting by MessageRef allows you to retrieve a single fax message
There are multiple levels of verbosity available in the request; these are explained in detail below. You can also find full examples below.
FaxStatusRequest should be wrapped in net.utbox.client.ApiServiceStub.FaxStatusRequestE to be used in ApiServiceStub.faxStatus()
Constructor Summary
FaxStatusRequest()
Initializes a newly created FaxStatusRequest object
Method Summary
void
.setBroadcastRef(String broadcastRef)
sets user-defined broadcast reference
void
.setSendRef(String sendRef)
sets user-defined send reference
void
.setMessageRef(String messageRef)
sets user-defined message reference
void
.setVerbosity(net.utbox.client.ApiServiceStub.FaxStatusLevel faxStatusLevel)
sets the level of detail in the status response. Please see below for a list of possible values.
FaxStatusLevel
net.utbox.client.ApiServiceStub.FaxStatusLevel
Verbosity Levels
FaxStatusLevel.brief
Gives you an overall view of the messages. This simply shows very high-level statistics, consisting of counts of how many faxes are at each status (i.e. processing, queued, sending) and totals of the results of these faxes (success, failed, blocked).
FaxStatusLevel.send
Includes the results from “brief” while also including an itemised list of each fax message in the request
FaxStatusLevel.details
Includes the results from “send” along with details of the parameters used to send the fax messages
FaxStatusLevel.results
Includes the results from “send” along with the sending results of the fax messages
FaxStatusLevel.all
Includes the results from both “details” and “results” along with some extra uncommon fields
FaxStatusRequestE (Wrapper)
net.utbox.client.ApiServiceStub.FaxStatusRequestE
This class is used as a wrapper for sending a fax status request.
Constructor Summary
FaxStatusRequestE()
Initializes a newly created FaxStatusRequestE object
Method Summary
void
.setFaxStatusRequest(net.utbox.client.ApiServiceStub.FaxStatusRequest faxStatusRequest)
sets the fax status request
Status Request with “brief” verbosity:
1. // Setup faxStatusRequest
2. FaxStatusRequest faxStatusRequest = new FaxStatusRequest();
3. faxStatusRequest.setBroadcastRef("test-ref");
4. faxStatusRequest.setVerbosity(FaxStatusLevel.brief);
5.
6. FaxStatusRequestE faxStatusRequestE = new FaxStatusRequestE();
7. faxStatusRequestE.setFaxStatusRequest(faxStatusRequest);
8.
9. // Call fax status method
10. SendFaxResponseE response = apiServiceStub.faxStatus("username",
11. "password", faxStatusRequestE)
Status Request with “send” verbosity:
1. // Setup faxStatusRequest
2. FaxStatusRequest faxStatusRequest = new FaxStatusRequest();
3. faxStatusRequest.setBroadcastRef("test-ref");
4. faxStatusRequest.setVerbosity(FaxStatusLevel.send);
5. 6. FaxStatusRequestE faxStatusRequestE = new FaxStatusRequestE();
7. faxStatusRequestE.setFaxStatusRequest(faxStatusRequest);
8.
9. // Call fax status method
10. SendFaxResponseE response = apiServiceStub.faxStatus("username",
11. "password", faxStatusRequestE)
Status Request with “details” verbosity:
1. // Setup faxStatusRequest
2. FaxStatusRequest faxStatusRequest = new FaxStatusRequest();
3. faxStatusRequest.setBroadcastRef("test-ref");
4. faxStatusRequest.setVerbosity(FaxStatusLevel.details);
5. 6. FaxStatusRequestE faxStatusRequestE = new FaxStatusRequestE();
7. faxStatusRequestE.setFaxStatusRequest(faxStatusRequest);
8.
9. // Call fax status method
10. SendFaxResponseE response = apiServiceStub.faxStatus("username",
11. "password", faxStatusRequestE)
Status Request with “results” verbosity:
1. // Setup faxStatusRequest
2. FaxStatusRequest faxStatusRequest = new FaxStatusRequest();
3. faxStatusRequest.setBroadcastRef("test-ref");
4. faxStatusRequest.setVerbosity(FaxStatusLevel.results);
5. 6. FaxStatusRequestE faxStatusRequestE = new FaxStatusRequestE();
7. faxStatusRequestE.setFaxStatusRequest(faxStatusRequest);
8.
9. // Call fax status method
10. SendFaxResponseE response = apiServiceStub.faxStatus("username",
11. "password", faxStatusRequestE)
FaxStatusResponseE (Wrapper)
net.utbox.client.ApiServiceStub.FaxStatusResponseE
This class is used as a wrapper of fax status response.
Constructor Summary
FaxStatusResponseE()
Initializes a newly created FaxStatusResponseE object
Method Summary
void
.getOMElement(QName parentQname, OMFactory factory)
net.utbox.client.ApiServiceStub.FaxStatusResponse
.getFaxStatusResponse()
________________
FaxStatusResponse
net.utbox.client.ApiServiceStub.FaxStatusResponse
The response received depends entirely on the verbosity level specified.
Constructor Summary
FaxStatusResponse()
Initializes a newly created FaxStatusResponse object
Method Summary
net.utbox.client.ApiServiceStub.FaxStatusTotals
.getFaxStatusTotals()
gets the counts of how many faxes are at each status
Verbosity: brief
net.utbox.client.ApiServiceStub.FaxResultsTotals
.getFaxResultsTotals()
gets the totals of the end results of the faxes
Verbosity: brief
net.utbox.client.ApiServiceStub.FaxMessages_type0
.getFaxMessages()
gets the list of each fax in the query
Verbosity: send
FaxStatusTotals
net.utbox.client.ApiServiceStub.FaxStatusTotals
Contains the total count of how many faxes are at each status.
Method Summary
long
.getPending()
gets the count of pending fax on the system and waiting to be processed
Verbosity: brief
long
.getProcessing()
gets the count of fax in the initial processing stages
Verbosity: brief
long
.getQueued()
gets the count of processed fax in queued, ready to send out at the send time
Verbosity: brief
long
.getStarting()
gets the count of fax that ready to be sent out
Verbosity: brief
long
.getSending()
gets the count of fax that has been spooled to our servers and is in the process of being sent out
Verbosity: brief
long
.getPausing()
gets the count of fax that has been told to pause
Verbosity: brief[a]
long
.getPaused()
gets the count of fax that is currently paused
Verbosity: brief
long
.getResuming()
gets the count of fax that has been told to resume. After the resume has been confirmed, it is set back to the “sending” status.
Verbosity: brief
long
.getStopping()
get the count of fax that has been told to stop. After the stop has been confirmed, it is set to the “finalizing” status.
Verbosity: brief
long
.getFinalizing()
gets the count of fax that has finished sending and the results are being processed
Verbosity: brief
long
.getDone()
gets the count of fax that has completed and no further actions will take place. The detailed results are available at this status.
Verbosity: brief
FaxResultsTotals
net.utbox.client.ApiServiceStub.FaxResultsTotals
Contains the total count of how many faxes ended in each result, as well as some additional totals.
Method Summary
long
.getSuccess()
gets the count of fax that has successfully been delivered to its destination
Verbosity: brief
long
.getBlocked()
gets the count of fax that has been blocked because the destination number was found in one of the blocklists
Verbosity: brief
long
.getFailed()
gets the count of fax that has failed getting to its destination
Verbosity: brief
long
.getTotalAttempts()
gets the total attempts made in the reference context
Verbosity: brief
long
.getTotalFaxDuration()
gets the total time spent on the line in the reference context
Verbosity: brief
long
.getTotalPages()
gets the total pages sent in the reference context
Verbosity: brief
FaxMessages_type0
net.utbox.client.ApiServiceStub.FaxMessages_type0
The response received depends entirely on the verbosity level specified.
Method Summary
net.utbox.client.ApiServiceStub.ApiFaxMessageStatus [ ]
.getFaxMessage()
gets an array of fax message statuses
Verbosity: brief
ApiFaxMessageStatus
net.utbox.client.ApiServiceStub.ApiFaxMessagesStatus
The response received depends entirely on the verbosity level specified.
Method Summary
String
.getMessageRef()
gets user-defined message reference
Verbosity: send
String
.getSendRef()
gets user-defined send reference
Verbosity: send
String
.getBroadcastRef()
gets user-defined broadcast reference
Verbosity: send
String
.getSendTo()
Verbosity: send
net.utbox.client.ApiServiceStub.FaxUserStatus
.getStatus()
gets the status of the fax message
Verbosity: send
net.utbox.client.ApiServiceStub.ApiFaxMessageStatusDetails
.getFaxDetails()
gets the details and settings the fax was sent with
Verbosity: details
net.utbox.client.ApiServiceStub.FaxResults_type0
.getFaxResults()
gets the results of each attempt at sending the fax message and their connection details
Verbosity: results
FaxUserStatus
net.utbox.client.ApiServiceStub.FaxUserStatus
Method Summary
String
.getValue()
gets the status of fax message
Value
String
pending
String
processing
String
queued
String
starting
String
sending
String
pausing
String
paused
String
resuming
String
stopping
String
finalizing
String
done
ApiFaxMessageStatusDetails
net.utbox.client.ApiServiceStub.ApiFaxMessageStatusDetails
Method Summary
String
.getSendFrom()
Verbosity: details
net.utbox.client.ApiServiceStub.FaxResolution
.getFaxResolution()
gets resolution of fax
Verbosity: details
int
.getRetries()
Verbosity: details
int
.getBusyRetries()
Verbosity: details
String
.getHeaderFormat()
Verbosity: details
FaxResolution
net.utbox.client.ApiServiceStub.FaxResolution
Method Summary
String
.getValue()
gets the resolution of fax message
Value
String
normal
String
fine
Levels
Description
normal
Normal standard resolution (98 scan lines per inch)
fine
Fine resolution (196 scan lines per inch)
FaxResults_type0
net.utbox.client.ApiServiceStub.FaxResults_type0
Method Summary
net.utbox.client.ApiServiceStub.ApiFaxMessageStatusResults [ ]
.getFaxResult()
gets fax results
ApiFaxMessageStatusResults
net.utbox.client.ApiServiceStub.ApiFaxMessageStatusResults
Method Summary
int
.getAttempt()
gets the attempt number of the FaxResult
Verbosity: results
net.utbox.client.ApiServiceStub.FaxResult
.getResult()
gets the result of fax message
Verbosity: results
net.utbox.client.ApiServiceStub.FaxErrorAdapter
.getError()
gets the error code if the fax was not successful
Verbosity: results
String
.getCost()
gets the final cost of the fax message
Verbosity: results
int
.getPages()
gets the total pages sent to the end fax machine
Verbosity: results
Calendar
.getScheduledStartTime()
gets the date and time the fax is scheduled to start
Verbosity: results
Calendar
.getDateCallStarted()
gets the date and time the fax started transmitting
Verbosity: results
Calendar
.getDateCallEnded()
gets the date and time the fax finished transmitting
Verbosity: results
FaxResult
net.utbox.client.ApiServiceStub.FaxResult
Method Summary
String
.getValue()
gets fax result value
Value
String
success
String
blocked
String
failed
________________
FaxErrorAdapter
net.utbox.client.ApiServiceStub.FaxErrorAdapter
Method Summary
String
.getCode()
gets error code
String
.getName()
gets error name
Error Code
Error Name
DOCUMENT_UNSUPPORTED
Unsupported document type
DOCUMENT_FAILED_CONVERSION
Document failed conversion
FUNDS_INSUFFICIENT
Insufficient funds
FUNDS_FAILED
Failed to transfer funds
BLOCK_ACCOUNT
Number cannot be sent from this account
BLOCK_GLOBAL
Number found in the Global blocklist
BLOCK_SMART
Number found in the Smart blocklist
BLOCK_DNCR
Number found in the DNCR blocklist
BLOCK_CUSTOM
Number found in a user specified blocklist
FAX_NEGOTIATION_FAILED
Negotiation failed
FAX_EARLY_HANGUP
Early hang-up on call
FAX_INCOMPATIBLE_MACHINE
Incompatible fax machine
FAX_BUSY
Phone number busy
FAX_NUMBER_UNOBTAINABLE
Number unobtainable
FAX_BUSY
Phone number busy
FAX_NUMBER_UNOBTAINABLE
Number unobtainable
FAX_SENDING_FAILED
Sending fax failed
FAX_CANCELLED
Cancelled
FAX_NO_ANSWER
No answer
FAX_UNKNOWN
Unknown fax error
StopFaxRequestE (Wrapper)
net.utbox.client.ApiServiceStub.StopFaxRequestE