Method: phones.getCapabilities

ユーザーの RBM 関連の機能を取得します。

返されるペイロードは、ユーザーに RBM で連絡できるかどうか、連絡できる場合はユーザーがサポートしている RBM 機能を示します。

エラー処理: RBM でユーザーに連絡できない場合、404 NOT_FOUND エラーが返されます。これには、複数のシナリオが含まれます。（1）ユーザーのデバイスが RCS をサポートしていないか、RCS が無効になっている。（2）エージェントが起動していないモバイル ネットワーク、または RCS トラフィックが有効になっていないモバイル ネットワークを使用している。（3）リリースされていないエージェントが、テスターではないユーザーのケーパビリティをリクエストする。

HTTP リクエスト

GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

このフィールドは「phones/{E.164}/capabilities」に解決されます。ここで、{E.164} は E.164 形式のユーザーの電話番号です。たとえば、米国の電話番号 +1-222-333-4444 のユーザーの場合、結果のエンドポイントは https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities になります。

クエリ パラメータ

パラメータ
requestId

string

エージェントによって割り当てられたリクエストの一意の ID。これは、https://tools.ietf.org/html/rfc4122 で定義されている UUID である必要があります。リクエスト ID が、エージェントが以前のリクエストで使用した ID と一致する場合、RBM プラットフォームは新しいリクエストを無視します。
agentId

string

必須。エージェントの固有識別子。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ユーザーがサポートする機能のリスト

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "features": [
    enum (Feature)
  ]
}
フィールド
features[]

enum (Feature)

このデバイスがサポートする RBM 機能のリスト。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/rcsbusinessmessaging

詳細については、OAuth 2.0 Overview をご覧ください。

機能

ユーザーがサポートする RBM 機能のタイプ。

列挙型
FEATURE_UNSPECIFIED 指定されていません。
RICHCARD_STANDALONE スタンドアロンのリッチカード。
ACTION_CREATE_CALENDAR_EVENT カレンダーの予定を作成するための候補アクション。
ACTION_DIAL 電話番号をダイヤルする操作候補。
ACTION_OPEN_URL ブラウザで URL を開くための提案アクション。
ACTION_SHARE_LOCATION 位置情報を共有するための推奨アクション。
ACTION_VIEW_LOCATION 地図アプリで場所を表示するための操作候補。
ACTION_OPEN_URL_IN_WEBVIEW WebView で URL を開くための推奨アクション。