Serviço de Mensageria

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Você pode enviar e receber a seguinte solicitação e resposta para enviar mensagens e respostas em larga escala para os servidores de sua experiência. Para obter informações sobre o uso da API (Interface de Programação para Aplicações), consulte o Guia de Uso de Mensagens de Saída.

CrossServerMessaging

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

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Publicar uma mensagem

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

Publicar uma mensagem em um tópico predefinido de uma experiência, com o tamanho da mensagem até 1,024 caracteres (1 KB). Requer a permissão Publicar para chaves da API e o escopo único-mensageria-de-úniverso:publique para aplicativos OAuth 2.0. Veja Mensageria de Cross-Server para definir e inscrever usuários

Parâmetros

universeId number

O identificador da experiência em que você deseja enviar suas mensagens. Você pode copiar o ID do Universo da sua experiência em Painel do Criador.

Path
Obrigatório
topic string

O tópico que você deseja publicar sua mensagem, com até 80 caracteres.

Path
Obrigatório

Resposta

Permissões necessárias

As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.

  • Publicar

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte Registro e revisão de aplicativos.

  • universe-messaging-service:publish

Objetos

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

PublishRequest

O corpo da solicitação com a string de mensagem que você deseja publicar no servidor ao vivo.

Atributos

message string

A mensagem de conteúdo que você deseja publicar no servidor ao vivo.