消息服务

*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按 此处。

您可以发送和接收以下请求和回应，以在您的体验中将广播消息传播到服务器。有关 API 的使用，请参阅消息传播指南。

CrossServerMessaging

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

相对于基础 URL 的路径，下列端点是可用的。

发布消息

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

发布一条消息到体验的预定主题，其大小为 1,024 个字符 (1 KB)。需要 发布 权限对 API 钥匙和 宇宙消息服务：发布 范围。请参阅 跨服务器消息发布 为用户定义和订阅主题。

参数

universeId number

您想要将消息发送到的体验的识别器。您可以在创建者仪表板上复制体验的宇宙ID。

Path
必填
topic string

你想要发布你的消息的主题，最多 80 个字符。

Path
必填

答复

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看 【管理 API 密钥】(/cloud/auth/api-keys)。

  • 发布

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】(/cloud/auth/oauth2-overview)。

  • universe-messaging-service:publish

对象

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

PublishRequest

您想要发布到实时服务器的消息字符串的请求体对象。

属性

message string

您想要发布到实时服务器的消息内容。