Channel names
Understand the naming criteria and format required for Vivox channels.
Read time 1 minuteLast updated 8 months ago
When you create a channel name, the following criteria apply:
- Maximum of 200 characters
- Use only the following characters:
|
|
|
|---|---|---|
Exclamation mark | ' ! ' | 0x21 |
Open parenthesis | ' ( ' | 0x28 |
Close parenthesis | ' ) ' | 0x29 |
Plus | ' + ' | 0x2B |
Minus | ' - ' | 0x2D |
Period | ' . ' | 0x2E |
Equals | ' = ' | 0x3D |
Underscore | ' _ ' | 0x5F |
Tilde | ' ~ ' | 0x7E |
Percent | ' % ' | 0x7F |
Note
You can only use the percent sign for URL encoding. Follow the percent sign by two uppercase hex characters.
The recommended best practice is to URL-encode the channel name by using only uppercase hex digit characters. Lowercase characters are allowed in the channel name, but not when used as the hex digit characters.
Channel names must start with a confctl prefix and channel type, followed by your issuer, followed by a period '.'.
For example, if your issuer name is "crux", then a valid channel name is
confctl-g-crux.0verl0rd-channelNote
For the Vivox Unity SDK and the Vivox Unreal SDK, the naming displayed in this example only applies during access token generation. When you construct a ChannelId, you are expected to use only the part of the channel name and not for the name argument. The ChannelId function returns a full channel URI that is suitable for token generation, which includes the channel type, issuer, dot, and other URI components.
"0verl0rd-channel""confctl-g-crux.0verl0rd-channel"ToString()