Login
    Contents x
    Start Call
      • Print
      • Dark
        Light
      • PDF
      Contents

      Start Call

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Get
        /api/v1/livechat/webrtc.call

        Note: WebRTC is no longer supported with Omnichannel Livechat audio/video calls.

        Header parameters
        X-Auth-Token
        stringRequired

        The authToken of the authenticated user.

        ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
        X-User-Id
        stringRequired

        The userId of the authenticated user.

        ExamplerbAXPnMktTFbNpwtJ
        Query parameters
        rid
        stringRequired

        The room ID.

        Responses
        200

        OK

        Expand All
        object
        videoCall
        object
        rid
        string
        provider
        string
        callStatus
        string
        success
        boolean
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout