Video Chat API for Websites

Benefits of Adding the Video Chat API to Your Website:
Today, immediate communication is central to improved customer relationships. Chat allows instant communication with potential clients researching your brand, allowing you to convert more of them to customers. It also provides more 1:1 personalized service for your existing customers, helping your sales team retain and upsell for a better bottom line.
Companies that add chat to their website open a new, fun way for potential clients and existing customers to get — and stay — in touch. Our video chat API provides real bottom-line ROI.

The Language

MegaMeeting has a very easy-to-use video conferencing API. It is driven by GraphQL, a simple query language originally developed by Facebook in 2012 and open sourced in 2015. If you are unfamiliar with GraphQL, read more at GraphQL.org.

Usage

The MegaMeeting API allows you to create/edit/join/end meetings. If you have a large organization with many hosts, you can create/update/delete logins. You can also download/delete data such as meeting recordings and meeting usage.

See this article for a typical integration example.

Authentication

All queries/mutations require authentication, which is achieved via API key. You can generate/revoke an API key from the API section of your account settings. When making a request, send the API key as follows:

EXAMPLE:

apiToken=B834JR9F763JFKJF993JI0FJ4GH67234

Endpoint/Request URL

For the proper context and authentication to be accepted in your API request, the request URL should begin with your account’s URL.

EXAMPLE:

https://myaccount.megameeting.com/api

Methods

GraphQL is self-documenting and the best way to explore and understand the schema available is by accessing it directly via GraphQL Playground. You can download the Desktop app, or access it from your account:

https://myaccount.megameeting.com/playground

Add your endpoint URL and apiToken and you will be able to view the full schema available and test all of the API calls.

URL API

Joining the web based meeting requires visting a URL with a compatible web browser.

The URL to join the meeting should be constructed as follows:

EXAMPLE (standard meeting/webinar):

https://myaccount.megameeting.com/meeting/?id=1234567

The URL consists of 1) Your account domain 2) /meeting/ 3) query string for meeting ID.

OPTIONAL:

https://myaccount.megameeting.com/meeting/?id=1234567&name=John

Adding the name parameter allows you to include a name for the user that will appear in the meeting attendee list. If no name is provided, the user will be required to enter a name before joining the meeting.

OPTIONAL:

https://myaccount.megameeting.com/meeting/?id=1234567&name=John&go=1

Adding the go parameter allows you to bypass the guest landing page and immediately join the meeting. The name parameter is also required if using the go parameter.

Meetings with Verified Guests enabled, or Webinars with Registration enabled, cannot be joined via standard URL. The URL must contain the unique key for each individual attendee.

EXAMPLE (secured meeting/webinar):

https://myaccount.megameeting.com/meeting/?key=abcdef123456

The URL consists of 1) Your account domain 2) /meeting/ 3) query string for guest key.

OPTIONAL:

https://myaccount.megameeting.com/meeting/?key=abcdef123456&go=1

Adding the go parameter allows you to bypass the guest landing page and immediately join the meeting.

                
    query {
      meetings {
        edges {
          node {
            meetId
            name
          }
        }
      }
    }

                
    {
      "data": {
      "meetings": [
        {
          "edges": [
            {
              "node": {
                "name": "My First Meeting",
                "meetId": "1234567"
              }
            },
            {
              "node": {
                "name": "My Second Meeting",
                "meetId": "7654321"
              }
            }
          ]
        }
      ]
    }
    }

                
    query {
      logins {
        edges {
          node {
            userName
            loginId
            email
            fullName
            active
            roles
          }
        }
      }
    }

                
    {
      "data": {
        "logins": [{
          "edges": [{
              "node": {
                "userName": "michaels",
                "loginId": "5bf55555ac033142f8457264",
                "email": "michaels@megameeting.com",
                "fullName": "Michael",
                "active": 1,
                "roles": "owner,admin,host"
              }
            },
            {
              "node": {
                "userName": "pamb",
                "loginId": "5df155555a74d80b43e32a21",
                "email": "pamb@megameeting.com",
                "fullName": "Pam",
                "active": 0,
                "roles": "admin,host"
              }
            }
          ]
        }]
      }
    }

                
    query {
      startRemux(
      input: {
        accountId: "61216bddfe32733c86597a5c"
        loginId: "5d93bc02ebf54f60016c5480"
        meetId: "8626345"
        recordingId: "59216bccfe32133c86597a6b"
      }
    ) {
      status
      message
      result
    }
    }

              
    {
      "data": {
        "startRemux": {
          "status": "Completed",
          "message": "Remux request made successfully.",
          "result": null
        }
      }
    }

Note: Recordings must be processed before they can be downloaded or played. You can request processing from the UI, or via startRemux query.

EXAMPLE Download URL (Account domain + recPackage):

https://myaccount.megameeting.com/getweb?recordingkey=/15/2441730/1611598120523/P2P-Recording-2441730-Tech-Meeting-01-25-2021-12-09-01.mp4

EXAMPLE Playback Full URL (Account domain + recPlay):

https://myaccount.megameeting.com/videoplayer/?key=2441730&session=1611598120523

                
query {
  recordings {
    accId
    alId
    recId
    meetId
    recPackage
    recPlay
    recCreateDateTime
    remuxStatus
  }
}

              
{
  "data": {
    "recordings": [
    {
      "accId": "61216bddfe32733c86597a5c",
      "alId": "5d93bc02ebf54f60016c5480",
      "recId": "59216bccfe32133c86597a6b",
      "meetId": "8626345",
      "recPackage": "61216bddfe32733c86597a5c/8626345/1612802816164/P2P-Recording-8626345-Tech-Meeting-02-08-2021-10-50-20.mp4",
      "recPlay": null,
      "recCreateDateTime": "Feb 8, 2021 10:50:20",
      "remuxStatus": "waiting"
    }
    ]
  }
}

                
    query {
      apiTokenDetails(
        loginId: "5cc8525555555547431600d0"
      ) {
        domain
        apiToken
        createdAt
        lastUsed
      }
    }

              
    {
      "data": {
        "apiTokenDetails": {
          "domain": "https://myaccount.megameeting.com",
          "apiToken": "IWVFBYLWG0QWY7EI55555555VKQHQ97X",
          "createdAt": "Tue Nov 26 2019 15:19:12 +0000",
          "lastUsed": "Tue Nov 26 2019 15:31:34 +0000"
        }
      }
    }

                
    query {
      getVerifiedGuest(meetId: "7654321") {
        guestName
        key
        meetingLink
      }
    }

              
    {
      "data": {
        "getVerifiedGuest": [
          {
            "guestName": "John Doe",
            "key": "abcdef123456",
            "meetingLink": "https://myaccount.megameeting.com/meeting/?key=abcdef123456"
          }
        ]
      }
    }

                
    mutation {
      createMeeting(
      input: {
        meetingName: "My Video Meeting"
        scheduledDateTime: "Fri Feb 12 2021 10:00:00 -0600"
        scheduledTimeZone: "CST/UTC-06:00"
        endDateTime: "Fri Feb 12 2021 11:30:00 -0600"
      }
      ) {
        message
        result
        status
      }
    }

              
    {
      "data": {
        "createMeeting": {
          "message": "createMeeting() succeeded. New Meet_ID:1234567",
          "result": "1234567",
          "status": "completed"
        }
      }
    }

                
    mutation {
      createMeeting(input: {
        meetingName: "API Webinar Test",
        scheduledDateTime: "Tue Nov 24 2020 12:30:00 -0600",
        scheduledTimeZone: "CST/UTC-06:00",
        endDateTime: "Tue Nov 24 2020 14:00:00 -0600"
        enableRegistration: true,
        disableVideo: true,
        disableAudio: true,
        disableScreen: true,
        disableFileUpload: true,
        disableWebVideoPlayer: true,
        enableRestrictedUserList: true,
        enableRestrictedChat: true,
        enableChimes: false,
      }) {
        message result status
      }
    }

              
    {
      "data": {
        "createMeeting": {
          "message": "createMeeting() succeeded. New Meet_ID:7654321",
          "result": "7654321",
          "status": "completed"
        }
      }
    }

                
mutation{
  updateMeeting(input:{
    meetId:"1234567"
    meetName: "My New Name"
  })
{
  message
  result
  status
}}

              
{
  "data": {
    "updateMeeting": {
      "message": "Meeting updated",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  endMeeting(meetId:"1234567"){
    message
    result
    status
  }
}

              
{
  "data": {
    "endMeeting": {
      "message": "Meeting ended",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation {
  addVerifiedGuest(
    input: {
      meetId: "7654321"
      guestName: "John Doe"
      email: "johndoe@domain.com"
      permissions: [
        webcam
        microphone
        screenSharing
        chat
        fileUpload
        fileDownload
        webVideoPlayer
      ]
    }
  ) {
    message
    result
    status
  }
}

              
{
  "data": {
    "addVerifiedGuest": {
      "message": "Records added successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  updateVerifiedGuest(
  	key: "abcdef123456"
  	meetId: "1234567"
  	permissions: [
    	webcam
    	microphone
  	]
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "updateVerifiedGuest": {
      "message": "Record updated successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  removeVerifiedGuest(
    key: "abcdef123456"
    meetId: "1234567"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "removeVerifiedGuest": {
      "message": "Removed successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

createLogin
ADMIN ONLY
Add a login to your account. Requires admin token, and an available license that has been purchased. There 3 options for handling password/authentication for a login:
Set a password during createLogin (Not Recommended).
Do not set a password, instead call userInvitation API to send the user an activation link to set their own password (Recommended).
Do not set a password, and use the login API from your own application as a single-sign on solution.
IMPORTANT: In most cases, you should only assign the host role to a login of your account. The admin role should be reserved for the account owner/management. Admin users have access to the data of other hosts such meetings and recordings.

                
mutation{
  createLogin(
    input:{
      email:"user@example.com"
      fullName:"Example User"
      roles:{
        host:true
      }
      phoneNumber:"444-444-4444"
    }
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "createLogin": {
      "message": "Login Created successfully!",
      "result": "602c8096f5403b091960f85f",
      "status": "completed"
    }
  }
}

                
mutation{
  updateLogin(
    input:{
      loginId:"602c8096f5403b091960f85f"
      fullName:"Example User"
    }
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "updateLogin": {
      "message": "Details updated successfully!",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  deleteLogin(
    loginId:"602c8096f5403b091960f85f"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "deleteLogin": {
      "message": "Login deleted successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  createAPIToken(
    loginId:"5de976394005813985e4325f"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "createAPIToken": {
      "message": "API token created successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  revokeAPIToken(
    loginId:"5de976394005813985e4325f"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "revokeAPIToken": {
      "message": "API token revoked successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  userInvitation(
    email:"user@example.com"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "userInvitation": {
      "message": "Email sent successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

                
mutation{
  login(
    loginId:"5de976394005813985e4325f",
    meetId: "1234567",
    joinName:"Jane Doe"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "login": {
      "message": "success",
      "result": "https://myaccount.megameeting.com/?token=token&u=user&meetId=1234567&joinName=Jane%20Doe",
      "status": "200"
    }
  }
}

                
mutation{
  deleteRecording(
    recId:"1234567890"
    accId:"1234567890"
  )
{
  message
  result
  status
}}

              
{
  "data": {
    "deleteRecording": {
      "message": "Recording removed successfully",
      "result": "1",
      "status": "completed"
    }
  }
}

Start My Free Trial

UNLOCK

20% OFF

FIRST FULL YEAR

Need more? Sign up for an account.

Video Chat API for WebsitesQuickly add our video chat API to your website in minutes. Embedding video chat in your website allows immediate connectivity with customers.

Add Chat to Your Website to:Improve communication with remote teams.Increase cross-departmental collaboration.Respond quickly to sales inquiries.Help customers with fast, personalized communication.

The Language

Usage

Authentication

Endpoint/Request URL

Methods

URL API

Example Requests / ResponsesThe following is a simple reference guide. For complete examples and all available APIs, please see the graphql playground available in the API section of your account.

Request

Response

loginsGet a list of existing logins. Used for retrieving the details of existing users (logins) on your account. Often used for retrieving the loginId of an existing user in order to process updates via updateLogin API. Only available to Admin users.

Request

Response

startRemuxStarts the server-side processing in order to retrieve your recording(s). You will likely have some of this information stored in your database or you will run the recordings query to retrieve the information needed to start this process.

Request

Response

Request

Response

apiTokenDetailsGet the api token of a specific user on the account. Requires the loginId of the user. Returns the api token, if it exists, for the user along with usage time stamp. Only available to Admin users.

Request

Response

getVerifiedGuestRetrieve the links and keys of your special attendees.

Request

Response

createMeetingCreate a new meeting. The most common API mutation. Creating a new meeting room with a unique ID is most often used for creating separate, private meetings and providing the unqiue ID to the participants.

Video ConferenceFor video meetings 2 - 50 people.

Response-

Webinar w/ RegistrationFor 1-to-many broadcasts.

Response-

updateMeetingUpdate an existing meeting. Changes to the meeting may not immediately effect an active meeting session. Changes will be applied to new users/sessions of the meeting. Example: Change meeting name.

Required:meetId

Response-

endMeetingDisable an existing meeting. This functions as "delete" for all intents and purposes. The meeting will no longer appear in any lists except for Reports, and cannot be joined or edited.

Required:meetId

Response-

Add Special Attendees

Response

updateVerifiedGuestUpdate any existing special attendee. Mostly used to change name or permissions.

Required:meetId, key

Response-

removeVerifiedGuestRemove any existing special attendee. This will delete and invalidate their key, preventing any further access to the meeting.

Required:meetId, key

Response-

Required:email

Response-

Required:loginId

Response-

deleteLoginADMIN ONLYDeletes a login from your account and makes their license available to be reassigned. This is permanent and cannot be undone.

Required:loginId

Response-

Required:loginId

Response-

revokeAPITokenADMIN ONLYRevokes the API token of a user. Requires admin token. Cannot be undone.

Required:loginId

Response-

userInvitationADMIN ONLYSend an activation link to a newly-created login on your account. Used after createLogin. The user will receive an email with a 1-time-use activation link. After following the link, the user will be prompted to set their password, and then will be logged in to their account.

Required:loginId

Response-

Required:loginId

Response-

deleteRecordingDelete a recording. This is permanent and cannot be undone.

Required:recId, accId

Response-

Try it FREE for 14 Days!Try our meeting and webinar platform for 14 days, completely free!

Contact Us

More Information

Solutions

Developers

References

Video Chat API for Websites
Quickly add our video chat API to your website in minutes. Embedding video chat in your website allows immediate connectivity with customers.

Add Chat to Your Website to:
Improve communication with remote teams.
Increase cross-departmental collaboration.
Respond quickly to sales inquiries.
Help customers with fast, personalized communication.

Example Requests / Responses
The following is a simple reference guide. For complete examples and all available APIs, please see the graphql playground available in the API section of your account.

logins
Get a list of existing logins. Used for retrieving the details of existing users (logins) on your account. Often used for retrieving the loginId of an existing user in order to process updates via updateLogin API. Only available to Admin users.

startRemux
Starts the server-side processing in order to retrieve your recording(s). You will likely have some of this information stored in your database or you will run the recordings query to retrieve the information needed to start this process.

apiTokenDetails
Get the api token of a specific user on the account. Requires the loginId of the user. Returns the api token, if it exists, for the user along with usage time stamp. Only available to Admin users.

getVerifiedGuest
Retrieve the links and keys of your special attendees.

createMeeting
Create a new meeting. The most common API mutation. Creating a new meeting room with a unique ID is most often used for creating separate, private meetings and providing the unqiue ID to the participants.

Video Conference
For video meetings 2 - 50 people.

Response
-

Webinar w/ Registration
For 1-to-many broadcasts.

Response
-

updateMeeting
Update an existing meeting. Changes to the meeting may not immediately effect an active meeting session. Changes will be applied to new users/sessions of the meeting. Example: Change meeting name.

Required:
meetId

Response
-

endMeeting
Disable an existing meeting. This functions as "delete" for all intents and purposes. The meeting will no longer appear in any lists except for Reports, and cannot be joined or edited.

Required:
meetId

Response
-

updateVerifiedGuest
Update any existing special attendee. Mostly used to change name or permissions.

Required:
meetId, key

Response
-

removeVerifiedGuest
Remove any existing special attendee. This will delete and invalidate their key, preventing any further access to the meeting.

Required:
meetId, key

Response
-

Required:
email

Response
-

Required:
loginId

Response
-

deleteLogin
ADMIN ONLY
Deletes a login from your account and makes their license available to be reassigned. This is permanent and cannot be undone.

Required:
loginId

Response
-

Required:
loginId

Response
-

revokeAPIToken
ADMIN ONLY
Revokes the API token of a user. Requires admin token. Cannot be undone.

Required:
loginId

Response
-

Required:
loginId

Response
-

Required:
loginId

Response
-

deleteRecording
Delete a recording. This is permanent and cannot be undone.

Required:
recId, accId

Response
-

Try it FREE for 14 Days!
Try our meeting and webinar platform for 14 days, completely free!