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 地図アプリで場所を表示する場合に推奨される操作です。