Send new FAST text message to a specific player and return the ID of the sent message

Prev Next
Post
/v{version}/Fast/player/{playerId}/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
playerId
integer (int32) Required

Unique ID of the player

version
stringRequired

The requested API version

Body parameters

Content of the message as plain text

object

FAST text message for player

ArchiveDurationSeconds
integer (int32)

Archive duration in seconds of the message

Minimum0
Maximum2147483647
Example86400
ClientRetryCount
integer (int32)

Client side retry count of the message

Minimum0
Maximum2147483647
Example5
ClientRetryIntervalMs
integer (int32)

Client side retry interval in milliseconds of the message

Minimum0
Maximum2147483647
Example1000
ClientTimeoutMs
integer (int32)

Client side timeout in milliseconds of the message

Minimum0
Maximum2147483647
Example30000
LifetimeSeconds
integer (int32)

Message lifetimes in seconds of the message

Minimum10
Maximum2147483647
Example30
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)
400

Bad Request

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

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
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