FAX受信サービス サービスリファレンス
GetImageChunk
■概要
受信FAXのイメージを取得するメソッドです。GetListで取得した情報(MessageIDおよびMessageSize)が必要です。
■記述形式
下記ページより、テストおよび記述形式を確認できます。
http://ws.interfax.net/inbound.asmx?op=GetImageChunk
■入力
パラメータ | データ型 | 内容 |
---|---|---|
Username | String | ご登録のユーザID |
Password | String | ご登録のパスワード |
MessageID | Integer | ダウンロードする受信FAXのMessageID |
MarkAsRead | Boolean | True - 「既読」とする False - 既読としない(ステータスを変更しない) |
ChunkSize | Long | ダウンロードするバッファサイズ 指定可能な最大値は、システムの制限をご参照ください。 ※ ChunkiSizeには大きめの値(500KBや1MB等)をご指定ください。 本ページ末の「イメージの取得について」をご参照ください。 |
From | Long | バッファに書き込むイメージの開始ポイント |
■出力
パラメータ | データ型 | 内容 |
---|---|---|
GetImageChunkResult | Integer | 要求が成功した場合は、"0"が戻ります。 失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。 |
Image | base64Binary | 部分イメージのバイト配列。 指定したパラメータ(FromおよびChunkSize)に依存します。 |
- ・
- FAXイメージは、アカウント管理Webの[プロパティ] -> [FAX受信]ページの「受信FAXファイル形式」で選択されているファイル形式での取得となります。
- ・
- イメージの取得について: 入力のChunkSizeには大きめの値をご指定いただき、出力のImageの受信サイズが"0"になるまで、取得を繰り返すことで、確実にイメージファイルの取得が可能となります。
