Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Kick a user from a channel

Reference the Kick Application Programming Interface endpoint for removing a user from a channel.
Read time 1 minuteLast updated 2 days ago
The following scenario displays an example of how to kick a user from a channel when you call 
viv_adm_user_kick.php
:
  • Domain: 
    mt1s.vivox.com
  • Issuer: 
    blindmelon-AppName-dev
  • Admin user: 
    blindmelon-AppName-dev-Admin
  • User to kick: 
    jerky
  • Channel that contains the user to kick: 
    sip:confctl-g-blindmelon-AppName-dev.the-channel@mt1s.vivox.com
Based on this information, call 
viv_adm_user_kick.php
with the following parameters: 
  • access_token
    - The access token with specified claims for this action.
  • auth_token
    - The token that 
    viv_signin.php
    returns for 
    blindmelon-AppName-dev-Admin
    (Refer to Login API)
  • chan_uri
    - 
    sip:confctl-g-blindmelon-AppName-dev.the-channel@mt1s.vivox.com
  • user_uri
    - 
    sip:.blindmelon-AppName-dev.jerky.@mt1s.vivox.com