new_releases 更新:查看
版本資訊瞭解新功能和產品更新。
RCS Business Messaging API
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
服務:rcsbusinessmessaging.googleapis.com
如要呼叫這項服務,建議您使用 Google 提供的範例。如果應用程式需要使用您自己的程式庫呼叫這項服務,請在發出 API 要求時使用下列資訊。
探索文件
探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:
服務端點
服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:
https://rcsbusinessmessaging.googleapis.com
方法 |
create |
POST /v1/files 個
POST /upload/v1/files 個
上傳用於媒體或複合式資訊卡訊息的檔案。 |
方法 |
create |
POST /v1/{parent=phones/*}/agentEvents
將事件從代理程式傳送給使用者。 |
方法 |
create |
POST /v1/{parent=phones/*}/agentMessages 個
傳送服務專員的訊息給使用者。 |
delete |
DELETE /v1/{name=phones/*/agentMessages/*} 個
撤銷已傳送但尚未傳送的服務專員訊息。 |
方法 |
create |
POST /v1/{parent=phones/*}/dialogflowMessages
提示 Dialogflow 代理程式透過 RBM 代理程式傳送訊息。 |
方法 |
create |
POST /v1/{parent=phones/*}/testers 個
邀請使用者測試代理程式。 |
方法 |
batchGet |
POST /v1/users:batchGet 個
取得使用者清單,啟用支援 RCS 的電話號碼。 |
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-10-14 (世界標準時間)。
[null,null,["上次更新時間:2024-10-14 (世界標準時間)。"],[[["\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. |"]]