番号ポータビリティプロジェクトの取得

アカウントとプロジェクトへのアクセス

許可されたIPアドレスから、有効なAPIアカウントを使い、HTTPS経由でアクセスしてください。プロジェクトはそのアカウントに属し、削除されていない必要があります。データベースの数値IDや電話番号ではなく、番号移行注文のワークフローで取得したプロジェクト固有のIDを使用してください。リクエストを組み立てる際は、プロジェクトIDをURLエンコードしてください。

リクエスト

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID"

このレスポンスは機密情報として取り扱ってください

完全なレスポンスには、移行元通信事業者の請求情報として、保存されている billing_pin、請求アカウント、電話番号、住所、会社、権限を持つ連絡担当者の詳細が含まれます。APIはこれらのフィールドをマスクしません。ワークフローでステータスまたは電話番号一覧だけが必要な場合は、それだけをリクエストしてください。詳細レスポンス全体をブラウザーのストレージ、分析システム、公開ログ、サポート用のスクリーンショットに含めず、権限のある顧客が必要とするフィールドだけを表示してください。

レスポンスの構造

一部のフィールドを抜粋した架空の例です。ほかのフィールドが返される場合もあります。

{
  "status": {
    "code": 200,
    "msg": "Project Detail"
  },
  "response": {
    "project": {
      "id": 11,
      "uniqueid": "PROJECT_EXAMPLE",
      "project_name": "Example transfer",
      "location": "US",
      "status": 0,
      "status_str": "Pending"
    },
    "counts": {
      "total": 0,
      "pending": 0,
      "in_progress": 0,
      "completed": 0,
      "rejected": 0
    },
    "numbers": [],
    "events": [],
    "uploads": []
  }
}

この例では意図的に一部だけを示し、請求に関する認証情報と個人の連絡先の値をすべて省略しています。例から省略されていても、実際のレスポンスでそれらが伏せられるわけではありません。

プロジェクト詳細の各セクション
セクション	内容
project	行の数値ID、プロジェクト固有のID、プロジェクト名、所在地、保存されている請求・連絡先・住所データ、作成日時、算出されたステータスです。従来の移行元通信事業者フィールドの綴りはloosing_carrierです。
counts	電話番号の総行数と、Pending、In Progress、Completed、Rejectedそれぞれの件数です。
numbers	プロジェクトの電話番号一覧エンドポイントと同じフィールド構成の電話番号データです。顧客のコメントや保存されているスケジュールの値も含まれます。
events	保存されているイベント行と、未加工および解析済みのペイロードフィールドです。イベントエンドポイントの公開範囲と形式の制限が適用されます。
uploads	文書のメタデータです。数値ID、upload_type、file_name、file_extension、date_created、相対URLであるdownload_urlが含まれます。このURLへのアクセスにもアカウント認証が必要です。

概要とメタデータの読み取り方

算出されるステータスの優先順位は、In Progress、Pending、Completed、Rejectedの順で、いずれにも該当しない場合はPendingになります。概要がCompletedでも、却下された電話番号が含まれることがあります。すべての電話番号の移行が完了したと判断せず、件数と各電話番号のステータスを確認してください。

レスポンスに含まれるのは文書のメタデータであり、ファイル本体のバイト列ではありません。ページネーションや差分取得用のカーソルはありません。詳細と一覧のクエリは別々の読み取りであり、トランザクション上の整合性が保証された単一のスナップショットではありません。日時は保存された値のままで、タイムゾーン変換は文書化されていません。プロジェクトのルートにはuniqueidを使用してください。数値のプロジェクトIDで代用することはできません。

エラーと制限

HTTPレスポンスと、次の両フィールドを確認してください： status.code/status.msg。プロジェクトが存在しない場合、削除済みの場合、またはそのアカウントに属さない場合は、プロジェクトが見つからない旨のメッセージとともにAPIコード404が返されます。認証と送信元IPアドレスの制限も適用されます。この例は実際のリクエストを実行しません。また、レスポンスが成功しても、通信事業者が番号移行を受け付けた、または完了したことの証明にはなりません。

処理の影響とワークフロー

これは、現在のポータルの番号移行注文画面で使用されている正式な詳細取得ルートです。ポータルは画面用にフィールドを対応付け、独自に顧客向けのフィールド構成を適用します。生のAPIレスポンスが、ポータルのJSONや表示内容と同一だと考えないでください。レビュー済みの詳細取得ハンドラーは、プロジェクトを変更せず、通信事業者へのリクエストや課金を直接開始することもありません。