Skip to content
GAMPEONCreate
New project

Who is in which voice channel

GET
/v1/communities/{id}/voice
curl --request GET \
--url https://api.gampeon.com/v1/communities/1/voice \
--header 'Authorization: Bearer <token>'

All voice channels you can see, with the people in them. allowed is false for accounts under 16 (reason: age_restricted): they see voice channels but cannot join. enabled is false while the voice server is not set up. Poll every 10 to 15 seconds at most until real-time updates arrive.

Not available with access tokens.

id
required
integer
>= 1

Community ID

Voice channels

Media typeapplication/json
object
enabled
required
boolean
allowed
required
boolean
reason
string
Allowed values: age_restricted
channels
required
Array<object>
object
id
required
integer
userLimit
required

0 is no limit

integer
participants
required
Array<object>
object
handle
required
string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
required
One of:
string
joinedAt
required

Unix time in milliseconds

integer format: int64
streaming
required

Sharing a screen right now

boolean
muted
required

Muted by moderators

boolean
team
required

Member of the studio or project team

boolean

Example

{
"reason": "age_restricted"
}

Error codes: unauthorized

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: token_not_allowed

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: not_found

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Report a problem with this pageOther ways to give feedback