The Vivox Access Token Developer Guides specify that SIP URIs are required for the sub, f, and t claims fields. Best practices for obtaining these SIP URIs vary by SDK: Vivox Unity 16.0.0+ uses the IVivoxTokenProvider interface; Vivox Unreal uses the ToString() method on AccountId and ChannelId objects; Vivox Core uses existing SIP URIs from login/session requests; and Vivox Unity 15.x overrides GetToken() in VxTokenGen.cs.
Issue:
The Vivox Access Token Developer Guides mention that SIP URIs are needed for the sub, f, and t claims fields.
See: Where can I find the Vivox Access Token (VAT) Developer Guide for my SDK?
Resolution:
The best practices method for obtaining SIP URIs to use an access token claim varies by SDK type.
-
Vivox Unity 16.0.0 and newer
- Please refer to the Interface Implementation-based Token Generation section of our online Vivox Unity 16.x SDK documentation. This section will provide you with information about how to register your
IVivoxTokenProviderimplementation, which will include your version ofGetTokenAsync(). This method will be called by the Vivox Unity SDK when a Vivox Access Token is required with all the appropriate values, like the user URI and channel URI. You will not need to construct these values as they are provided to you.
- Please refer to the Interface Implementation-based Token Generation section of our online Vivox Unity 16.x SDK documentation. This section will provide you with information about how to register your
-
Vivox Unreal
- Use the
ToString()function on theAccountIdandChannelIdobjects to get the correct SIP URIs. The string value returned by these functions can be used directly as the token identifier for sub, f, and t claims fields. - Note: This is the correct approach, even though some older header files may have marked these functions for "Internal use only."
- Use the
-
Vivox Core (Custom Engines)
- No special calls are needed to construct SIP URIs for Vivox Access Token generation, as you can simply use the same SIP URI values necessary to make the login and add session requests themselves.
-
Vivox Unity 15.x (Legacy)
- Please refer to the Override Development Key Generation section of our online Vivox Unity 15.x SDK documentation. This section will provide you with information about how to override the
GetToken()method withinVxTokenGen.cs. This method will be called by the Vivox Unity SDK when a Vivox Access Token is required with all the appropriate values, like the user URI a channel URI. You will not need to construct these values as they are provided to you.
- Please refer to the Override Development Key Generation section of our online Vivox Unity 15.x SDK documentation. This section will provide you with information about how to override the