
「まいと~く Center API連携キット」を購入することで、APIを利用してFAXサーバーシステムを構築するコンポーネントを操作することができます。
Web API(HTTPリクエスト)機能一覧
機能 |
説明 |
FAXの送信 |
指定した送信先設定などに従い、FAXもしくはインターネットFAXジョブを送信します。 |
ジョブの取得 |
指定したジョブIDに対応したジョブ情報を取得します。 |
ジョブのキャンセル(ジョブID指定) |
指定したジョブIDに対応した、ジョブをキャンセルします。 |
送信ジョブIDの取得 |
指定された取得対象期間に該当する送信したジョブIDを取得します。 |
受信ジョブIDの取得 |
指定された取得対象期間に該当する受信したジョブIDを取得します。 |
ログIDの取得 |
指定したジョブIDに対応したログIDを取得します。 |
ログの取得 |
指定したログIDに対応したログデータを取得します。 |
ログの削除 |
指定したログIDに対応した、ログデータを削除します。 |
ジョブのキャンセル(ログID指定) |
指定したログIDに対応した、ジョブをキャンセルします。 |
ログ イメージの取得 |
指定したログIDに対応したイメージデータを取得します。 |
アドレス帳の編集 |
アドレス帳を追加 / 変更します。 |
アドレス帳データの削除 |
指定したアドレスIDに対応した、アドレスデータを削除します。 |
エラー メッセージの取得 |
指定したエラーコードに対応したメッセージ文字列を取得します。 |
API(.NET)機能一覧
メソッド一覧
名称 |
種別 |
概要 |
API連携部 |
Login |
同期 |
認証キーによりまいと~く Center APIの認証を行います。 |
Logout |
同期 |
まいと~く Center APIの処理を終了します。 |
GetLastError |
同期 |
メソッド発行で発生したエラーの詳細情報を取得します。 |
GetLineInfo |
同期 |
有効な回線情報を一括で取得します。 |
GetLineStatus |
同期 |
有効な回線情報の回線状態を一括で取得します。 |
FAX通信処理連携部 |
SendFax |
非同期 |
FAX 送信をリクエストします。 |
SendFax2 |
非同期 |
FAX送信をリクエストします。送信を行う回線番号を複数指定することができます。 |
SendFaxUser |
非同期 |
FAX送信をリクエストします。ユーザー名を指定できます。 |
ResendFax |
非同期 |
送信ログを指定して、FAXの再送信を行います。 |
ResendFaxUser |
非同期 |
送信ログを指定して、FAX の再送信を行います。ユーザー名を指定できます。 |
SendMail |
非同期 |
メール送信をリクエストします。 |
SendMailUser |
非同期 |
メール送信をリクエストします。ユーザー名を指定できます。 |
GetJobInfo |
同期 |
まいと~く Centerで処理しているジョブの詳細情報を取得します。 |
CancelJob |
同期 |
まいと~く Centerで処理しているジョブをキャンセルします(通信中の場合は、直ちに中断します)。 |
EnableReceiveFaxEvent |
同期 |
FAX受信時のイベント通知を切り替えます。 |
画像変換処理連携部 |
CheckImage |
同期 |
画像変換モジュールで扱えるデータか判別します。 |
GetImageInfo |
同期 |
指定イメージの情報を取得します。 |
CreateFaxImage |
同期 |
まいと~く Centerで送信可能な形式のTIFFファイルを作成します。 |
AddFaxPage |
同期 |
指定されたTIFFファイルに、別のTIFFファイルを新たなページとして追加します。 |
ログ管理連携部 |
GetLogInfo |
同期 |
指定ログIDのログ情報を取得します。 |
GetLogInfoUser |
同期 |
指定ログIDのログ情報を取得します。ユーザー名を指定できます。 |
GetLogID |
同期 |
ジョブIDをキーにして、ログIDを取得します。 |
GetLogIDUser |
同期 |
ジョブIDをキーにして、ログIDを取得します。ユーザー名を指定できます。 |
UpdateLog |
同期 |
指定ログIDのログ情報を更新します。 |
UpdateLogUser |
同期 |
指定ログIDのログ情報を更新します。ユーザー名を指定できます。 |
プリンタ ドライバ連携部 |
SetPrintFileName |
同期 |
プリンタ ドライバで保存するファイル名を指定します。 |
ClearPrintFileName |
同期 |
[SetPrintFileName]メソッドで指定したファイル名をクリアします。 |
GetPrintFileName |
同期 |
[SetPrintFileName]メソッドで指定した保存ファイル名を取得します。 |
SetPrinterMode |
同期 |
プリンタ ドライバの[ファイル保存方法]を切り替えます。 |
GetAutoPrintFolder |
同期 |
プリンタ ドライバの[ファイル保存方法]が、[日付+連番で自動保存]の場合の出力先フォルダ名を取得します。 |
SetAutoPrintFolder |
同期 |
プリンタ ドライバの[ファイル保存方法] が、[日付+連番で自動保存]の場合の出力先フォルダ名を指定します。 |
GetPrintResolution |
同期 |
プリンタ ドライバの解像度を取得します。 |
GetPrinterMode |
同期 |
プリンタ ドライバの[ファイル保存方法]を取得します。 |
イベント一覧
名称 |
概要 |
NotifyServerStatus |
各サーバーの状態変化を通知します。 |
NotifySendStatus |
送信状態の変化を通知します。 |
NotifyReceiveStatus |
受信状態の変化を通知します。 |
NotifyPrintStatus |
プリンタ ドライバ経由での印刷の状態変化を通知します。 |
列挙型一覧
名称 |
概要 |
APICoverType |
定型の送付状の種類 |
APIDialType |
ダイヤル方式 |
APIImageFormat |
フォーマット画像形式 |
APIPaperFitMode |
用紙フィット方法 |
APIPaperHorizontalAlign |
用紙に対する画像の水平位置 |
APIPaperVerticalAlign |
用紙に対する画像の垂直位置 |
APIJobResult |
ジョブ状態結果 |
APIJobStatus |
ジョブ状態 |
APIJobType |
ジョブ種別情報 |
APILineMode |
回線モード情報 |
APILineStatus |
回線状態 |
APILineType |
回線種別情報 |
APILogResult |
ログ操作結果 |
APIMarkMode |
符号化方式(※FlagsAttribute 属性) |
APIPaperMode |
用紙指定モード |
APIPaperPos |
ヘッダー&フッター差込用紙位置 |
APIPaperSize |
FAX原稿の用紙サイズ(※FlagsAttribute 属性) |
APIPrinterStatus |
プリンタ状態通知 |
APIResolutionMode |
解像度(※FlagsAttribute 属性) |
APIServerStatus |
サーバー状態通知 |
APIServerType |
まいと~く Center サーバー種別 |
APIPriorityLevel |
FAX送信の優先度 |
構造体一覧
名称 |
概要 |
APICoverPageInfo |
FAX送付状設定情報を格納します。 |
APIDestInfo |
相手先情報を格納します。 |
APIFooterInfo |
FAXフッター設定情報を格納します。 |
APIHeaderInfo |
FAXヘッダー設定情報を格納します。 |
APICreateImageOption |
FAX画像作成の設定情報を格納します。 |
APIJobInfo |
ジョブ情報を格納します。 |
APILineInfo |
回線情報を格納します。 |
APILogInfo |
ログ情報を格納します。 |
APIMailInfo |
メール設定情報を格納します。 |
APIPersonalInfo |
差出人設定情報を格納します。 |
APISendFaxDeviceInfo |
送信回線のFAX端末情報を格納します。 |
APISendFaxOption |
FAX送信時のオプション設定情報を格納します。 |
APISendMailOption |
メール送信時のオプション設定情報を格納します。 |
APIReceiveFaxDeviceInfo |
受信回線のFAX端末情報を格納します。 |