Method: phones.getCapabilities

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

返されるペイロードは、RBM でユーザーに到達できるかどうかと、ユーザーがサポートしている場合はどの RBM 機能かを指定します。RBM でユーザーに連絡できない場合、RBM プラットフォームは 404 NOT_FOUND を返します。

リリースされていないエージェントは、そのエージェントのテスターであるユーザーに対してのみ、機能をリクエストできます。未起動のエージェントがテスター以外の機能のリクエストを送信すると、RBM プラットフォームは 403 PERMISSION_DENIED を返します。

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 の概要をご覧ください。

機能

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

列挙型
FEATURE_UNSPECIFIED 指定されていません。
REVOCATION 取り消し。ユーザーが取り消しをサポートしている場合、エージェントは RBM プラットフォームがメッセージを配信する前に送信したメッセージを取り消すことができます。
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 を開くための推奨アクション。
ACTION_COMPOSE テキスト / 音声 / 動画メッセージを作成するための提案されたアクション。