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

  • Updated on Aug 9, 2024
  • Published on Aug 8, 2024
  • 1 minute(s) reading time
Prev Next
Post
/v{version}/Fast/location/{locationId}/binary
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
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.17"
Body parameters

Binary message

object

FAST binary message for location

EditionGuid
string (uuid)

The unique GUID of the edition

Example00000000-0000-0000-0000-000000000000
IncludeOfflinePlayers
boolean

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

Payload
string (byte) Required

Binary payload of the message

Topic
string Required

Topic of the message

ValidCommitIdentifiers
Array of string

Valid commit identifiers of the message

string
LifetimeSeconds
integer (int32)

Message lifetimes in seconds of the message

Maximum2147483647.0
Minimum10.0
ClientTimeoutMs
integer (int32)

Client side timeout in milliseconds of the message

Maximum2147483647.0
Minimum0.0
ClientRetryCount
integer (int32)

Client side retry count of the message

Maximum2147483647.0
Minimum0.0
ClientRetryIntervalMs
integer (int32)

Client side retry interval in milliseconds of the message

Maximum2147483647.0
Minimum0.0
ArchiveDurationSeconds
integer (int32)

Archive duration in seconds of the message

Maximum2147483647.0
Minimum0.0
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
Type
string
Message
string
Values
object
property*
object additionalProperties
500

Unexpected error

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