Skip to main content

Lobby Matchmaking Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

  • Specification ID: http://lobby-matchmaking-service
  • Protobuf File Spec: matchmaking.proto

Table of Contents

Operations

PUB matchmaking Operation

Accepts one of the following messages:

Message matchmakingRequested

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.matchmakingRequestobject---additional properties are allowed
payload.matchmakingRequest.prioritystring----
payload.matchmakingRequest.createdAtstring----
payload.matchmakingRequest.channelstring----
payload.matchmakingRequest.partyIdstring----
payload.matchmakingRequest.ticketIdstring----
payload.matchmakingRequest.partyMembersarray<object>----
payload.matchmakingRequest.partyMembers.userIdstring----
payload.matchmakingRequest.partyMembers.extraAttributesobject---additional properties are allowed
payload.matchmakingRequest.timestampstring--format (date-time)-
payload.matchmakingRequest.eventstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"matchmakingRequest": {
"priority": "string",
"createdAt": "string",
"channel": "string",
"partyId": "string",
"ticketId": "string",
"partyMembers": [
{
"userId": "string",
"extraAttributes": {}
}
],
"timestamp": "2019-08-24T14:15:22Z",
"event": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingCanceled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.matchmakingobject---additional properties are allowed
payload.matchmaking.statusstring----
payload.matchmaking.matchIdstring----
payload.matchmaking.channelstring----
payload.matchmaking.namespacestring----
payload.matchmaking.gameModestring----
payload.matchmaking.matchingPartiesarray<object>----
payload.matchmaking.matchingParties.userIdstring----
payload.matchmaking.matchingParties.extraAttributesobject---additional properties are allowed
payload.matchmaking.ticketIdstring----
payload.matchmaking.ticketIdsarray<string>----
payload.matchmaking.ticketIds (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"matchmaking": {
"status": "string",
"matchId": "string",
"channel": "string",
"namespace": "string",
"gameMode": "string",
"matchingParties": [
{
"userId": "string",
"extraAttributes": {}
}
],
"ticketId": "string",
"ticketIds": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingStarted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.matchmakingobject---additional properties are allowed
payload.matchmaking.statusstring----
payload.matchmaking.matchIdstring----
payload.matchmaking.channelstring----
payload.matchmaking.namespacestring----
payload.matchmaking.gameModestring----
payload.matchmaking.matchingPartiesarray<object>----
payload.matchmaking.matchingParties.ticket_idstring----
payload.matchmaking.matchingParties.party_idstring----
payload.matchmaking.matchingParties.party_membersarray<object>----
payload.matchmaking.matchingParties.party_members.user_idstring----
payload.matchmaking.matchingParties.party_members.extra_attributesobject---additional properties are allowed
payload.matchmaking.matchingParties.party_attributesobject---additional properties are allowed
payload.matchmaking.matchingParties.ticket_created_atinteger----
payload.matchmaking.matchingParties.first_ticket_created_atinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"matchmaking": {
"status": "string",
"matchId": "string",
"channel": "string",
"namespace": "string",
"gameMode": "string",
"matchingParties": [
{
"ticket_id": "string",
"party_id": "string",
"party_members": [
{
"user_id": "string",
"extra_attributes": {}
}
],
"party_attributes": {},
"ticket_created_at": 0,
"first_ticket_created_at": 0
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingTimeout

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.matchmakingobject---additional properties are allowed
payload.matchmaking.statusstring----
payload.matchmaking.matchIdstring----
payload.matchmaking.channelstring----
payload.matchmaking.namespacestring----
payload.matchmaking.gameModestring----
payload.matchmaking.matchingPartiesarray<object>----
payload.matchmaking.matchingParties.userIdstring----
payload.matchmaking.matchingParties.extraAttributesobject---additional properties are allowed
payload.matchmaking.ticketIdstring----
payload.matchmaking.ticketIdsarray<string>----
payload.matchmaking.ticketIds (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"matchmaking": {
"status": "string",
"matchId": "string",
"channel": "string",
"namespace": "string",
"gameMode": "string",
"matchingParties": [
{
"userId": "string",
"extraAttributes": {}
}
],
"ticketId": "string",
"ticketIds": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingRejected

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.matchmakingobject---additional properties are allowed
payload.matchmaking.statusstring----
payload.matchmaking.matchIdstring----
payload.matchmaking.channelstring----
payload.matchmaking.namespacestring----
payload.matchmaking.gameModestring----
payload.matchmaking.matchingPartiesarray<object>----
payload.matchmaking.matchingParties.userIdstring----
payload.matchmaking.matchingParties.extraAttributesobject---additional properties are allowed
payload.matchmaking.ticketIdstring----
payload.matchmaking.ticketIdsarray<string>----
payload.matchmaking.ticketIds (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"matchmaking": {
"status": "string",
"matchId": "string",
"channel": "string",
"namespace": "string",
"gameMode": "string",
"matchingParties": [
{
"userId": "string",
"extraAttributes": {}
}
],
"ticketId": "string",
"ticketIds": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingChannelCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.rulesetobject---additional properties are allowed
payload.ruleset.allianceobject---additional properties are allowed
payload.ruleset.alliance.min_numberinteger----
payload.ruleset.alliance.max_numberinteger----
payload.ruleset.alliance.player_min_numberinteger----
payload.ruleset.alliance.player_max_numberinteger----
payload.ruleset.alliance.combinationobject---additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enableboolean----
payload.ruleset.alliance.combination.role_flexing_secondinteger----
payload.ruleset.alliance.combination.role_flexing_playerinteger----
payload.ruleset.alliance.combination.has_combinationboolean----
payload.ruleset.alliance.combination.alliancesarray<array<object>>----
payload.ruleset.alliance.combination.alliances (single item)array<object>----
payload.ruleset.alliance.combination.alliances.namestring----
payload.ruleset.alliance.combination.alliances.mininteger----
payload.ruleset.alliance.combination.alliances.maxinteger----
payload.ruleset.matching_rulearray<object>----
payload.ruleset.matching_rule.attributestring----
payload.ruleset.matching_rule.criteriastring----
payload.ruleset.matching_rule.referencenumber--format (float)-
payload.ruleset.flexing_rulearray<object>----
payload.ruleset.flexing_rule.durationinteger----
payload.ruleset.flexing_rule.matching_ruleobject---additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attributestring----
payload.ruleset.flexing_rule.matching_rule.criteriastring----
payload.ruleset.flexing_rule.matching_rule.referencenumber--format (float)-
payload.ruleset.alliance_flexing_rulearray<object>----
payload.ruleset.alliance_flexing_rule.durationinteger----
payload.ruleset.alliance_flexing_rule.AllianceRuleobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combinationobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enableboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_secondinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_playerinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combinationboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliancesarray<array<object>>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)array<object>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.namestring----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.mininteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.maxinteger----
payload.ruleset.match_optionsarray<object>----
payload.ruleset.match_options.optionsobject---additional properties are allowed
payload.ruleset.match_options.options.namestring----
payload.ruleset.match_options.options.typestring----
payload.ruleset.rebalance_enableboolean----
payload.descriptionstring----
payload.gameModestring----
payload.findMatchTimeoutSecondsinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"ruleset": {
"alliance": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
},
"matching_rule": [
{
"attribute": "string",
"criteria": "string",
"reference": 0
}
],
"flexing_rule": [
{
"duration": 0,
"matching_rule": {
"attribute": "string",
"criteria": "string",
"reference": 0
}
}
],
"alliance_flexing_rule": [
{
"duration": 0,
"AllianceRule": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
}
}
],
"match_options": [
{
"options": {
"name": "string",
"type": "string"
}
}
],
"rebalance_enable": true
},
"description": "string",
"gameMode": "string",
"findMatchTimeoutSeconds": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingChannelDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.rulesetobject---additional properties are allowed
payload.ruleset.allianceobject---additional properties are allowed
payload.ruleset.alliance.min_numberinteger----
payload.ruleset.alliance.max_numberinteger----
payload.ruleset.alliance.player_min_numberinteger----
payload.ruleset.alliance.player_max_numberinteger----
payload.ruleset.alliance.combinationobject---additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enableboolean----
payload.ruleset.alliance.combination.role_flexing_secondinteger----
payload.ruleset.alliance.combination.role_flexing_playerinteger----
payload.ruleset.alliance.combination.has_combinationboolean----
payload.ruleset.alliance.combination.alliancesarray<array<object>>----
payload.ruleset.alliance.combination.alliances (single item)array<object>----
payload.ruleset.alliance.combination.alliances.namestring----
payload.ruleset.alliance.combination.alliances.mininteger----
payload.ruleset.alliance.combination.alliances.maxinteger----
payload.ruleset.matching_rulearray<object>----
payload.ruleset.matching_rule.attributestring----
payload.ruleset.matching_rule.criteriastring----
payload.ruleset.matching_rule.referencenumber--format (float)-
payload.ruleset.flexing_rulearray<object>----
payload.ruleset.flexing_rule.durationinteger----
payload.ruleset.flexing_rule.matching_ruleobject---additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attributestring----
payload.ruleset.flexing_rule.matching_rule.criteriastring----
payload.ruleset.flexing_rule.matching_rule.referencenumber--format (float)-
payload.ruleset.alliance_flexing_rulearray<object>----
payload.ruleset.alliance_flexing_rule.durationinteger----
payload.ruleset.alliance_flexing_rule.AllianceRuleobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combinationobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enableboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_secondinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_playerinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combinationboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliancesarray<array<object>>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)array<object>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.namestring----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.mininteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.maxinteger----
payload.ruleset.match_optionsarray<object>----
payload.ruleset.match_options.optionsobject---additional properties are allowed
payload.ruleset.match_options.options.namestring----
payload.ruleset.match_options.options.typestring----
payload.ruleset.rebalance_enableboolean----
payload.descriptionstring----
payload.gameModestring----
payload.findMatchTimeoutSecondsinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"ruleset": {
"alliance": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
},
"matching_rule": [
{
"attribute": "string",
"criteria": "string",
"reference": 0
}
],
"flexing_rule": [
{
"duration": 0,
"matching_rule": {
"attribute": "string",
"criteria": "string",
"reference": 0
}
}
],
"alliance_flexing_rule": [
{
"duration": 0,
"AllianceRule": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
}
}
],
"match_options": [
{
"options": {
"name": "string",
"type": "string"
}
}
],
"rebalance_enable": true
},
"description": "string",
"gameMode": "string",
"findMatchTimeoutSeconds": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingChannelUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.rulesetobject---additional properties are allowed
payload.ruleset.allianceobject---additional properties are allowed
payload.ruleset.alliance.min_numberinteger----
payload.ruleset.alliance.max_numberinteger----
payload.ruleset.alliance.player_min_numberinteger----
payload.ruleset.alliance.player_max_numberinteger----
payload.ruleset.alliance.combinationobject---additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enableboolean----
payload.ruleset.alliance.combination.role_flexing_secondinteger----
payload.ruleset.alliance.combination.role_flexing_playerinteger----
payload.ruleset.alliance.combination.has_combinationboolean----
payload.ruleset.alliance.combination.alliancesarray<array<object>>----
payload.ruleset.alliance.combination.alliances (single item)array<object>----
payload.ruleset.alliance.combination.alliances.namestring----
payload.ruleset.alliance.combination.alliances.mininteger----
payload.ruleset.alliance.combination.alliances.maxinteger----
payload.ruleset.matching_rulearray<object>----
payload.ruleset.matching_rule.attributestring----
payload.ruleset.matching_rule.criteriastring----
payload.ruleset.matching_rule.referencenumber--format (float)-
payload.ruleset.flexing_rulearray<object>----
payload.ruleset.flexing_rule.durationinteger----
payload.ruleset.flexing_rule.matching_ruleobject---additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attributestring----
payload.ruleset.flexing_rule.matching_rule.criteriastring----
payload.ruleset.flexing_rule.matching_rule.referencenumber--format (float)-
payload.ruleset.alliance_flexing_rulearray<object>----
payload.ruleset.alliance_flexing_rule.durationinteger----
payload.ruleset.alliance_flexing_rule.AllianceRuleobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_numberinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combinationobject---additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enableboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_secondinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_playerinteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combinationboolean----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliancesarray<array<object>>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)array<object>----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.namestring----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.mininteger----
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.maxinteger----
payload.ruleset.match_optionsarray<object>----
payload.ruleset.match_options.optionsobject---additional properties are allowed
payload.ruleset.match_options.options.namestring----
payload.ruleset.match_options.options.typestring----
payload.ruleset.rebalance_enableboolean----
payload.descriptionstring----
payload.gameModestring----
payload.findMatchTimeoutSecondsinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"ruleset": {
"alliance": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
},
"matching_rule": [
{
"attribute": "string",
"criteria": "string",
"reference": 0
}
],
"flexing_rule": [
{
"duration": 0,
"matching_rule": {
"attribute": "string",
"criteria": "string",
"reference": 0
}
}
],
"alliance_flexing_rule": [
{
"duration": 0,
"AllianceRule": {
"min_number": 0,
"max_number": 0,
"player_min_number": 0,
"player_max_number": 0,
"combination": {
"role_flexing_enable": true,
"role_flexing_second": 0,
"role_flexing_player": 0,
"has_combination": true,
"alliances": [
[
{
"name": "string",
"min": 0,
"max": 0
}
]
]
}
}
}
],
"match_options": [
{
"options": {
"name": "string",
"type": "string"
}
}
],
"rebalance_enable": true
},
"description": "string",
"gameMode": "string",
"findMatchTimeoutSeconds": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingSessionStatusChanged

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.sessionobject---additional properties are allowed
payload.session.statusstring----
payload.session.eventstring----
payload.session.party_idstring----
payload.session.ticket_idstring----
payload.session.match_idstring----
payload.session.channelstring----
payload.session.namespacestring----
payload.session.game_modestring----
payload.session.server_namestring----
payload.session.client_versionstring----
payload.session.regionstring----
payload.session.joinableboolean----
payload.session.matching_alliesarray<object>----
payload.session.matching_allies.matching_partiesarray<object>----
payload.session.matching_allies.matching_parties.ticket_idstring----
payload.session.matching_allies.matching_parties.party_idstring----
payload.session.matching_allies.matching_parties.party_membersarray<object>----
payload.session.matching_allies.matching_parties.party_members.user_idstring----
payload.session.matching_allies.matching_parties.party_members.extra_attributesobject---additional properties are allowed
payload.session.matching_allies.matching_parties.party_attributesobject---additional properties are allowed
payload.session.matching_allies.matching_parties.ticket_created_atinteger----
payload.session.matching_allies.matching_parties.first_ticket_created_atinteger----
payload.session.matching_allies.playerCountinteger----
payload.session.deploymentstring----
payload.session.updatedAtstring--format (date-time)-
payload.session.queueAtinteger----
payload.session.partyAttributesstring----
payload.session.errorCodeinteger----
payload.session.errorMessagestring----
payload.session.timestampstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"session": {
"status": "string",
"event": "string",
"party_id": "string",
"ticket_id": "string",
"match_id": "string",
"channel": "string",
"namespace": "string",
"game_mode": "string",
"server_name": "string",
"client_version": "string",
"region": "string",
"joinable": true,
"matching_allies": [
{
"matching_parties": [
{
"ticket_id": "string",
"party_id": "string",
"party_members": [
{
"user_id": "string",
"extra_attributes": {}
}
],
"party_attributes": {},
"ticket_created_at": 0,
"first_ticket_created_at": 0
}
],
"playerCount": 0
}
],
"deployment": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"queueAt": 0,
"partyAttributes": "string",
"errorCode": 0,
"errorMessage": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message matchmakingTicketStatusChanged

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.ticketobject---additional properties are allowed
payload.ticket.priorityinteger----
payload.ticket.created_atinteger----
payload.ticket.channelstring----
payload.ticket.namespacestring----
payload.ticket.ticket_idstring----
payload.ticket.party_idstring----
payload.ticket.party_leader_idstring----
payload.ticket.party_attributesobject---additional properties are allowed
payload.ticket.party_membersarray<object>----
payload.ticket.party_members.user_idstring----
payload.ticket.party_members.extra_attributesobject---additional properties are allowed
payload.ticket.additional_criteriaobject---additional properties are allowed
payload.ticket.latency_mapobject----
payload.ticket.latency_map (additional properties)integer----
payload.ticket.sorted_latencyarray<object>----
payload.ticket.sorted_latency.regionstring----
payload.ticket.sorted_latency.latencyinteger----
payload.ticket.first_ticket_created_atinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"ticket": {
"priority": 0,
"created_at": 0,
"channel": "string",
"namespace": "string",
"ticket_id": "string",
"party_id": "string",
"party_leader_id": "string",
"party_attributes": {},
"party_members": [
{
"user_id": "string",
"extra_attributes": {}
}
],
"additional_criteria": {},
"latency_map": {
"property1": 0,
"property2": 0
},
"sorted_latency": [
{
"region": "string",
"latency": 0
}
],
"first_ticket_created_at": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

PUB matchmakingTotalPlayersInQueue Operation

Message matchmakingTotalPlayersInQueue

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.totalPlayersInQueueinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"totalPlayersInQueue": 0
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

PUB readyConsent Operation

Accepts one of the following messages:

Message readyConsentSuccess

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.successTicketsobject---additional properties are allowed
payload.successTickets.partyIdstring----
payload.successTickets.memberIdsarray<string>----
payload.successTickets.memberIds (single item)string----
payload.successTickets.ticketCreatedAtinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"successTickets": {
"partyId": "string",
"memberIds": [
"string"
],
"ticketCreatedAt": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message readyConsentFailed

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.successTicketsobject---additional properties are allowed
payload.successTickets.partyIdstring----
payload.successTickets.memberIdsarray<string>----
payload.successTickets.memberIds (single item)string----
payload.successTickets.ticketCreatedAtinteger----
payload.failedTicketsobject---additional properties are allowed
payload.failedTickets.partyIdstring----
payload.failedTickets.succeedMemberIdsarray<string>----
payload.failedTickets.succeedMemberIds (single item)string----
payload.failedTickets.failedMemberIdsarray<string>----
payload.failedTickets.failedMemberIds (single item)string----
payload.failedTickets.ticketCreatedAtinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"successTickets": {
"partyId": "string",
"memberIds": [
"string"
],
"ticketCreatedAt": 0
},
"failedTickets": {
"partyId": "string",
"succeedMemberIds": [
"string"
],
"failedMemberIds": [
"string"
],
"ticketCreatedAt": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"sessionId": "string",
"spanContext": "string"
}