Fax.Plus APIは、チームメンバーがチームの階層構造内であなたより下位の位置にある場合、そのメンバーの情報や受信したfaxファイルをシームレスに収集するための強力なソリューションを提供します。
注: 初回の認証プロセスが完了し、APIへのログインが正常に行われていることを確認してください。詳細な手順については、こちらのガイドをご参照ください。
続行する前に、対象のチームメンバーがチームの階層構造においてAPIユーザーより下位の位置にあることを確認してください。以下のスクリーンショットに示されているように、テスト管理者のアカウントはAPIにシームレスに接続でき、それによってテストメンバーの重要な情報とfaxファイルへのアクセスが可能になります。
法人メンバー全員のリストを取得するには、次のURLに対してHTTP GETリクエストを送信します: https://restapi.fax.plus/v3/accounts/。
リクエストには以下のヘッダーを必ず含めてください:
-
- Content-Type:
multipart/form-data - Authorization:
Bearer [access token] - x-fax-clientid:
[client ID]
- Content-Type:
取得したデータに含まれるUID(ユーザーID)などのメンバーの詳細情報にアクセスできます。
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox。
リクエストには以下のヘッダーを必ず含めてください:
-
- Authorization:
Bearer [access token]
- Authorization:
-
- x-fax-clientid:
[client ID]
- x-fax-clientid:
fax IDはレスポンスから取得できます。
注: 「fax_received」イベント専用のwebhookを設定することをご検討ください。これにより、イベントのfax IDだけでなく、さらに詳しい情報も得られます。詳細については、追加情報をご覧ください。詳しくは、こちらのガイドをご参照ください。
faxからファイルを取得するには、次のURLにアクセスしてHTTP GETリクエストを送信します:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf。
リクエストには以下のヘッダーを必ず含めてください:
-
- Authorization:
Bearer [access token] - x-fax-clientid:
[client ID]
- Authorization: