Community Voice Chat

Check user community voice chat status

get

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/users/{userAddress}/community-voice-chat-status

Checks if a user is currently in any community voice chat. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

userAddressstringRequired

ETH address of the user

Responses

200

Community voice chat status retrieved successfully

application/json

is_user_in_voice_chatbooleanRequired

Whether the user is currently in a voice chat

400

Invalid request - Invalid address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

get

/users/{userAddress}/community-voice-chat-status

HTTPcURLJavaScriptPython

GET /users/{userAddress}/community-voice-chat-status HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "is_user_in_voice_chat": true
}

Create or join community voice chat

post

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat

Creates a new community voice chat or joins an existing one. The user's role in the community determines their permissions in the voice chat. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Body

application/json

community_idstringRequired

ID of the community

user_addressstringRequired

ETH address of the user

actionstring · enumRequired

Action to perform in community voice chat

Possible values:

user_rolestring · enumOptional

Role of the user in the community (defaults to none)

Possible values:

Responses

200

Community voice chat credentials generated successfully

application/json

connection_urlstringRequired

LiveKit connection URL for the community voice chat

400

Invalid request - Invalid community ID, address, or action

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

post

/community-voice-chat

HTTPcURLJavaScriptPython

POST /community-voice-chat HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "community_id": "text",
  "user_address": "text",
  "action": "create",
  "user_role": "owner",
  "profile_data": {
    "name": "text",
    "hasClaimedName": true,
    "profilePictureUrl": "text"
  }
}

{
  "connection_url": "text"
}

Get community voice chat status

get

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/status

Gets the current status of a community voice chat including participant counts. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

Responses

200

Community voice chat status retrieved successfully

application/json

activebooleanRequired

Whether the community voice chat is active

participantCountintegerRequired

Number of participants in the voice chat

moderatorCountintegerRequired

Number of moderators in the voice chat

400

Invalid request - Invalid community ID

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

get

/community-voice-chat/{communityId}/status

HTTPcURLJavaScriptPython

GET /community-voice-chat/{communityId}/status HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "active": true,
  "participantCount": 1,
  "moderatorCount": 1
}

Get all active community voice chats

get

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/active

Lists all currently active community voice chats. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Responses

200

Active community voice chats retrieved successfully

application/json

totalintegerRequired

Total number of active community voice chats

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

get

/community-voice-chat/active

HTTPcURLJavaScriptPython

GET /community-voice-chat/active HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "activeChats": [
    {
      "communityId": "text",
      "participantCount": 1,
      "moderatorCount": 1
    }
  ],
  "total": 1
}

Get bulk community voice chat status

post

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/status

Gets the status of multiple community voice chats in a single request. This endpoint is optimized for bulk queries and returns the status for all requested communities, including inactive ones. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Body

application/json

community_idsstring[] · min: 1Required

Array of community IDs to get status for

Example: ["community-1","community-2","community-3"]

Responses

200

Bulk community voice chat status retrieved successfully

application/json

400

Invalid request - Invalid community IDs or request format

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

post

/community-voice-chat/status

HTTPcURLJavaScriptPython

POST /community-voice-chat/status HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "community_ids": [
    "community-1",
    "community-2",
    "community-3"
  ]
}

{
  "data": [
    {
      "community_id": "text",
      "active": true,
      "participant_count": 1,
      "moderator_count": 1
    }
  ]
}

Request to speak

post

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/users/{userAddress}/speak-request

Requests permission to speak in a community voice chat. Only listeners can request to speak. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

userAddressstringRequired

ETH address of the user requesting to speak

Responses

204

Speak request submitted successfully

400

Invalid request - Invalid community ID or address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

post

/community-voice-chat/{communityId}/users/{userAddress}/speak-request

HTTPcURLJavaScriptPython

POST /community-voice-chat/{communityId}/users/{userAddress}/speak-request HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reject speak request

delete

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/users/{userAddress}/speak-request

Rejects a user's request to speak in a community voice chat. Only moderators can reject speak requests. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

userAddressstringRequired

ETH address of the user whose speak request is being rejected

Responses

204

Speak request rejected successfully

400

Invalid request - Invalid community ID or address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

delete

/community-voice-chat/{communityId}/users/{userAddress}/speak-request

HTTPcURLJavaScriptPython

DELETE /community-voice-chat/{communityId}/users/{userAddress}/speak-request HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Promote to speaker

post

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/users/{userAddress}/speaker

Promotes a user to speaker in a community voice chat. Only moderators can promote users to speakers. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

userAddressstringRequired

ETH address of the user to promote

Responses

204

User promoted to speaker successfully

400

Invalid request - Invalid community ID or address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

post

/community-voice-chat/{communityId}/users/{userAddress}/speaker

HTTPcURLJavaScriptPython

POST /community-voice-chat/{communityId}/users/{userAddress}/speaker HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Demote from speaker

delete

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/users/{userAddress}/speaker

Demotes a speaker to listener in a community voice chat. Only moderators can demote speakers. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

userAddressstringRequired

ETH address of the user to demote

Responses

204

User demoted from speaker successfully

400

Invalid request - Invalid community ID or address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

delete

/community-voice-chat/{communityId}/users/{userAddress}/speaker

HTTPcURLJavaScriptPython

DELETE /community-voice-chat/{communityId}/users/{userAddress}/speaker HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Kick player from community voice chat

delete

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}/users/{userAddress}

Kicks a player from a community voice chat. Only moderators can kick players. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

userAddressstringRequired

ETH address of the user to kick

Responses

204

Player kicked successfully

400

Invalid request - Invalid community ID or address

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

delete

/community-voice-chat/{communityId}/users/{userAddress}

HTTPcURLJavaScriptPython

DELETE /community-voice-chat/{communityId}/users/{userAddress} HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

End community voice chat

delete

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/community-voice-chat/{communityId}

Ends a community voice chat, disconnecting all participants. Only moderators can end community voice chats. Requires Bearer Token authentication.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters

communityIdstringRequired

ID of the community

Responses

204

Community voice chat ended successfully

400

Invalid request - Invalid community ID

application/json

401

Unauthorized - Invalid token

application/json

500

Internal server error

application/json

delete

/community-voice-chat/{communityId}

HTTPcURLJavaScriptPython

DELETE /community-voice-chat/{communityId} HTTP/1.1
Host: comms-gatekeeper.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content