Kick API

The game server uses /api2/viv_adm_user_kick.php to drop (also known as "kick") a specific user from a channel or a server.

Note: Kicking a user from a server disconnects the user from the server and every channel they are in.

Use the following parameters to perform a kick action:

  • access_token - The access token with specified claims for this action

  • auth_token - The token that viv_signin.php returns

    Note: The Kick API can use the auth_token parameter in place of the userid and pwd parameters. For more information, see Login API.

  • chan_uri - The URI of the service from which the user is being kicked: either a channel URI or a special service URI (the issuer plus "-service")

  • user_uri - The URI of the user who is being kicked

  • mode - Use kick for this action

Unity logo Documentation
Copyright © 2025 Unity Technologies
"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.