Common parameters

Reference common parameters used in server-to-server API requests.

Read time 1 minute

Last updated a day ago

The following table details the parameters that are common to a majority of the Vivox Server to Server Web APIs.

Parameter	Description	Notes
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

Documentation