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

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

SendfaxEx_2

概要

豊富な機能が盛り込まれたFAX送信メソッドです。 FAX送信の詳細な制御をおこなえます。

記述形式

下記ページより、テストおよび記述形式を確認できます。HTTP GET/POSTは、現在サポートしておりません。
http://ws.interfax.net/dfs.asmx?op=SendfaxEx_2

入力

ここで指定される個数は、送信されるファイル数と一致する必要があります。(同じファイル形式の場合も同様です)
InterFAXで対応するファイル形式をご指定ください。

パラメータ データ型 内容
Username String ご登録のユーザID
Password String ご登録のパスワード
FaxNumber String 宛先FAX番号(国際表記法)
1件の宛先もしくは、セミコロンで区切られた複数のFAX番号
例: 03-6368-4300;001-212-3456789;0044821111111
FAX番号およびデータフォーマットを参照下さい)

設定できる最大FAX番号数は、システムの制限を参照して下さい。
複数の宛先を設定した場合、宛先毎に、連続したトランザクションIDが発行されますが、それらのIDは、1つの親トランザクションID(Parent TransactionID)の管理下となります。(親トランザクションIDは、1番目のトランザクションIDとなります。)

また、FaxNumberにアカウント管理Webで設定されたリストを使用することもできます。この場合、FAX番号の代わりに、「list=リスト名」と記述します。(複数のリストおよびリストとFAX番号の混在はできません)
例: list=mylist1
Contacts String  送信先の担当者名。複数の場合はセミコロンで区切ります。
この内容は、次の履歴で参照できます:
(1)送信履歴の「担当者」フィールド
(2)送信FAXヘッダの「To」フィールド
通常、人名や会社名を指定します。

複数のFaxNumberを指定した場合、Contactsも同じ順で指定します。

リストを使用して送信した場合は、「担当者名」が挿入されますが、「担当者名」にデータが無い場合は、「会社名」となります。
FilesData base64Binary ドキュメントのバイナリデータ
複数のドキュメントがアップロードされた場合、連結したバイナリデータになります。このパラメータの総長は、FileSizes パラメータに列挙した全ファイルサイズの合計です。

アップロードされたファイルサイズが250KB以上、または、タイムアウトになるようなら、「チャンク(分割)アップロード」を使用して下さい。

チャンクアップロードでアップロードされたファイルを参照(FileSizesパラメータのSessionIDを使用)する場合は、このパラメータには、NULLを指定してください。

開発環境によっては、自動的に指定したファイルをbase64でエンコードいたします。
FileTypes String 送信するファイル形式のリスト。複数の場合はセミコロンで区切ります。ここで指定される個数は、送信されるファイル数と一致する必要があります。(同じファイル形式の場合も同様です)

例: DOC/XLS/HTML/PDF/TXT
InterFAXで対応するファイル形式をご指定ください。(TXTの場合は、アカウント管理Webのプロパティで設定されたデフォルト文字コードが適用されます。)
FileSizes String 送信するドキュメントの長さです。複数の場合はセミコロンで区切ります。

例: 12034;8888;18478

チャンクアップロードで事前にアップロードされたファイルの場合、
/sessionID=[session ID]を付与します。
SessionIDは、StartFileUpload の要求で取得できます。
例: 12034;8888;18478/sessionID=123456
Postpone DateTime スケジュール送信の日時。スケジュールせず、即時に送信する場合は、過去の日時を入力します。
例: '2000-01-01'
RetriesToPerform  Integer FAX送信が失敗した場合のリトライ回数。(1~10)リトライの間隔時間は、アカウントのデフォルトになります。
CSID String 送信者のCSID(半角英数字のみで最大20文字)
未指定の場合は、アカウントのデフォルト値が採用されます。
PageHeader String ページ上部に挿入されるFAXヘッダー文字。
固定のテキストまたは動的に挿入される変数を指定できます。

例: To: {To} From: {From} Pages: {TotalPages}
変数 {To}、{From}、{Pages} には、各々の動的要素が挿入されます。
上記例の結果:
To: 株式会社ドゥイット From: ABC Company Pages: 3

デフォルトのヘッダを設定される場合は、アカウント管理Webの[プロパティ]-> [FAX送信] -> [ヘッダプロパティ]のヘッダエディタをご利用ください。

デフォルトで定義したヘッダで常時FAX送信する場合は、"Y"、もしくは、nullを指定します。 ヘッダ不要の場合は、 "N"を指定します。

※ ヘッダ設定の詳細は「ヘッダプロパティ(FAXヘッダの印字)」をご参照ください。
JobID String 現在使用不可です
Subject String 参照用として使用する"Subject"(件名)、半角60文字(全角30文字)以内。 このパラメータは、アカウント管理Webの送信履歴で表示され、ステータスのクエリで入手できますが、送信FAXには表示されません。

'」(シングルクォテーション)、「"」(ダブルクォテーション)、「CRおよびLF」(改行コード)、「,」(カンマ)は、使用しないでください。
ReplyAddress String 通知メールの送付先メールアドレス(1つ以上)。複数指定の場合は、各アドレスを";"(セミコロン)で区切ります。指定可能な最大文字数は半角で128文字です。

未指定時(NULL)は、アカウント管理Webのプロパティ "通知メールデフォルト送信先" が有効となります。
PageSize String 用紙サイズを指定します。A4/B4/Letter/Legal

未入力時は、アカウント管理Webのプロパティ "用紙サイズ" が有効となります。

-fitを追加すると、拡大/縮小で指定ページサイズに自動縮小(または拡大)します。

例: A4-fit
PageOrientation String Portrait/Landscape
未入力時は、アカウント管理Webのプロパティ内の "用紙方向" が有効となります。
IsHighResolution Boolean True => ファインモード、 False => 標準モード。
ファインは、より鮮明にFAX送信されますが、送信時間の増加となり、送信料金が割高になる場合があります。
IsFineRendering Boolean True => ハーフトーン、 False => 白黒。
白黒のテキストの場合は、 "False" 、グレースケールやイメージの場合は、"True" を推奨します。

注意事項

A4とB4サイズのファイル等、異なるサイズの原稿を一括送信することはできません。
パラメータ PageSizeで、"-fit"を使用した場合、出力されるFAXイメージのクオリティがやや低下いたしますので、ご了承ください。また、用紙サイズ等の情報を保持するMS-Office(doc/docx/xls/xlsx/ppt/pptx/snp)、PDFファイルを送信される場合、"-fit"は無効となり、ファイル内で設定された用紙サイズでFAX送信されます。これらのファイルの送信時には、"-fit"は指定しないようお願いいたします。
PDFやMS-Office等用紙サイズを保持するファイルを送信される場合は、パラメータ PageSizeおよびPageOrientationの設定よりも送信ファイルの設定が優先されます。PageSizeおよびPageOrientationは、そのファイル内容と同一に設定してください。
MS-OfficeやPDF等で用紙サイズをB4に設定する場合は、必ず「JIS-B4」サイズを指定してください。「ISO-B4」では、サイズが異なりますので、正しくB4で出力されない場合がございます。
送信するファイルのサイズと、アカウント管理Webの[プロパティ]->[FAX送信]の「FAXモード[初期値]」での「用紙サイズ」が一致するよう設定してください。
テキストファイルを送信される場合、アカウント管理Webの[プロパティ]-[FAX送信]ページ内にある「FAXモード[初期値]」の「デフォルト文字コード」でそのテキストファイルの文字コードを選択しておく必要があります。テキストファイルと同じ文字コードが選択されていない場合、文字化けが発生いたします。
複数ページを送信中にエラーとなり、RetriesToPerformで設定されたリトライ中は、送信成功したページ以降からリトライされます。
パラメータ ReplyAddressに複数アドレスを指定する際、最大文字数128以降の文字列は無視されますので、ご注意ください。

出力

パラメータ データ型 内容
SendfaxEx_2Result Long 要求が成功した場合は、TransactionIDが戻ります。
失敗時には、負の数値が戻ります。戻り値の詳細は、Webサービス戻り値をご参照ください。