Community Voice Chat

Check user community voice chat status

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

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

Authorizations
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters
userAddressstringRequired

ETH address of the user

Responses
chevron-right
200

Community voice chat status retrieved successfully

application/json
get
/users/{userAddress}/community-voice-chat-status

Create or join community voice chat

post
/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
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Body
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
chevron-right
200

Community voice chat credentials generated successfully

application/json
post
/community-voice-chat

Get community voice chat status

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

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

Authorizations
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters
communityIdstringRequired

ID of the community

Responses
chevron-right
200

Community voice chat status retrieved successfully

application/json
get
/community-voice-chat/{communityId}/status

Get all active community voice chats

get
/community-voice-chat/active

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

Authorizations
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Responses
chevron-right
200

Active community voice chats retrieved successfully

application/json
get
/community-voice-chat/active

Get bulk community voice chat status

post
/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
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Body
community_idsstring[] · min: 1Required

Array of community IDs to get status for

Example: ["community-1","community-2","community-3"]
Responses
chevron-right
200

Bulk community voice chat status retrieved successfully

application/json
post
/community-voice-chat/status

Request to speak

post
/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
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
post
/community-voice-chat/{communityId}/users/{userAddress}/speak-request

No content

Reject speak request

delete
/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
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
delete
/community-voice-chat/{communityId}/users/{userAddress}/speak-request

No content

Promote to speaker

post
/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
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
post
/community-voice-chat/{communityId}/users/{userAddress}/speaker

No content

Demote from speaker

delete
/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
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
delete
/community-voice-chat/{communityId}/users/{userAddress}/speaker

No content

Kick player from community voice chat

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

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

Authorizations
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
delete
/community-voice-chat/{communityId}/users/{userAddress}

No content

End community voice chat

delete
/community-voice-chat/{communityId}

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

Authorizations
AuthorizationstringRequired

Bearer token authentication for service-to-service communication.

Path parameters
communityIdstringRequired

ID of the community

Responses
delete
/community-voice-chat/{communityId}

No content

Last updated