システム開発(InterFAX Webサービス)

FAX送信サービス サービスリファレンス

CancelFax

概要

このメソッドでは、処理中の送信トランザクションをキャンセルできます。但し、送信中のトランザクションはキャンセルできません。キャンセル可能なものは、ステータスが、-1(前処理中)、-2(準備完了)および-3(再送信待機中のみで、送信中は不可。)のみです。

記述形式

下記ページより、テストおよび記述形式を確認できます。HTTP GET/POSTは、現在サポートしておりません。
http://ws.interfax.net/dfs.asmx?op=CancelFax

入力

パラメータ データ型 内容
Username String ご登録のユーザID
Password String ご登録のパスワード
TransactionID Integer キャンセルするFAXのTransactionID

出力

パラメータ データ型 内容
CancelFaxResult Long キャンセル要求が成功した場合は、"0"が戻ります。(次の注意事項をご参照ください。)
失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。

注意事項

トランザクションのステータスが"-3"の送信中の場合、CancelFaxResultが"0"で戻りましても、送信先と既にFAX通信が確立され、その後も通信に問題が無い場合は、送信中のFAXがそのまま送信成功となる場合がございます。従いまして、本メソッドを使用した後は、FaxStatus等でトランザクションのステータスを確認されることをお勧めいたします。

キャンセルが成功した場合は、トランザクションのステータスは"403"となります。