faximoSilverの送信履歴取得 – MONO-X Portal

faximoSilverを利用したFAX送信の履歴を取得する方法です。
事前準備としてJSONデータを用意し、その後履歴を取得します。

事前準備

GETメソッドのパラメータに必要となるBODY（JSON）の基となるJSONファイルを作成し、任意のIFSに配置させます。

送信履歴検索の検索条件となるデータの初期値が設定されたJSONファイルを作成します。
以下にパラメータの説明とJSONデータの例を記します。

{
　　"from": "2017-12-12 13:20:15",
　　"to": "2022-06-21 13:30:15",
　　"sendto": "",
　　"userkey": [
　　　　{"key": ""}
　　],
　　"subject": ""
}

JSONファイルを作成したら、IFSに配置します。

faximoSilverの送信履歴APIを実行するための定義を作成します。
今回作成するAPIに不要な設定画面（BODY, COOKIE, QUERY, FILE(IFS), HEADER(IFS)）に関する説明は省略しています。

API-Bridge（Client）を起動した直後の画面で、登録済みの定義一覧が表示されるので、F6を押して新規作成をします。

__________2022-06-21_16.25.13.png

HEADERS1
- キー：Content-Type
- 値：application/json
HEADERS2
- キー：X-Processkey
- 値：最大20桁の任意の文字列（例. faximo-request）
HEADERS3
- キー：X-Auth
- 値：「ログインID:パスワード」をBase64エンコードしたもの
  例「user01:password01」をBase64エンコードすると「dXNlcjAxOnBhc3N3b3JkMDE=」

__________2022-06-21_16.30.39.png

BODY(JSON)：予め用意していたbase64Binary化されたpdfファイルを含むJSONファイルのIFSを入力します。
例「/home/SATOU/faximo_record.json」

{
　　"from": "2017-12-12 13:20:15",
　　"to": "2022-06-21 13:30:15",
　　"sendto": "",
　　"userkey": [
　　　　{"key": ""}
　　],
　　"subject": ""
}

JSONデータの指定したkeyの値を入れ替えて実行させる事ができ、入力されないキーはそのままの値で実行される。

1
- キー：.from
- 値：送信依頼時刻の開始範囲。（例. 2020-12-03 13:20:15）
2
- キー：.to
- 値：送信依頼時刻の終了範囲。（例. 2022-06-21 13:30:15）
3
- キー：.userkey[0].key
- 値：送信依頼で指定したユーザー指定の任意の文字列を指定。（例. testsend001）
  未入力の場合、userkeyが空文字の履歴が検索対象となる。
4
- キー：.sendto
- 値：送信先FAX番号を指定。（例. 0300001111）
  未入力の場合、全てのFAX番号が検索対象となる。
5
- キー：.subject
- 値：件名を指定を指定。（例. 送信テスト）
  未入力の場合、全ての件名が検索対象となる。

ライブラリ：APIから取得したJSONを基に作成されたファイルを保持するライブラリを入力します。
GENERAL：APIから取得したGENERALデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。
RESPONSE HEADERS：APIから取得したRESPONSE HEADERSデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。
REQUEST HEADERS：APIから取得したREQUEST HEADERSデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。

入力が完了したら「F5」で定義の実行と保存がされます。
実行結果のメッセージが表示され、定義ファイルの一覧に追加されます。
__________2022-06-21_16.34.03.png