開発者

GET/v3/getpriceinfo/{visible_uuid}

保存済みの番号価格プランを読み取る

アカウント固有の保存済み価格を取得し、注文前に古い結果、空の結果、あいまいな結果に対処します。

このページの内容
  1. 保存済みの価格プランを読み取る
  2. リクエスト
  3. レスポンス
  4. 価格フィールド
  5. 複数の一致行を処理する
  6. 空のレスポンスとエラー
  7. 効果と制限

保存済みの価格プランを読み取る

利用可能な電話番号を閲覧した後、お使いの API アカウント用に保存された価格行を検索します。使用するのは価格オプションの uuid です。これは選択した番号の price リストから取得し、番号そのもの、プレフィックス ID、エリア ID は使用しないでください。選択した番号と価格オプションは一緒に保持してください。

これは保存済み価格の互換性ルックアップです。可用性や価格を更新したり、番号を予約したり、注文したり、将来の購入金額を保証したりすることはありません。注文前に、新しい番号検索で返された価格オプションを確認してください。

リクエスト

許可された IP アドレスから HTTPS 経由で、有効化された API アカウントを使用してください。PRICE_ID には、受け取った正確な価格オプション ID を設定してください。このメソッドはパス引数を一つだけ読み取り、ボディ、日付、ページネーションのパラメーターは読み取りません。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getpriceinfo/$PRICE_ID"

価格オプションを取得したのと同じアカウントがこのルックアップを行う必要があります。ID を自作したり、データベースの行番号を使用したり、別のアカウントの選択内容で代用したりしないでください。このレガシーメソッドは可視の価格 ID のみを照合します。

レスポンス

次の架空の例は、選択した顧客向けフィールドのみを示しています。実際のレスポンスは完全な保存済み行を返し、追加のアカウント、サプライヤー、内部価格のメタデータを含むことがあります。完全なレスポンスはサーバー側に保持し、アプリケーションが必要とする顧客向けの値のみを公開してください。

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "visible_uuid": "PRICE_FROM_SEARCH",
      "setup_price": "2.00",
      "monthly_price": "4.50",
      "per_minute": "0.0100",
      "free_minutes": "100",
      "channels": "2"
    }
  ]
}

response は、行が一つであってもリストです。status.results は返された行数を示します。データベースの数値は文字列である場合があります。このエンドポイントは通貨フィールドを追加したり通貨を変換したりしません。この例から推測するのではなく、アカウントの請求通貨を確認してください。

価格フィールド

選択した価格プランのフィールド
フィールド意味
visible_uuid保存済み価格オプションの可視識別子。ルックアップを突き合わせる際は、元のオプション ID を使用してください。
setup_priceこのオプションの保存された一回限りの初期設定価格。
monthly_price保存された月額の定期価格。
per_minute, free_minutes保存された着信通話の分単価と、含まれる分数。発信通話や、あり得るすべての追加料金の見積もりではありません。
channelsこのオプションの保存されたチャネル数。リアルタイムの容量確認や登録確認ではありません。
yearly_price追加の保存済み年額価格フィールドが存在する場合があります。月額価格がゼロ以外で年額フィールドがゼロであっても、無料の年間プランを表すと推測しないでください。

複数の一致行を処理する

ルックアップは複数の保存済み行を返すことがあります。このメソッドは、順序の保証、最新行の選択、番号/プレフィックスによるフィルターを提供しません。最初または最後の行を黙って選択しないでください。返されたコンテキストを、最初に選択した番号と価格オプションと比較してください。あいまいなまま、または古いままの場合は、このレスポンスを注文見積もりとして扱うのではなく、番号検索をやり直してください。

ポータルの注文確認ワークフローは、追加の選択チェックと有効性チェックを実行します。このレガシールックアップがそれらのチェックを実装している、またはポータルが受け付けるすべての識別子を受け付けると想定しないでください。

空のレスポンスとエラー

一致する保存済み行がない場合、現在のハンドラーは JSON 結果を出力せず、明示的な not-found レスポンスも返しません。空のボディは、価格ゼロ、利用可能なプラン、または成功が確認されたルックアップを意味しません。HTTP レスポンスと JSON 構造の両方を確認し、欠落している価格データや解析できない価格データから注文しないでください。

認証、送信元 IP の制限、データベース障害によっても、使用可能なレスポンスが得られないことがあります。データベース例外に対するハンドラー固有のエラーエンベロープはありません。認証済みのルックアップが引き続き利用できない場合は、選択をやり直すか、サポートにお問い合わせください。

効果と制限

レビュー済みのルックアップは読み取りクエリを実行するもので、引き落とし、購入、予約、プロバイダー価格の更新は含みません。保存済み価格を読み取っても、現在の在庫、規制上の承認、アカウントの購入権限、最終的な請求が確定するわけではありません。