Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Channel URI structure

Reference the Uniform Resource Identifier format for Vivox channels.
Read time 1 minuteLast updated 2 months ago
A channel URI uses the following format: sip:confctl-g-issuer.lobby@mt1s.vivox.com. The following list details each part of the channel URI structure:
  • sip - indicates a SIP channel
  • confctl-g - a Confctl reference with a channel type
    • d for a positional channel
    • e for an echo channel
    • g for a non-positional channel
  • issuer - the server issuer
  • lobby - the name of the channel
    Note
    This uses the same character and length criteria as the account name.
  • @mt1s.vivox.com - the Vivox server that the user is connecting to
Note
Ensure that the chan_uri parameter is a fully qualified identifier.
Positional URIs have additional requirements and use the following structure: sip:confctl-{channelTypeStr}-{issuer}.{channelName}!p-{audibleDistance}-{conversationalDistance}-{audioFadeIntensityRounded}-{audioFadeModelAsInt}@{domain} For example: sip:[confctl-d-issuer.lobby!p-32-1-1.000-1@mt1s.vivox.com|mailto:confctl-d-myissuer.lobbyChannel!p-32-1-1.000-1@mt1s.vivox.com]
Note
The ChannelId.ToString() method will convert the ChannelId into a channel URI string. You may use this method to examine your ChannelId objects to see an example of the URI.