FAX送信サービス サービスリファレンス
チャンク(分割)アップロード
■概要
容量の大きいファイルをInterFAX Webサービスにアップロードする方法です。この方法を用いることで、タイムアウトを起こすことなく、大容量ドキュメントのアップロードを可能にします。
個々のファイルサイズが、250KB以上の場合に、ご使用を推奨します。また、個々のファイルサイズが、3MB以上の場合には、必ずご使用下さい。
以下のメソッドで、1つまたは複数のファイルをアップロードし、FAX送信の要求ができます。 データを小分け(分割)してアップロードさせることで、一度のアップロードで制限されているファイルサイズやタイムアウトの発生を避けることができます。
アップロードが完了次第、取得したSessionIDを用いてFAX送信要求ができます。
一般的な使用方法として、先ずStartFileUploadメソッドを使用し、次に、UploadFileChunkメソッドを繰り返し使用して、それぞれデータブロックをアップロードします。
データのアップロードが完了すると、SendfaxEx_2で、FAX送信をおこないますが、パラメータとしてデータを供給する代わりに、既にチャンクでアップロードされたデータを参照させます。
複数ファイルの場合も1つのSessionIDでアップロードしてください。
■メソッド・リファレンス
■StartFileUpload
アップロードセッションを開始するメソッドです。先にコールします。
パラメータ | データ型 | 内容 |
---|---|---|
Username | String | ご登録のユーザID |
Password | String | ご登録のパスワード |
■出力
パラメータ | データ型 | 内容 |
---|---|---|
SessionID | String | セションIDは、その後のFAX送信要求に使用するInterFAXによって返される固有のIDです。 |
StartFileUploadResult | Integer | リクエストが成功した場合は、"0"が戻ります。失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。 |
■UploadFileChunk
InterFAXホストへバッファを送信します。バッファ・サイズは、コール毎に変更できます。
パラメータ | データ型 | 内容 |
---|---|---|
SessionID | String | StartFileUploadで取得したID |
Chunk | base64Binary | チャンクされたファイル。最大3MBで、推奨チャンクサイズは、50,000 - 200,000バイトです。また、ファイルサイズの最大値(チャンクの合計)は、20MBです。 |
IsLast | Boolean | 最後のチャンクかの真偽 |
■出力
パラメータ | データ型 | 内容 |
---|---|---|
UploadFileChunkResult | Integer | 正数であればアップロードが成功またはアップロード中です。 また、アップロードしたバイト数を表します。 -150 = システムエラー -1061 = チャンクが見つからない -1062 = セションID が正しくない -1063 = 総ファイルサイズが大きすぎる |
■CancelFileUpload
既に開始されたセッションのキャンセルをおこないます。セッションの最後にこのメソッドの使用は不要です。
パラメータ | データ型 | 内容 |
---|---|---|
SessionID | String | キャンセルするアップロード中のSessionID |
