Skip to main content

Type Alias: SendRoomMessageRequest

type SendRoomMessageRequest: components["schemas"]["SendRoomMessageRequest"];

Properties​

PropertyTypeRequiredDescription
typestringYesFrame type the clients switch on. 1–64 characters: letters, digits and ._:-, starting with a letter or digit. Types starting with cortex. are reserved for frames Cortex emits itself. (example: "match.countdown")
dataobjectYesFrame payload, delivered to the clients as data. Any JSON object. The whole encoded frame must not exceed 8 KB; larger messages are rejected with 413. (example: {"secondsLeft":10})
targetExternalUserIdsstring[]NoDeliver only to the peers of these players (your own user ids, as used in their ODIN tokens). Omit to send to everyone in the room. Players who are not in the room are skipped. At most 64. (example: ["steam:76561198000000000"])

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/rooms.ts:13