sendChatMessage

This endpoint requires Authentication.

Sends a chat message to all players.

URL

POST http://localhost:8080/sendChatMessage

Request Body

Name Type Required? Description

message

String

Yes

The message to send.

sender

String

No

Sender’s name. Empty for System, "ada" for A.D.A messages.
Maximum 32 characters

color

Object

No

Color of the chat message.

  r

Float

No

Red channel intensity (0-1). Default: 1

  g

Float

No

Green channel intensity (0-1). Default: 1

  b

Float

No

Blue channel intensity (0-1). Default: 1

  a

Float

No

Alpha channel intensity (0-1). Default: 1

Response Body

Name Type Description

IsSent

Boolean

If the message passed all checks and was sent.

Message

String

The message sent to the chat.

Example Request

curl -X POST 'http://localhost:8080/sendChatMessage' \
-H 'Content-Type: application/json' \
-H 'X-FRM-Authorization: <your access token>' \
--data-raw '{ \
  "message": "Hello World :)", \
}'

Example Response

[
  {
    "IsSent": true,
    "Message": "Hello World :)"
  }
]