Method: phones.getCapabilities

Obtenir les fonctionnalités liées à la RBM d'un utilisateur

La charge utile renvoyée indique si un utilisateur peut être contacté avec RBM et, le cas échéant, quelles fonctionnalités RBM sont compatibles avec cet utilisateur. Si l'utilisateur ne peut pas être contacté avec RBM, la plate-forme RBM renvoie 404 NOT_FOUND.

Un agent qui n'est pas lancé ne peut demander des fonctionnalités que pour les utilisateurs qui sont des testeurs de cet agent. Si un agent non lancé demande les capacités d'un non-testeur, la plate-forme RBM renvoie 403 PERMISSION_DENIED.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Ce champ est résolu en "phones/{E.164}/capabilities", où {E.164} est le numéro de téléphone de l'utilisateur au format E.164. Par exemple, pour un utilisateur dont le numéro de téléphone aux États-Unis est +1-222-333-4444, le point de terminaison obtenu est https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

Paramètres de requête

Paramètres
requestId

string

ID unique de la requête, attribué par l'agent. Il doit s'agir d'un UUID, comme défini dans https://tools.ietf.org/html/rfc4122. Si l'ID de la requête correspond à un ID que l'agent a utilisé pour une requête précédente, la plate-forme RBM ignore la nouvelle requête.

agentId

string

Obligatoire. Identifiant unique de l'agent.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste des fonctionnalités compatibles avec l'utilisateur

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "features": [
    enum (Feature)
  ]
}
Champs
features[]

enum (Feature)

Liste des fonctionnalités RBM compatibles avec cet appareil.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Fonctionnalité

Types de fonctionnalités RBM compatibles avec l'utilisateur.

Enums
FEATURE_UNSPECIFIED Non spécifié.
REVOCATION Révocation. Si l'utilisateur accepte la révocation, l'agent peut révoquer un message envoyé avant que la plate-forme RBM ne le communique.
RICHCARD_STANDALONE Cartes enrichies autonomes
ACTION_CREATE_CALENDAR_EVENT Action suggérée pour créer un événement d'agenda.
ACTION_DIAL Action suggérée pour composer un numéro.
ACTION_OPEN_URL Action suggérée pour ouvrir une URL dans un navigateur.
ACTION_SHARE_LOCATION Action suggérée pour partager une position.
ACTION_VIEW_LOCATION Action suggérée pour afficher un lieu dans une application de carte.
ACTION_OPEN_URL_IN_WEBVIEW Suggestion d'action pour ouvrir une URL dans WebView.
ACTION_COMPOSE Action suggérée pour rédiger un message texte/audio/vidéo.