Kick a user from a channel

How to remove a specific user from a channel.

Read time 2 minutes

Last updated 8 months ago

Use the following parameters to drop (also known as "kick") a user from a channel when you call

viv_chan_cmd.php

```
access_token
```
- the access token with specified claims for this action
```
auth_token
```
- the token that
```
viv_signin.php
```
returns
Note
The Control active channels API can use the
auth_token
parameter in place of the userid and pwd parameters. For more information, see Login API.
```
user_uri
```
- The user's URI
```
chan_uri
```
- The channel's URI
```
mode
```
- Use kick for this action

The following example displays how to kick a user from a channel when using an

auth_token

Domain:
```
mt1s.vivox.com
```
Issuer:
```
blindmelon-AppName-dev
```
Admin user:
```
blindmelon-AppName-dev-Admin
```

User to drop:

ip:.blindmelon-AppName-dev.jerky.@mt1s.vivox.com

Channel that contains the user to drop:

sip:confctl-g-blindmelon-AppName-dev.the-channel@mt1s.vivox.com

Construct a kick from channel token with the following parameters:

Note

This process requires a Vivox access token.

For more information, refer to the Access Token Developer Guide.

vxi:
```
2
```

sub:

sip:.blindmelon-AppName-dev.jerky.@mt1s.vivox.com

sip:blindmelon-AppName-dev-Admin@mt1s.vivox.com

iss:
```
blindmelon-AppName-dev
```
vxa:
```
kick
```

sip:confctl-g-blindmelon-AppName-dev.the-channel@mt1s.vivox.com

exp:
```
1600349400
```

The following example displays an access token that uses these parameters:


e30.eyJ2eGkiOjIsInN1YiI6InNpcDouYmxpbmRtZWxvbi1BcHBOYW1lLWRldi5qZXJreS5AbXQxcy52aXZveC5jb20iLCJmIjoic2lwOmJsaW5kbWVsb24tQXBwTmFtZS1kZXYtQWRtaW5AbXQxcy52aXZveC5jb20iLCJpc3MiOiJibGluZG1lbG9uLUFwcE5hbWUtZGV2IiwidnhhIjoia2ljayIsInQiOiJzaXA6Y29uZmN0bC1nLWJsaW5kbWVsb24tQXBwTmFtZS1kZXYudGhlLWNoYW5uZWxAbXQxcy52aXZveC5jb20iLCJleHAiOjE2MDAzNDk0MDB9.N8fVl_egw4OaGOp0CX7PgecQlsyZuRDW7F07of9FNtI

Call

/api2/viv_chan_cmd.php

with the following parameters:

```
access_token
```
- The token used in the preceding example

auth_token

- The token that

viv_signin.php

returns for

blindmelon-AppName-dev-Admin

chan_uri

sip:confctl-g-blindmelon.the-channel@mt1s.vivox.com

user_uri

sip:.blindmelon.jerky.@mt1s.vivox.com

```
mode
```
-
```
kick
```


https://mt1s.www.vivox.com/api2/viv_chan_cmd.php?mode=kick&access_token=e30.eyJ2eGkiOjIsInN1YiI6InNpcDouYmxpbmRtZWxvbi1BcHBOYW1lLWRldi5qZXJreS5AbXQxcy52aXZveC5jb20iLCJmIjoic2lwOmJsaW5kbWVsb24tQXBwTmFtZS1kZXYtQWRtaW5AbXQxcy52aXZveC5jb20iLCJpc3MiOiJibGluZG1lbG9uLUFwcE5hbWUtZGV2IiwidnhhIjoia2ljayIsInQiOiJzaXA6Y29uZmN0bC1nLWJsaW5kbWVsb24tQXBwTmFtZS1kZXYudGhlLWNoYW5uZWxAbXQxcy52aXZveC5jb20iLCJleHAiOjE2MDAzNDk0MDB9.N8fVl_egw4OaGOp0CX7PgecQlsyZuRDW7F07of9FNtI&auth_token=blindmelon-AppName-dev-Admin:1278945699:220a34213b4273a1eab1ac18b5fe67b6:TesterAlias:1&chan_uri=sip:confctl-g-blindmelon.the-channel@mt1s.vivox.com&user_uri=sip:.blindmelon.jerky.@mt1s.vivox.com

Documentation

Development

User Acquisition

Monetization

Industry