メインコンテンツへスキップ
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日