-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathMonopondSOAPClient PHP Docu.txt
896 lines (702 loc) · 25.7 KB
/
MonopondSOAPClient PHP 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
Building A Request
To use Monopond SOAP PHP Client, start by including the MonopondSOAPClient.php (line 2) then creating an instance of the client by supplying your credentials (line 5). Your username and password should be enclosed in quotation marks.
1. <?php
2. include_once './MonopondSOAPClient.php';
3.
4. // TODO: Enter your own credentials here
5. $client = new MonopondSOAPClientV2_1("myusername", "mypassword", MPENV::Production);
6.
7. // TODO: Set up your request here
8. ?>
SendFax 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. // TODO: Put your file path here
2. $filedata = fread(fopen("./test.txt", "r"), filesize("./test.txt"));
3. $filedata = base64_encode($filedata);
4.
5. // TODO: Setup Document
6. $document = new MonopondDocument();
7. $document->FileName = "AnyFileName1.txt";
8. $document->FileData = $filedata;
9. $document->Order = 0;
10.
11. // TODO: Setup FaxMessage
12. $faxMessage = new MonopondFaxMessage();
13. $faxMessage->MessageRef = "Testing-message-1";
14. $faxMessage->SendTo = "61011111111";
15. $faxMessage->SendFrom = "Test Fax";
16. $faxMessage->Documents = array($document);
17. $faxMessage->Resolution = "normal";
18. $faxMessage->Retries = 0;
19. $faxMessage->BusyRetries = 2;
20.
21. // TODO: Setup FaxSendRequest
22. $sendFaxRequest = new MonopondSendFaxRequest();
23. $sendFaxRequest->BroadcastRef = "Broadcast-test-1";
24. $sendFaxRequest->SendRef = "Send-Ref-1";
25. $sendFaxRequest->FaxMessages[] = $faxMessage;
26. 27. // Call send fax method
28. $sendRespone = $client->sendFax($sendFaxRequest);
29. print_r($sendRespone);
________________
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. // TODO: Put your file path here
2. $filedata = fread(fopen("./test.txt", "r"), filesize("./test.txt"));
3. $filedata = base64_encode($filedata);
4.
5. // TODO: Setup Document
6. $document = new MonopondDocument();
7. $document->FileName = "AnyFileName1.txt";
8. $document->FileData = $filedata;
9. $document->Order = 0;
10. 11. $document2 = new MonopondDocument();
12. $document2->FileName = "AnyFileName2.txt";
13. $document2->FileData = $filedata;
14. $document2->Order = 0;
15.
16. $document3 = new MonopondDocument();
17. $document3->FileName = "AnyFileName3.txt";
18. $document3->FileData = $filedata;
19. $document3->Order = 0;
20.
21. // TODO: Setup FaxMessage
22. $faxMessage = new MonopondFaxMessage();
23. $faxMessage->MessageRef = "Testing-message-1";
24. $faxMessage->SendTo = "61011111111";
25. $faxMessage->SendFrom = "Test Fax";
26. $faxMessage->Documents = array($document);
27. $faxMessage->Resolution = "normal";
28. $faxMessage->Retries = 0;
29. $faxMessage->BusyRetries = 2;
30. 31. $faxMessage2 = new MonopondFaxMessage();
32. $faxMessage2->MessageRef = "Testing-message-2";
33. $faxMessage2->SendTo = "61011111111";
34. $faxMessage2->SendFrom = "Test Fax 2";
35. $faxMessage2->Documents = array($document2, $document3);
36. $faxMessage2->Resolution = "normal";
37. $faxMessage2->Retries = 0;
38. $faxMessage2->BusyRetries = 3;
39. 40. // TODO: Setup FaxSendRequest
41. $sendFaxRequest = new MonopondSendFaxRequest();
42. $sendFaxRequest->BroadcastRef = "Broadcast-test-1";
43. $sendFaxRequest->SendRef = "Send-Ref-1";
44. $sendFaxRequest->FaxMessages[] = $faxMessage;
45. $sendFaxRequest->FaxMessages[] = $faxMessage2;
46.
1. // Call send fax method
2. $sendRespone = $client->sendFax($sendFaxRequest);
3. print_r($sendRespone);
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. // TODO: Put your file path here
2. $filedata = fread(fopen("./test.txt", "r"), filesize("./test.txt"));
3. $filedata = base64_encode($filedata);
4.
5. // TODO: Setup Document
6. $document = new MonopondDocument();
7. $document->FileName = "AnyFileName1.txt";
8. $document->FileData = $filedata;
9. $document->Order = 0;
10.
11. // TODO: Setup FaxMessage
12. $faxMessage = new MonopondFaxMessage();
13. $faxMessage->MessageRef = "Testing-message-1";
14. $faxMessage->SendTo = "61011111111";
15. 16. $faxMessage2 = new MonopondFaxMessage();
17. $faxMessage2->MessageRef = "Testing-message-2";
18. $faxMessage2->SendTo = "61011111111";
19. 20. // TODO: Setup FaxSendRequest
21. $sendFaxRequest = new MonopondSendFaxRequest();
22. $sendFaxRequest->BroadcastRef = "Broadcast-test-1";
23. $sendFaxRequest->SendRef = "Send-Ref-1";
24. $sendFaxRequest->FaxMessages[] = $faxMessage;
25. $sendFaxRequest->FaxMessages[] = $faxMessage2;
26. $sendFaxRequest->Documents = array($document);
27. $sendFaxRequest->SendFrom = "Test Fax";
28. 29. // Call send fax method
30. $sendRespone = $client->sendFax($sendFaxRequest);
31. print_r($sendRespone);
________________
SendFaxRequest Parameters:
Name
Required
Type
Description
Default
BroadcastRef
String
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.
SendRef
String
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.
FaxMessages
x
Array of FaxMessage
FaxMessages describe each individual fax message and its destination. See below for details.
SendFrom
Alphanumeric String
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.
Fax
Documents
x
Array of FaxDocument
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. See below for details.
Resolution
Resolution
Resolution quality of the fax document. This option may incur additional costs. Please contact your account manager for more information. See below for a list of possible values.
normal
ScheduledStartTime
DateTime
The date and time the transmission of the fax will start.
Current time (immediate sending)
Retries
Unsigned Integer
The 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.
Account default
BusyRetries
Unsigned Integer
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.
Account default
HeaderFormat
String
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.
From: X, To: X
FaxMessage Parameters:
This represents a single fax message being sent to a destination.
Name
Required
Type
Description
Default
MessageRef
x
String
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.
SendTo
x
String
The phone number the fax message will be sent to.
SendFrom
Alphanumeric String
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.
Empty
Documents
x
Array of FaxDocument
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. See below for details.
Resolution
Resolution
Resolution quality of the fax document. This option may incur additional costs. Please contact your account manager for more information. See below for a list of possible values.
normal
ScheduledStartTime
DateTime
The date and time the transmission of the fax will start.
Current time (immediate sending)
Retries
Unsigned Integer
The 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.
Account default
BusyRetries
Unsigned Integer
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.
Account default
HeaderFormat
String
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.
From: X, To: X
FaxDocument Parameters:
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.
Name
Required
Type
Description
Default
FileName
x
String
The document filename including extension. This is important as it is used to help identify the document MIME type.
FileData
x
Base64
The document encoded in Base64 format.
Order
Integer
If multiple documents are defined on a message, this value will determine the order in which they will be transmitted.
0
Resolution Levels:
Value
Description
normal
Normal standard resolution (98 scan lines per inch)
fine
Fine resolution (196 scan lines per inch)
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
SendFax Response:
The response received from a SendFaxRequest matches the response you receive when calling the FaxStatus method call with a “send” verbosity level.
________________
FaxStatus Request
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 Parameters:
Name
Required
Type
Description
Default
BroadcastRef
String
User-defined broadcast reference
SendRef
String
User-defined send reference
MessageRef
String
User-defined message reference
Verbosity
String
The level of detail in the status response. Please see below for a list of possible values.
brief
Verbosity Levels:
Value
Description
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).
send
Includes the results from “brief” while also including an itemised list of each fax message in the request
details
Includes the results from “send” along with details of the parameters used to send the fax messages
results
Includes the results from “send” along with the sending results of the fax messages
all
Includes the results from both “details” and “results” along with some extra uncommon fields
________________
Status Request with “brief” verbosity:
1. // TODO: Setup FaxStatusRequest
2. $faxStatusRequest = new MonopondFaxStatusRequest();
3. $faxStatusRequest->MessageRef = "Testing-message-1";
4. 1. // Call fax status method
2. $faxStatus = $client->faxStatus($faxStatusRequest);
3. print_r($faxStatus);
Status Request with “send” verbosity:
1. // TODO: Setup FaxStatusRequest
2. $faxStatusRequest = new MonopondFaxStatusRequest();
3. $faxStatusRequest->BroadcastRef = "Broadcast-test-1";
4. $faxStatusRequest->Verbosity = "send";
5. 1. // Call fax status method
2. $faxStatus = $client->faxStatus($faxStatusRequest);
3. print_r($faxStatus);
Status Request with “details” verbosity:
1. // TODO: Setup FaxStatusRequest
2. $faxStatusRequest = new MonopondFaxStatusRequest();
3. $faxStatusRequest->SendRef = "Send-Ref-1";
4. $faxStatusRequest->Verbosity = "details";
5. 1. // Call fax status method
2. $faxStatus = $client->faxStatus($faxStatusRequest);
3. print_r($faxStatus);
Status Request with “results” verbosity:
1. // TODO: Setup FaxStatusRequest
2. $faxStatusRequest = new MonopondFaxStatusRequest();
3. $faxStatusRequest->BroadcastRef = "Broadcast-test-1";
4. $faxStatusRequest->SendRef = "Send-Ref-1";
5. $faxStatusRequest->Verbosity = "results";
6. 1. // Call fax status method
2. $faxStatus = $client->faxStatus($faxStatusRequest);
3. print_r($faxStatus);
4.
________________
FaxStatus Response:
The response received depends entirely on the verbosity level specified.
Name
Type
Verbosity
Description
FaxStatusTotals
FaxStatusTotals
brief
Counts of how many faxes are at each status. See below for more details.
FaxResultsTotals
FaxResultsTotals
brief
Totals of the end results of the faxes. See below for more details.
FaxMessages
Array of FaxMessage
send
List of each fax in the query. See below for more details.
FaxStatusTotals:
Contains the total count of how many faxes are at each status.
Name
Type
Verbosity
Description
pending
Long
brief
Fax is pending on the system and waiting to be processed.
processing
Long
brief
Fax is in the initial processing stages.
queued
Long
brief
Fax has finished processing and is queued, ready to send out at the send time.
starting
Long
brief
Fax is ready to be sent out.
sending
Long
brief
Fax has been spooled to our servers and is in the process of being sent out.
pausing
Long
brief
Fax has been told to pause.
paused
Long
brief
Fax is currently paused.
resuming
Long
brief
Fax has been told to resume. After the resume has been confirmed, it is set back to the “sending” status.
stopping
Long
brief
Fax has been told to stop. After the stop has been confirmed, it is set to the “finalizing” status.
finalizing
Long
brief
Fax has finished sending and the results are being processed.
done
Long
brief
Fax has completed and no further actions will take place. The detailed results are available at this status.
________________
FaxResultsTotals:
Contains the total count of how many faxes ended in each result, as well as some additional totals.
Name
Type
Verbosity
Description
success
Long
brief
Fax has successfully been delivered to its destination.
blocked
Long
brief
Destination number was found in one of the blocklists
failed
Long
brief
Fax failed getting to its destination.
totalAttempts
Long
brief
Total attempts made in the reference context
totalFaxDuration
Long
brief
Total time spent on the line in the reference context
totalPages
Long
brief
Total pages sent in the reference context
FaxMessages:
The response received depends entirely on the verbosity level specified.
Name
Type
Verbosity
Description
messageRef
String
send
sendRef
String
send
broadcastRef
String
send
sendTo
String
send
status
send
The current status of the fax message. See the FaxStatus table above for possible status values.
FaxDetails
FaxDetails
details
Contains the details and settings the fax was sent with. See below for more details.
FaxResults
Array of FaxResult
results
Contains the results of each attempt at sending the fax message and their connection details. See below for more details.
FaxDetails:
Name
Type
Verbosity
Description
sendFrom
Alphanumeric String
details
resolution
String
details
retries
Integer
details
busyRetries
Integer
details
headerFormat
String
details
FaxResults:
Name
Type
Verbosity
Description
attempt
Integer
results
The attempt number of the FaxResult
result
String
results
The result of the fax message. See the FaxResults table above for possible values
Error
FaxError
results
The fax error code if the fax was not successful. See below for all possible values
cost
BigDecimal
results
The final cost of the fax message
pages
Integer
results
Total pages sent to the end fax machine.
scheduledStartTime
DateTime
results
The date and time the fax is scheduled to start.
dateCallStarted
DateTime
results
Date and time the fax started transmitting
dateCallEnded
DateTime
results
Date and time the fax finished transmitting
FaxError:
Value
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
________________
StopFax Request
Stops a fax message from sending. This fax message must either be paused, queued, starting or sending. Please note that fax cannot be stopped if the fax is currently in the process of being transmitted to the destination device.
When making a stop 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.
StopFaxRequest Parameters:
Name
Required
Type
Description
Default
BroadcastRef
String
User-defined broadcast reference
SendRef
String
User-defined send reference
MessageRef
String
User-defined message reference
StopFax Request limiting by BroadcastRef:
1. // TODO: Setup StopFaxRequest
2. $stopFaxRequest = new MonopondStopFaxRequest();
3. $stopFaxRequest->BroadcastRef = "Broadcast-test-1";
4. 5. $stopFax = $client->stopFax($stopFaxRequest);
6. print_r($stopFax);
StopFax Request limiting by SendRef:
1. // TODO: Setup StopFaxRequest
2. $stopFaxRequest = new MonopondStopFaxRequest();
3. $stopFaxRequest->SendRef = "Send-Ref-1";
4. 5. $stopFax = $client->stopFax($stopFaxRequest);
6. print_r($stopFax);
StopFax Request limiting by MessageRef:
1. // TODO: Setup StopFaxRequest
2. $stopFaxRequest = new MonopondStopFaxRequest();
3. $stopFaxRequest->MessageRef = "Testing-message-1";
4. 5. $stopFax = $client->stopFax($stopFaxRequest);
6. print_r($stopFax);
StopFax Response:
The response received from a StopFaxRequest matches the response you receive when calling the FaxStatus method call with a “send” verbosity level.
PauseFax Request
Pauses a fax message before it starts transmitting. This fax message must either be queued, starting or sending. Please note that fax cannot be paused if the message is currently being transmitted to the destination device.
When making a pause 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.
PauseFaxRequest Parameters:
Name
Required
Type
Description
Default
BroadcastRef
String
User-defined broadcast reference
SendRef
String
User-defined send reference
MessageRef
String
User-defined message reference
PauseFax Request limiting by BroadcastRef:
1. // TODO: Setup PauseFaxRequest
2. $pauseFaxRequest = new MonopondPauseFaxRequest();
3. $pauseFaxRequest->BroadcastRef = "Broadcast-test-1";
4. 5. $pauseFax = $client->pauseFax($pauseFaxRequest);
6. print_r($pauseFax);
PauseFax Request limiting by SendRef:
1. // TODO: Setup PauseFaxRequest
2. $pauseFaxRequest = new MonopondPauseFaxRequest();
3. $pauseFaxRequest->SendRef = "Send-Ref-1";
4. 5. $pauseFax = $client->pauseFax($pauseFaxRequest);
6. print_r($pauseFax);
PauseFax Request limiting by MessageRef:
1. // TODO: Setup PauseFaxRequest
2. $pauseFaxRequest = new MonopondPauseFaxRequest();
3. $pauseFaxRequest->MessageRef = "Testing-message-1";
4. 5. $pauseFax = $client->pauseFax($pauseFaxRequest);
6. print_r($pauseFax);
PauseFax Response:
The response received from a PauseFaxRequest matches the response you receive when calling the FaxStatus method call with a “send” verbosity level.
ResumeFax Request
Resumes a paused fax message. This fax message must be in the paused status.
When making a resume 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.
ResumeFaxRequest Parameters:
Name
Required
Type
Description
Default
BroadcastRef
String
User-defined broadcast reference
SendRef
String
User-defined send reference
MessageRef
String
User-defined message reference
ResumeFax Request limiting by BroadcastRef:
1. // TODO: Setup ResumeFaxRequest
2. $resumeFaxRequest = new MonopondResumeFaxRequest();
3. $resumeFaxRequest->BroadcastRef = "Broadcast-test-1";
4. 5. $resumeFax = $client->resumeFax($resumeFaxRequest);
6. print_r($resumeFax);
ResumeFax Request limiting by SendRef:
1. // TODO: Setup ResumeFaxRequest
2. $resumeFaxRequest = new MonopondResumeFaxRequest();
3. $resumeFaxRequest->SendRef = "Send-Ref-1";
4. 5. $resumeFax = $client->resumeFax($resumeFaxRequest);
6. print_r($resumeFax);
ResumeFax Request limiting by MessageRef:
1. // TODO: Setup ResumeFaxRequest
2. $resumeFaxRequest = new MonopondResumeFaxRequest();
3. $resumeFaxRequest->MessageRef = "Testing-message-1";
4. 5. $resumeFax = $client->resumeFax($resumeFaxRequest);
6. print_r($resumeFax);
ResumeFax Response:
The response received from a ResumeFaxRequest matches the response you receive when calling the FaxStatus method call with a “send” verbosity level.