new_releases Atualizações: consulte as
notas da versão para ver os novos recursos e atualizações do produto.
RCS Business Messaging API
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Serviço: rcsbusinessmessaging.googleapis.com
Para chamar esse serviço, recomendamos que você use as amostras fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.
Documento de descoberta
Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:
Endpoint de serviço
Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:
https://rcsbusinessmessaging.googleapis.com
Recurso da REST: v1.files
| Métodos |
create |
POST /v1/files
POST /upload/v1/files
Faz upload de um arquivo para uso em mensagens de mídia ou de rich cards. |
| Métodos |
getCapabilities |
GET /v1/{name=phones/*}/capabilities
Receba os recursos relacionados ao RBM de um usuário. |
| Métodos |
create |
de POST /v1/{parent=phones/*}/agentEvents
Envia um evento do agente para um usuário. |
| Métodos |
create |
POST /v1/{parent=phones/*}/agentMessages
Envia uma mensagem do agente para um usuário. |
delete |
DELETE /v1/{name=phones/*/agentMessages/*}
Revoga uma mensagem de agente que foi enviada, mas ainda não foi entregue. |
| Métodos |
requestCapabilityCallback
(deprecated) |
de POST /v1/{name=phones/*}/capability:requestCapabilityCallback
Solicita um retorno de chamada contendo os recursos de um usuário. |
| Métodos |
create |
POST /v1/{parent=phones/*}/dialogflowMessages
Solicita que um agente do Dialogflow envie mensagens por um agente do RBM. |
| Métodos |
create |
de POST /v1/{parent=phones/*}/testers
Convida um usuário para testar um agente. |
| Métodos |
batchGet |
POST /v1/users:batchGet
Recupera os números de telefone ativados para RCS de uma lista de usuários. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-10-14 UTC.
[null,null,["Última atualização 2024-10-14 UTC."],[[["\u003cp\u003eThe service \u003ccode\u003ercsbusinessmessaging.googleapis.com\u003c/code\u003e uses a Discovery Document for API specifications, with a specific document available at \u003ccode\u003e<https://rcsbusinessmessaging.googleapis.com/$discovery/rest?version=v1>\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for \u003ccode\u003ercsbusinessmessaging.googleapis.com\u003c/code\u003e is \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com\u003c/code\u003e, serving as the base URL for all relative URIs.\u003c/p\u003e\n"],["\u003cp\u003eThe API supports various methods for interacting with files, including uploading files via \u003ccode\u003ePOST /v1/files\u003c/code\u003e or \u003ccode\u003ePOST /upload/v1/files\u003c/code\u003e, in addition to managing agent-to-user messages and events, and checking user capabilities.\u003c/p\u003e\n"],["\u003cp\u003eThis API also enables interactions with Dialogflow agents and allows for managing testers for the agent.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers methods to retrieve RCS-enabled phone numbers from a list of users using \u003ccode\u003ePOST /v1/users:batchGet\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# RCS Business Messaging API\n\nService: rcsbusinessmessaging.googleapis.com\n--------------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [samples](/business-communications/rcs-business-messaging/samples). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://rcsbusinessmessaging.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://rcsbusinessmessaging.googleapis.com`\n\nREST Resource: [v1.files](/business-communications/rcs-business-messaging/reference/rest/v1/files)\n--------------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/files/create) | `POST /v1/files` `POST /upload/v1/files` Uploads a file for use in media or rich card messages. |\n\nREST Resource: [v1.phones](/business-communications/rcs-business-messaging/reference/rest/v1/phones)\n----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|\n| [getCapabilities](/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities) | `GET /v1/{name=phones/*}/capabilities` Get the RBM-related capabilities of a user. |\n\nREST Resource: [v1.phones.agentEvents](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents)\n----------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents/create) | `POST /v1/{parent=phones/*}/agentEvents` Sends an event from the agent to a user. |\n\nREST Resource: [v1.phones.agentMessages](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages)\n--------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages/create) | `POST /v1/{parent=phones/*}/agentMessages` Sends a message from the agent to a user. |\n| [delete](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages/delete) | `DELETE /v1/{name=phones/*/agentMessages/*}` Revokes an agent message that has been sent but not yet delivered. |\n\nREST Resource: [v1.phones.capability](/business-communications/rcs-business-messaging/reference/rest/v1/phones.capability)\n--------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| [requestCapabilityCallback](/business-communications/rcs-business-messaging/reference/rest/v1/phones.capability/requestCapabilityCallback)` ` **(deprecated)** | `POST /v1/{name=phones/*}/capability:requestCapabilityCallback` Requests a callback containing the capabilities of a user. |\n\nREST Resource: [v1.phones.dialogflowMessages](/business-communications/rcs-business-messaging/reference/rest/v1/phones.dialogflowMessages)\n------------------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.dialogflowMessages/create) | `POST /v1/{parent=phones/*}/dialogflowMessages` Prompts a [Dialogflow](https://dialogflow.com) agent to send messages through an RBM agent. |\n\nREST Resource: [v1.phones.testers](/business-communications/rcs-business-messaging/reference/rest/v1/phones.testers)\n--------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.testers/create) | `POST /v1/{parent=phones/*}/testers` Invites a user to test an agent. |\n\nREST Resource: [v1.users](/business-communications/rcs-business-messaging/reference/rest/v1/users)\n--------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| [batchGet](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet) | `POST /v1/users:batchGet` Gets the RCS-enabled phone numbers for a list of users. |"]]
