跳轉到主要內容
POST
Subscribe To Matchmaking Resource

授權

X-EntityToken
string
header
必填

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

主體

application/json

Subscribe to match resource notifications. Match subscriptions have two types; MatchInvite and MatchTicketStatusChange

Subscribe to match resource notifications. Match subscriptions have two types; MatchInvite and MatchTicketStatusChange

EntityKey
object
必填

The entity performing the subscription. The entity must be authorized to use this connectionHandle.

PubSubConnectionHandle
string
必填

Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection associated with this handle.

ResourceId
string
必填

The name of the resource to subscribe to. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.

SubscriptionVersion
number
必填

Version number for the subscription of this resource. Current supported version must be 1.

Type
string
必填

Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket. Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

回應

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
範例:
最後修改於 2026年10月6日