FAX送信サービス サービスリファレンス
FaxStatus
■概要
最小限の情報 (11 項目)に限定し、素早くFAX送信の処理状況を取得できます。
■記述形式
下記ページより、テストおよび記述形式を確認できます。
http://ws.interfax.net/dfs.asmx?op=FaxStatus
■入力
| パラメータ | データ型 | 内容 |
|---|---|---|
| Username | String | ご登録のユーザID |
| Password | String | ご登録のパスワード |
| LastTransactionID | Integer | 入力したトランザクションIDより、小さい番号のトランザクションIDの情報が取得されます。 例えば、トランザクションID 111111111の情報を取得する場合は、111111111+1（"1"は、MaxItemsでも指定。）を指定します。 全てのトランザクションIDの情報を取得する場合は、Integerの最大値(2,147,483,647)を入力します。 最新のトランザクションの情報を最初に取得し、順次 "MaxItems" で指定したトランザクション数を取得します。 |
| MaxItems | Integer | 取得する最大FAXトランザクション数 |
■出力: FaxStatusResult
| パラメータ | データ型 | 内容 | |
|---|---|---|---|
| TotalCount | Integer | 指定ユーザのトランザクション総数（取得するトランザクション数ではありません。） | |
| ListSize | Integer | 取得されたトランザクション数（FaxItems配列サイズ） | |
| ResultCode | Integer | 要求が成功した場合は、"0"が戻ります。 失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。 |
|
| FaxItem | Array | FaxItemの配列 | |
| TransactionID | Integer | ||
| SubmitTime | DateTime | トランザクションが最初に送信された日時 | |
| PostponeTime | DateTime | 送信開始日時が指定された場合の日時 （指定の無い場合は、"0000-00-00"が返ります。） |
|
| CompletionTime | DateTime | トランザクションの終了日時 | |
| DestinationFax | String | 送信先FAX番号（FAX番号およびデータフォーマットの出力フォーマット） | |
| RemoteCSID | String | FAXを受信したFAX機のCSID（再大20半角文字） | |
| PagesSent | Short | 送信成功したページ数 | |
| Status | Integer | トランザクションのステータス。送信成功時は、"0"です。 （ステータス/エラーコード（FAX結果）をご参照ください。） |
|
| Duration | Integer | 送信時間（秒） | |
| Subject | String | 送信時に指定されたSubject（件名） | |
| PagesSubmitted | Short | InterFAXへ送信要求したドキュメントのページ数 | |
