Method: phones.getCapabilities

Receba os recursos relacionados ao RCS for Business de um usuário.

O payload retornado especifica se um usuário pode ser alcançado com o RCS for Business e, em caso afirmativo, quais recursos do RCS for Business são compatíveis com o usuário.

Tratamento de erros: um erro 404 NOT_FOUND é retornado quando não é possível entrar em contato com o usuário usando o RCS para Empresas. Isso inclui vários cenários: (1) o dispositivo do usuário não é compatível com RCS ou está com o RCS desativado. (2) O usuário está em uma rede móvel em que o agente não foi lançado ou em que o tráfego RCS não está ativado. (3) Um agente não lançado solicita os recursos de um usuário que não é um testador.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Esse campo é resolvido como "phones/{E.164}/capabilities", em que {E.164} é o número de telefone do usuário no formato E.164. Por exemplo, para um usuário com o número de telefone dos EUA +1-222-333-4444, o endpoint resultante é https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

Parâmetros de consulta

Parâmetros
requestId

string

O ID exclusivo da solicitação, atribuído pelo agente. Precisa ser um UUID, conforme definido em https://www.rfc-editor.org/info/rfc9562. Se o ID da solicitação corresponder a um ID que o agente usou em uma solicitação anterior, a plataforma RCS for Business vai ignorar a nova solicitação.
agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Lista de recursos compatíveis com o usuário.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "features": [
    enum (Feature)
  ],
  "carrier": string
}
Campos
features[]

enum (Feature)

Lista de recursos do RCS for Business compatíveis com este dispositivo.
carrier

string

Apenas saída. As informações da operadora a que o número de telefone do usuário pertence, de acordo com os back-ends do Google RCS. No momento, esse campo é preenchido apenas para números de telefone dos EUA.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

Recurso

Tipos de recursos do RCS for Business que o usuário aceita.

Tipos enumerados
FEATURE_UNSPECIFIED Não especificado.
RICHCARD_STANDALONE Rich Cards independentes.
ACTION_CREATE_CALENDAR_EVENT Ação sugerida para criar um evento da agenda.
ACTION_DIAL Ação sugerida para discar um número.
ACTION_OPEN_URL Ação sugerida para abrir um URL no navegador.
ACTION_SHARE_LOCATION Ação sugerida para compartilhar um local.
ACTION_VIEW_LOCATION Ação sugerida para ver um local em um app de mapas.
ACTION_OPEN_URL_IN_WEBVIEW Ação sugerida para abrir um URL no WebView.