Example: Kick token
Examples of Kick tokens that allow users to remove other users from channels.
Read time 1 minuteLast updated 2 days ago
Note
There is no example of a signed in user kicking another user from a server because this action is not possible with the current API.
Signed in user kicking other user from a channel
The token in this example allows the user "beef" to kick the user "jerky" from the channel "testchannel". The token expiration time is September 17, 2020 at 1:30 PM UTC. The token signing key is "secret!" (not including quotes).Header
{}
Payload
Note: Spacing has been added to this code for demonstration purposes. You can also list claims in any order.{ "vxi":665000, "sub":"sip:.blindmelon-AppName-dev.jerky.@tla.vivox.com", "f":"sip:.blindmelon-AppName-dev.beef.@tla.vivox.com", "iss":"blindmelon-AppName-dev", "vxa":"kick", "t":"sip:confctl-g-blindmelon-AppName-dev.testchannel@tla.vivox.com", "exp":1600349400}
Access token
e30.eyJ2eGkiOjY2NTAwMCwic3ViIjoic2lwOi5ibGluZG1lbG9uLUFwcE5hbWUtZGV2Lmplcmt5LkB0bGEudml2b3guY29tIiwiZiI6InNpcDouYmxpbmRtZWxvbi1BcHBOYW1lLWRldi5iZWVmLkB0bGEudml2b3guY29tIiwiaXNzIjoiYmxpbmRtZWxvbi1BcHBOYW1lLWRldiIsInZ4YSI6ImtpY2siLCJ0Ijoic2lwOmNvbmZjdGwtZy1ibGluZG1lbG9uLUFwcE5hbWUtZGV2LnRlc3RjaGFubmVsQHRsYS52aXZveC5jb20iLCJleHAiOjE2MDAzNDk0MDB9.kKnWD3smth6KUuRaY11O-yqAbXy2L2wDZeIoDK_098c
Admin user kicking other user from a channel
The token in this example allows the user "blindmelon-AppName-dev-Admin" to kick the user "jerky" from the channel "testchannel". The token expiration time is September 17, 2020 at 1:30 PM UTC. The token signing key is "secret!" (not including quotes).Header
{}
Payload
Note: Spacing has been added to this code for demonstration purposes. You can also list claims in any order.{ "vxi":8000, "sub":"sip:.blindmelon-AppName-dev.jerky.@tla.vivox.com", "f":"sip:blindmelon-AppName-dev-Admin@tla.vivox.com", "iss":"blindmelon-AppName-dev", "vxa":"kick", "t":"sip:confctl-g-blindmelon-AppName-dev.testchannel@tla.vivox.com", "exp":1600349400}
Access token
e30.eyJ2eGkiOjgwMDAsInN1YiI6InNpcDouYmxpbmRtZWxvbi1BcHBOYW1lLWRldi5qZXJreS5AdGxhLnZpdm94LmNvbSIsImYiOiJzaXA6YmxpbmRtZWxvbi1BcHBOYW1lLWRldi1BZG1pbkB0bGEudml2b3guY29tIiwiaXNzIjoiYmxpbmRtZWxvbi1BcHBOYW1lLWRldiIsInZ4YSI6ImtpY2siLCJ0Ijoic2lwOmNvbmZjdGwtZy1ibGluZG1lbG9uLUFwcE5hbWUtZGV2LnRlc3RjaGFubmVsQHRsYS52aXZveC5jb20iLCJleHAiOjE2MDAzNDk0MDB9.7Fn08cctqltxNxPAAeOhPQd4KCsmT1ue1EDIxUNQ3gg
Admin user kicking other user from a server
The token in this example allows the user "blindmelon-AppName-dev-Admin" to kick the user "jerky" from the entire server. The token expiration time is September 17, 2020 at 1:30 PM UTC. The token signing key is "secret!" (not including quotes).Header
{}
Payload
Note: Spacing has been added to this code for demonstration purposes. You can also list claims in any order.{ "vxi":613642, "sub":"sip:.blindmelon-AppName-dev.jerky.@tla.vivox.com", "f":"sip:blindmelon-AppName-dev-Admin@tla.vivox.com", "iss":"blindmelon-AppName-dev", "vxa":"kick", "t":"sip:blindmelon-AppName-dev-service@tla.vivox.com", "exp":1600349400}
Access token
e30.eyJ2eGkiOjYxMzY0Miwic3ViIjoic2lwOi5ibGluZG1lbG9uLUFwcE5hbWUtZGV2Lmplcmt5LkB0bGEudml2b3guY29tIiwiZiI6InNpcDpibGluZG1lbG9uLUFwcE5hbWUtZGV2LUFkbWluQHRsYS52aXZveC5jb20iLCJpc3MiOiJibGluZG1lbG9uLUFwcE5hbWUtZGV2IiwidnhhIjoia2ljayIsInQiOiJzaXA6YmxpbmRtZWxvbi1BcHBOYW1lLWRldi1zZXJ2aWNlQHRsYS52aXZveC5jb20iLCJleHAiOjE2MDAzNDk0MDB9.jinc73lQ_ZSN4Mb8WLFK7Clu-Se9LG-QifXKfpaa3g4