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

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

GetList2

概要

受信FAXのリストをより柔軟に、詳細に取得するメソッドです。

記述形式

下記ページより、テストおよび記述形式を確認できます。
http://ws.interfax.net/inbound.asmx?op=GetList2

入力

パラメータ データ型 内容
Username String ご登録のユーザID
Password String ご登録のパスワード
  QueryForm  
    TransactionID Integer 0以外の数値を指定した場合、そのTransactionIDのトランザクションを取得します。(QueryFormの他の項目は無視されます。)TransactionIDが0の場合、ReceiveTimeパラメータの条件が使用されます。
    UserID String 受信FAXのリストを要求するUsername(ユーザID)
    OnlyNewMessages  Boolen  True - 「既読」以外の全メッセージ
False - 全メッセージ
  ReceiveTime  
    Verb String オプション1: 次の比較演算子が使用できます。
<, <=, >, >=, =
オプション2: BETWEEN
    VerbData String オプション1:> 有効な日付
オプション2:> ","(カンマ)で区切られた2つの日付。
上記オプションの日付フォーマットは、"YYYY-MM-DD"または"YYYY-MM-DD HH:MM:SS"です。
  QueryControl
    MaxChunkSize Integer このメソッドで取得する最大レコード数
    FromRecordsNumber Integer このメソッドで取得する最初のレコード

出力

パラメータ データ型 内容
GetList2Result Interger 要求が成功した場合は、"0"が戻ります。
失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。
MessageItems Array MessageItem2の配列(次の定義を参照)

MessageItem2の定義

パラメータ データ型 内容
UserID String
MessageID Integer Message ID
PhoneNumber String InterFAX受信番号
RemoteCSID String 送信者のCSID(20半角文字)
MessageStatus Integer FAX受信が成功した場合は、"0"が戻ります。
値の詳細は、ステータス/エラーコード(FAX結果)をご参照ください。
Pages Integer 受信ページ数
MessageSize Integer 受信FAXのサイズ(バイト)
※ この値は実際のイメージのサイズと異なりますので、GetImageChunk等では使用しないようお願いいたします。

GetImageChunkおよびGetImageChunkEx2のページもご参照ください。
MessageType Short 常に"1"
ReceiveTime DateTime FAX受信の日時
CallerID String 送信者の発信者番号(通知されている場合)
MessageRecordingDuration Integer 受信FAXの受信時間(秒)
ImageStatus String 次の値のいずれかになります。
READ/UNREAD/DONT_EXIST
NumOfEmails Integer この受信FAXが転送されたメールアドレス数
実際のアドレスは、GetInboundLogEmailsメソッドをご参照ください。
NumOfFailedEmails Integer この受信FAXが転送され、エラーとなったメールアドレス数
実際のアドレスは、GetInboundLogEmailsメソッドをご参照ください。