HTTPSと、承認済みのAPI認証情報を用いたHTTP Basic認証を使用してください。認証情報はアプリケーションサーバー上で保管してください。これらのホステッドPBXエンドポイントでは、/hpbx/ を api.multitel.net で使用します。/v3 は挿入しないでください。HTTPの結果と、JSONレスポンス内のアプリケーションレベルの処理結果ステータスの両方を確認してください。
FAX 記録の読み取り
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"課金コードをご利用のPBXのものに置き換えてください。返される記録には、FAXの時刻、方向、送信元、宛先、配信ステータス、試行回数、エラー、ページ数が含まれます。送信リクエストが受け付けられた時点では、配信が保留中の場合があります。
送信パラメーター
送信エンドポイントはPOST /hpbx/fax/send/{billing_code}です。送信は実際に実行される操作です。送信する前に、ファイルと、アカウントで許可された宛先を準備してください。結果が不確かな送信を、確認せずに再試行しないでください。
| フィールド | 意味 |
|---|---|
| number | 宛先のFAX番号。 |
| cidnum | 送信に使用する承認済みの発信者番号。 |
| schedule | 使用する場合の、予約送信の時刻。 |
| faxquality / pagesize / pagerotate | サポートされている品質、用紙サイズ、回転のオプション。 |
| statusemail | 配信通知用の承認済みアドレス。 |
| deleteaftersend | 送信後に、保存済みのアップロードファイルを削除するかどうか。 |
| filename | このファクスワークフローが想定するドキュメント参照です。任意のローカルファイルパスではありません。 |
完了状況の追跡
送信後、FAX記録のステータス、試行回数、エラーを確認してください。受付を配信と解釈せず、配信を確認してください。ポータルFAXリファレンスには現在のアップロードおよび送信ワークフローが記載されています。そのパスと認証は上記のエンドポイントとは別です。