消息传递服务

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

本页包含开放云 v1 消息传递服务 API 的参考文档,可以向您体验中的所有服务器发送消息。

v2 API 有自己的 发布消息 方法版本。有关使用 v2 方法的信息,请参阅 消息传递使用指南

CrossServerMessaging

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

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

发布消息

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

向体验的预定义主题发布消息,其消息长度可达 1,024 字符(1 KB)。需要API密钥的 发布 权限和OAuth 2.0应用的 宇宙消息传递服务:发布 范围。请参阅跨服务器消息传递定义和订阅用户到主题。

参数

universeId number

您想发送消息的体验的识别器。你可以在创建者面板上复制你的体验宇宙ID。

Path
必填
topic string

您想发布消息到的主题,最多 80 个字符。

Path
必填

答复

必要权限

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

  • 发布

对象

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

PublishRequest

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

属性

message string

您想发布到生产服务器的消息内容。