到達可能性

携帯電話会社から直接リアルタイムの情報を提供するReachability Insightは、データ、SMS、またはその両方でネットワークに接続されているかどうかを含め、指定されたデバイスの接続ステータスをチェックするために使用することができます。

主な利点は以下の通り：

適切なコミュニケーションの送信によるユーザー体験の向上： 顧客の到達可能性を判断し、SMSまたはデータで関連するコミュニケーションを送信する。
顧客記録データベース管理 例えば、あるユーザーが過去60日間データ通信やSMSに接続していない場合など、電話番号を更新するために連絡を取る必要がある顧客を特定する。
IoTデバイスの迅速なリモート診断とモニタリング： どのデバイスがオフラインなのか、もしオフラインなら最後にオンラインになったのはいつなのかを検出し、メンテナンスが必要なデバイスに関するインテリジェンスをリモートで得ることができます。

前提条件

Identity Insights を使用するには、アカウントが正しく設定されていることを確認する必要があります。はじめにのガイドを参照されたい：

アカウントの作成
Identity Insights API で使用する Vonage アプリケーションの作成、
利用可能なさまざまな環境と、それらを使用するためのアカウントの設定方法、
また、Dashboard Getting Started UIを使用して、コードを書かずにAPIを使用する方法も紹介します。

このガイドでは、cURLを使用してプログラムでReachability Insightを使用する方法を説明します。

Identity Insights API は、複数の地域のエンドポイントから利用できる。本ガイドの例では EU エンドポイントを使用していますが、全リストは以下を参照してください。技術詳細.

APIを呼び出す

Identity Insights API の認証は、コンパクトで自己完結型の JSON トークンである JWT を介して行われます。JWT を生成するには、当社のオンラインジェネレーターあるいは Vonage CLI.JWTを生成するには、アプリケーションIDと秘密鍵が必要です。JWTを取得したら、APIにリクエストを送信できます。

この例では、与えられたデバイスがモバイルネットワークに接続されているかどうか、またどのように接続されているかをチェックするために、Reachabilityインサイトに対するcURLリクエストを示している：

curl -X POST https://api-eu.vonage.com/identity-insights/v1/requests  \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+990123400",
    "purpose": "FraudPreventionAndDetection",
    "insights": {
      "reachability": {}
        }
    }'

そしてAPIは、現在の到達可能性の確認や利用可能なトラフィックタイプ（現在はSMSとデータがサポートされている）を含む、そのデバイスの到達可能性情報を返す：

{
  "request_id": "c2cc7a65-9b10-493f-9c0a-1c86751a91c4",
  "insights": {
    "reachability": {
        "latest_status_at":"2024-02-20T10:41:38.657Z",
        "is_reachable": true,
        "connectivity": ["DATA", "SMS"], 
        "status": {
            "code": "OK",
            "message": "Success"
        }
    }
  }
}

以下のフィールドが roaming 配列である：

フィールド	説明
`latest_status_at`	関連するデバイスの接続ステータスが最後に更新された時間。
`is_reachable`	デバイスの全体的な到達可能性を示す。 `true` デバイスがネットワークに接続されている場合。
`connectivity`	デバイスがネットワークに接続されているかどうかを示す。 `DATA` または `SMS` 使用方法。以下の場合にのみ返されます。 `is_reachable` は `true`.
`status`	指定された電話番号について返された情報のステータスを示す。
`code`	リクエストのステータスを示すコード。のいずれかでなければならない： `NO_COVERAGE`:国またはモバイルネットワークは、利用可能なサプライヤーによってサポートされていません。 `INVALID_PURPOSE`:使用された目的は、このインサイトで有効または許可されていません。 `UNAUTHORIZED`:アプリケーション、サプライヤー、電話番号の組み合わせでは、リクエストを承認できませんでした。 `INTERNAL_ERROR`:リクエストの処理中に内部エラーが発生しました。 `SUPPLIER_ERROR`:サプライヤーがリクエスト処理中にエラーを返しました。 `NOT_FOUND`:このインサイトの電話番号が見つかりません。 `INVALID_NUMBER_FORMAT`:電話番号フォーマットは、キャリアからユーザーへの割り当てには無効です。 `OK`:インサイトは正常に処理されました。
`message`	より詳細なステータスの説明。

さらに読む

Identity Insights API の詳細については、以下を参照してください。 APIリファレンス.
ご不明な点がございましたら、下記までお問い合わせください。 VonageコミュニティSlack.