FAX送信サービス サービスリファレンス
FaxQuery
■概要
"Verb"で指定された送信トランザクションの詳細情報を取得します。
■記述形式
下記ページより、テストおよび記述形式を確認できます。
http://ws.interfax.net/dfs.asmx?op=FaxQuery
■入力
| パラメータ | データ型 | 内容 |
|---|---|---|
| Username | String | ご登録のユーザID |
| Password | String | ご登録のパスワード |
| Verb | String | PARENT <transactionid> ： 複数宛先へ同時送信時のPARENT TransactionID。 ACTIVE： 全ての処理中のデータを取得する場合は、次の"VerbData"は未入力。 GT <transactionid> ： 指定されたTransactionIDより、IDの大きいトランザクション （greater than） GE <transactionid> ： 指定されたTransactionIDと同じまたは、IDの大きいトランザクション （greater than or equal to） LT <transactionid> ： 指定されたTransactionIDより、IDの小さいトランザクション （less than） LE <transactionid> ： 指定されたTransactionIDと同じまたは、IDの小さいトランザクション （less than or equal to） EQ <transactionid> ： 指定されたTransactionIDのトランザクション BETWEEN <transactionid1,transactionid2> ： TransactionID1以上、TransactionID2以下 IN <transactionid1,transactionid2> ： 指定されたTransactionID1、2等。 * <transactionid>は、次の"VerbData"で指定します。 |
| VerbData | String | <transactionid> "Verb"の参照となるトランザクションIDを入力。 |
| MaxItems | Integer | FaxItemエレメントで返す最大数。"-1"は、無制限。但し、最大値は、システムの制限をご参照ください。 |
■出力: FaxQueryResult
| パラメータ | データ型 | 内容 | |
|---|---|---|---|
| ResultCode | Interger | このクエリ要求が成功した場合は、"0"が戻ります。 失敗時には、負の数値が戻ります。（FAX送信の結果ではなく、クエリ自体の結果です）戻り値の詳細は、Webサービス戻り値をご参照ください。 |
|
| FaxItems | Array | FaxItemExの配列 | |
| ParentTransactionID | Integer | リスト送信時のID（1件目のTransactionID） | |
| TransactionID | Integer | ||
| SubmitTime | DateTime | トランザクションが最初に送信された日時 | |
| PostponeTime | DateTime | 送信開始日時が指定された場合の日時 （指定の無い場合は、"0000-00-00"が返ります。） |
|
| CompletionTime | DateTime | トランザクションの終了日時 | |
| UserID | String | ||
| Contact | String | FAX送信時に指定したContact | |
| JobID | String | 現在使用不可です | |
| DestinationFax | String | 送信先FAX番号（FAX番号およびデータフォーマットの標準フォーマット） | |
| ReplyEmail | String | 通知メールが送られるメールアドレス。 未指定時は、アカウント管理Webのプロパティ "通知メールデフォルト送信先" が有効となります。 | |
| RemoteCSID | String | FAXを受信したFAX機のCSID | |
| PagesSent | Short | 送信成功したページ数 | |
| Status | Integer | トランザクションのステータス （ステータス/エラーコード（FAX結果）をご参照ください。） |
|
| Duration | Integer | 送信時間（秒） | |
| Subject | String | 送信時に指定されたSubject（件名） | |
| PagesSubmitted | Short | InterFAXへ送信要求したドキュメントのページ数 | |
| SenderCSID | String | 送信者のCSID | |
| Priority | Short | FAX送信時、システムが割り当てた優先順位 | |
| Units | Decimal | 送信ページ数（ページあたり60秒を超えた場合は、超過分を含みます。） 例： 1ページ送信で、送信時間が65秒の場合は、1.1。 |
|
| CostPerUnit | Decimal | ページ単価 | |
| PageSize | String | 用紙サイズ A4/B4/Letter/Legal | |
| PageOrientation | String | 用紙方向 Portrait/Landscape | |
| PageResolution | String | 解像度 Standard（標準）/Fine（ファイン） | |
| RenderingQuality | String | 品質 Standard（白黒）/Fine（ハーフトーン） | |
| PageHeader | String | 指定されたヘッダ | |
| RetriesToPerform | Short | 指定されたリトライ回数 | |
| TrialsPerformed | Short | 実際におこなわれたリトライ回数 | |
