Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
  • Tutorials
  • Reference
    • Vivox Core Unreal class model overview
    • Vivox Unreal conventions
    • Unreal API Reference Manual
    • Access Token Developer Guide
    • Server to Server Web API Reference Guide
      • Prerequisites
      • Authentication
      • Access tokens
      • Channel and user identification
      • Parameters
        • Common parameters
        • Fully qualified identifiers
      • Login API
      • Control active channels API
      • Kick API
      • Error handling
    • Third-party license information
  1. Vivox Unreal SDK documentation

Common Parameters

Reference common parameters used in server-to-server API requests.
Read time 2 minutes
Last updated 8 months ago
The following table details the parameters that are common to a majority of the Vivox Server to Server Web APIs.
ParameterDescriptionNotes
userid
The Vivox username of the requester of the Vivox operation.
Found in the VIVOX API INFO section on the Developer Portal.
pwd
The password of the user identified by the userid parameter.
Found in the VIVOX API INFO section on the Developer Portal.
auth_token
An explicit authorization token (cookie).
Found in the response from a successful viv_signin.php call. Note: The Control active channels API and the Kick API can each use the auth_token parameter in place of the userid and pwd parameters. For more information, see Login API.
access_token
The access token with proper claims for this action.
user_uri
The SIP URI of the user that is the target of the operation.
This value must be URL-encoded when calling the API.
chan_uri
The SIP URI of the channel that is the target of the operation.
This value must be URL-encoded when calling the API.
Note
Ensure that the 
user_uri
and 
chan_uri
parameters are fully qualified identifiers.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

    Report a problem with this page