Service de messagerie

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Vous pouvez envoyer et recevoir la demande et la réponse suivantes pour diffuser des messages sur les serveurs de votre expérience. Pour plus d'informations sur l'utilisation de l'API, voir guide d'utilisation des messages.

CrossServerMessaging

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

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Publier un message

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

Publiez un message à un sujet prédéfini d'une expérience, avec la taille du message jusqu'à 1 024 caractères (1 KB). Requiert la permission Publier pour les clés API et le champ d'application univers-messaging-service:publier. Voir Messagerie inter serveur pour définir et abonner les utilisateurs à un sujet.

Paramètres

universeId number

L'identifiant de l'expérience dans laquelle vous voulez envoyer vos messages. Vous pouvez copier l'ID de votre expérience sur la tableau de bord du créateur.

Path
Requis
topic string

Le sujet auquel vous souhaitez publier votre message, avec jusqu'à 80 caractères.

Path
Requis

Réponse

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Publier

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • universe-messaging-service:publish

Objets

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

PublishRequest

L'objet de demande avec la chaîne de message que vous souhaitez publier sur le serveur en direct.

Attributs

message string

Le contenu du message que vous souhaitez publier sur le serveur en direct.