Documentation

Presence API

Presence API

Presence Service API (Deprecated)

Deprecation Notice: This service will be disabled.

Last Updated: 2026-01-16 Presence service will be disabled on April 20th, 2026. The recommended alternative for real-time presence and multiplayer functionality is Matchmaker.
Download OpenAPI specification:

Retrieves a list of rooms matching the filters.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Retrieves a list of rooms matching the filters."

organizationId

string
required
The active organization Id.

Query parameters for "Retrieves a list of rooms matching the filters."

ResourceType

string
Supported types are organization, project, asset and dataset.

ResourceId

string
Unique Id of the resource.

Name

string
Name of the room.

HTTP response status codes for "Retrieves a list of rooms matching the filters.":

Code samples for "Retrieves a list of rooms matching the filters.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms"

Response example

[ { "Name": "string", "ResourceType": "string", "ResourceId": "string", "OrganizationId": "string", "Uid": "string" }]

Creates a room with the fields in the request.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Creates a room with the fields in the request."

organizationId

string
required
The active organization Id.

Header parameters for "Creates a room with the fields in the request."

X-Digital-Twins-ClientTrace

string
required
The ClientTrace.

Request body for "Creates a room with the fields in the request."

Media Type:
application/json

ResourceType

string
Supported types are organization, project, asset and dataset.

ResourceId

string
Unique Id of the resource.

Name

string
Name of the room.

HTTP response status codes for "Creates a room with the fields in the request.":

Code samples for "Creates a room with the fields in the request.":

Request example

curl -X POST \ -H "X-Digital-Twins-ClientTrace: <X-Digital-Twins-ClientTrace>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "ResourceType": "string", "ResourceId": "string", "Name": "string"}' \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms"

Response example

[ { "Name": "string", "ResourceType": "string", "ResourceId": "string", "OrganizationId": "string", "Uid": "string" }]

Retrieves a Vivox login token for version 15.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Retrieves a Vivox login token for version 15."

roomUid

string
required
Unique Id of the room.

organizationId

string
required
The active organization Id.

Header parameters for "Retrieves a Vivox login token for version 15."

X-Digital-Twins-ClientTrace

string
required
The ClientTrace.

HTTP response status codes for "Retrieves a Vivox login token for version 15.":

Code samples for "Retrieves a Vivox login token for version 15.":

Request example

curl -X GET \ -H "X-Digital-Twins-ClientTrace: <X-Digital-Twins-ClientTrace>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms/{roomUid}/communication/vivox/v15/login"

Response example

{ "ServerAddress": "string", "UserId": "string", "Token": "string"}

Retrieves a Vivox join channel token for version 15.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Retrieves a Vivox join channel token for version 15."

roomUid

string
required
Unique Id of the room.

organizationId

string
required
The active organization Id.

Header parameters for "Retrieves a Vivox join channel token for version 15."

X-Digital-Twins-ClientTrace

string
required
The ClientTrace.

Request body for "Retrieves a Vivox join channel token for version 15."

Media Type:
application/json

Muted

boolean
No description

VivoxActionTokenParams

object
No description

SessionId

string | null
No description

IsValid

boolean
No description

HTTP response status codes for "Retrieves a Vivox join channel token for version 15.":

Code samples for "Retrieves a Vivox join channel token for version 15.":

Request example

curl -X POST \ -H "X-Digital-Twins-ClientTrace: <X-Digital-Twins-ClientTrace>" \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "Muted": true, "VivoxActionTokenParams": { "SessionId": "string", "IsValid": true }}' \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms/{roomUid}/communication/vivox/v15/join"

Response example

{ "ChannelId": "string", "Token": "string"}

Retrieves Vivox login token for version 16.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Retrieves Vivox login token for version 16."

roomUid

string
required
Unique Id of the room.

organizationId

string
required
The active organization Id.

Request body for "Retrieves Vivox login token for version 16."

Media Type:
application/json

VivoxUserId

string | null
No description

HTTP response status codes for "Retrieves Vivox login token for version 16.":

Code samples for "Retrieves Vivox login token for version 16.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "VivoxUserId": "string"}' \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms/{roomUid}/communication/vivox/v16/login"

Response example

{ "ServerAddress": "string", "UserId": "string", "Token": "string"}

Retrieves a Vivox join channel token for version 16.

Authorizations
Bearer
HTTP: Bearer
HTTP Authorization Scheme: bearer

Path parameters for "Retrieves a Vivox join channel token for version 16."

roomUid

string
required
Unique Id of the room.

organizationId

string
required
The active organization Id.

Request body for "Retrieves a Vivox join channel token for version 16."

Media Type:
application/json

Muted

boolean
No description

VivoxUserId

string | null
No description

VivoxChannelId

string | null
No description

HTTP response status codes for "Retrieves a Vivox join channel token for version 16.":

Code samples for "Retrieves a Vivox join channel token for version 16.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "Muted": true, "VivoxUserId": "string", "VivoxChannelId": "string"}' \ "https://services.api.unity.com/presence/v1/organizations/{organizationId}/rooms/{roomUid}/communication/vivox/v16/join"

Response example

{ "ChannelId": "string", "Token": "string"}