The Join API allows a user to join a Channel or a main Account. To use this API, the user must be logged in so that a User Context is established. In case the user doesn’t have appropriate rights, an error will be returned.

 

This API only expects ‘tenant_id’ parameter to be able to execute. 


Sample Code

 

<script type="text/javascript" src="http://video.lexcorpinc.com/JavaScript/bundles/widgets.js"></script>
<script type="text/javascript">

    function Join() {
        var options = {
               "access_token":'oo45%252f%252fpgC2skXAD8koQ%253d%253d'
               "tenant_id": 5442,
               "role_name": "Administrator"
                }        
        vidizmo.api.channels.Join(options,
             function (response) {

            // on completion
        });
    }

</script>

 


Properties


Property
Comments
tenant_id
 
Tenant Id of a Channel / Account user wants to join.
role_name
optional
Role Name, the default value is Viewer.
Possible values:
Administrator, Contributor, Manager, Moderator, Viewer



Response


{status: 1, status_code: 200, message: "You have Successfully joined the channel."}

 


To learn more how these Widgets work, click here on VIDIZMO JS API Implementation.

For a complete list of VIDIZMO APIs, click here on VIDIZMO Developer APIs.