傳訊服務

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

此頁包含開放雲端 v1 訊息傳送服務 API 的參考文件，可以在您體驗中的所有伺服器上發送訊息。

v2 API 有自己的 發布訊息 方法版本。有關使用 v2 方法的資訊，請參閱 傳送使用指南。

CrossServerMessaging

https://apis.roblox.com/messaging-service/

根據相對基本網址的路徑，可使用下列終點。

發布一個訊息

POST /v1/universes/{universeId}/topics/{topic}

發布一條訊息到體驗的預定主題，訊息長度最多為 1,024 個字元 (1 KB)。需要 發布 權限對 API 鑰匙，以及 universe-messaging-service:publish 範圍對 OAuth 2.0 應用程式。請參閱跨服務器傳訊來定義和訂閱用戶對話題。

參數

universeId number

您想將訊息傳送到的體驗標識。您可以在 創作者面板 上複製體驗的宇宙ID。

Path
需要
topic string

您想發布訊息到的主題，最多可達 80 個字元。

Path
需要

回應

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 發布

限制
  • API 金鑰: 使用者或群組所有 API 金鑰每分鐘 5000 次要求數
  • OAuth 2.0: 每位應用程式使用者每分鐘 5000 次要求數

注意：在高流量期間，速率限制可能會降低。部分端點有額外的速率限制。深入瞭解速率限制。

物件

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

PublishRequest

要發布到生產伺服器的訊息字串的請求體對象。

特性

message string

您想發布到生產服務伺服器的訊息內容。