voicechat.joincomchannel Asynchronous

Ask Roblox to join the assigned voice session. Read the returned status as a request result, then check the current channel later to observe the outcome.

Syntax

Luau

voicechat.joincomchannel(id: string?) -> (success: boolean, status: string)

Parameters

Function parameters
Parameter	Type	Description
`id`	`string?`	Optional channel ID. A supplied ID succeeds only when it already matches the current channel.

Returns

(success: boolean, status: string)

A success boolean followed by a status string.

Usage notes

Calling without an ID dispatches joinVoice and returns join-requested when accepted; voice negotiation finishes later.

This build cannot request an arbitrary channel ID. A different explicit ID returns false with an explanation.

Example

Luau

local ok, eligible = pcall(voicechat.hasvoicechat)
if ok and eligible then
    local accepted, status = voicechat.joincomchannel()
    print(accepted, status)
    print("Current channel:", voicechat.getcomchannel())
end