Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

Use this file to discover all available pages before exploring further.

Send new FAST text message to all players within a location and return the ID of the sent message

Prev Next
Post
/v{version}/Fast/location/{locationId}/text
Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
locationId
integer (int32) Required

Unique ID of the location

version
stringRequired

The requested API version

Default"1.20"
Body parameters

Content of the message as plain text

object

FAST text message for location

ArchiveDurationSeconds
integer (int32)

Archive duration in seconds of the message

Minimum0
Maximum2147483647
ClientRetryCount
integer (int32)

Client side retry count of the message

Minimum0
Maximum2147483647
ClientRetryIntervalMs
integer (int32)

Client side retry interval in milliseconds of the message

Minimum0
Maximum2147483647
ClientTimeoutMs
integer (int32)

Client side timeout in milliseconds of the message

Minimum0
Maximum2147483647
EditionGuid
string (uuid)

Unique GUID of the edition If the value is defined, the message will be sent only to players having the matching edition. If the value is not defined, there is not edition restriction on sending message. By default, the value is not defined.

Example00000000-0000-0000-0000-000000000000
IncludeOfflinePlayers
boolean

If true, the message will be sent to online and offline players.

LifetimeSeconds
integer (int32)

Message lifetimes in seconds of the message

Minimum10
Maximum2147483647
Payload
string Required

Payload of the message in plain text

Topic
string Required

Topic of the message

ValidCommitIdentifiers
Array of string

Valid commit identifiers of the message

string
Responses
200

OK

string (uuid)
Example00000000-0000-0000-0000-000000000000
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties