Online Video Platform. Boomstream Platform.

Object Conference

conference

Methods: info | list | create | update | invite | client/list | client/info | client/update | client/delete | delete

info

Retrieving information about a conference by its code

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (conference code)

Output parameters

  • String Title (conference title)
  • String Description (description)

Request example:

Text 
https://boomstream.com/api/conference/info?apikey=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&format=json

Response example:

JSON 
  "title": "Testik",
    "code": "0c5db8c0-c2ab-4833-bda8-bf5e8d03da35",
    "description": "testovaya",
    "Status": "Success",
    "Version": "1.0",
    "Versions": [
        {"version": "1.0", "description": "Boomstream API v.1.0 loads by default"},
        {"version": "1.1", "description": "Boomstream API v.1.1. Add &ver=1.1 to the HTTP request to use it."},
        {"version": "1.2", "description": "Boomstream API v.1.2. Add &ver=1.2 to the HTTP request to use it."}
    ],
    "RequestURI": "/api/conference/info?apikey=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&format=json"

list

List of conferences

Input parameters

  • String apikey (project API key)

Request example:

Text 
https://boomstream.com/api/conference/list?apikey=1453d715690dfc600031ecdd448d4cf4&format=json

Response example:

JSON 
"conferences": [
    {"title": "Testik", "code": "3e33df55-b6bf-4b59-ad1d-6eb2bea78872", "description": "poppi"},
    {"title": "Testik", "code": "0c5db8c0-c2ab-4833-bda8-bf5e8d03da35", "description": "testovaya"}
],
"Status": "Success"

create

Creating a new conference

Input parameters

Required:

  • String apikey (project API key)
  • String title (conference title)

Optional:

  • String folderCode (folder code)
  • String description (conference description)

Request example:

Text 
https://boomstream.com/api/conference/create?apikey=1453d715690dfc600031ecdd448d4cf4&title=Testik&description=testovaya&format=json

Response example:

Text 
"Code": "03d71d2d-2f1c-418e-96f5-c92ce2ed430b",
"Status": "Success"

update

Updating conference parameters (title, description, folder code)

Input parameters

Required:

  • String apikey (project API key)
  • String code (conference code)

Optional:

  • String title
  • String description
  • String folderCode

Request example:

Text 
https://boomstream.com/api/conference/update?apikey=1453d715690dfc600031ecdd448d4cf4&code=03d71d2d-2f1c-418e-96f5-c92ce2ed430b&title=Konfa&description=vottak&format=json

Response example:

XML 
<Response>
    <title>Konfa</title>
    <code>03d71d2d-2f1c-418e-96f5-c92ce2ed430b</code>
    <folderCode>a8GESjhK</folderCode>
    <description>vottak</description>
    <Status>Success</Status>
</Response>

invite

Inviting users to a conference

Input parameters

Required:

  • String apikey (project API key)
  • String code (conference code)
  • String email (user email)

Optional:

  • String name (user's display name in the conference)
  • String timeout (lifetime of the conference link)
  • String notifyEmail (yes or no — notify the user about the invitation via email)
  • String moderator (yes or no — make the user a moderator)
  • String avatarUrl (URL of the user's avatar)

Request example:

Text 
https://boomstream.com/api/conference/invite?apikey=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&email=n.kuznetsov@hwdmedia.com&name=Nik&timeout=3600&notifyEmail=yes&moderator=yes&avatarUrl=&format=json

Response example:

JSON 
"name": "Nik",
"email": "n.kuznetsov@hwdmedia.com",
"codeConference": 198,
"code": "0c5db8c0-c2ab-4833-bda8-bf5e8d03da35",
"isModerator": true,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....",
"inviteLink": "https://hwd.boomstream.com/invite.html?jwt=...",
"Status": "Success"

client/list

List of users in a conference

Input parameters

  • String apikey (project API key)
  • String code (conference code)

Output parameters

  • String email (user email)
  • String name (user's conference display name)
  • String code (user code)
  • String moderator (whether the user is a conference moderator)
  • String added (date and time the user was added)
  • String is_deleted (whether the user has been removed from the conference)

Request example:

Text 
https://boomstream.com/api/conference/client/list?apikey=1453d715690dfc600031ecdd448d4cf4&code=3e33df55-b6bf-4b59-ad1d-6eb2bea78872&format=json

Response example:

JSON 
"Clients": [
    {
        "email": "n.kuznetsov@hwdmedia.com",
        "name": "Nik",
        "code": "jJY1av1o",
        "conferenceCode": "3e33df55-b6bf-4b59-ad1d-6eb2bea78872",
        "moderator": "yes",
        "added": "2024-01-19 12:14:27",
        "is_deleted": "no"
    }
],
"Status": "Success"

client/info

Information about a specific user in a conference by their code

Input parameters

  • String apikey (project API key)
  • String code (user code)

Output parameters

Same fields as client/list.

Request example:

Text 
https://boomstream.com/api/conference/client/info?apikey=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&format=json

client/update

Updating user information (email, name, moderator flag)

Input parameters

Required:

  • String apikey (project API key)
  • String code (user code)

Optional (specify only what you want to change):

  • String email
  • String name
  • String moderator (yes — make moderator, no — make regular participant)

Request example:

Text 
https://boomstream.com/api/conference/client/update?apikey=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&email=tany@hwdmedia.com&name=Nikita&moderator=no&format=json

Response example:

JSON 
"message": "Client changed successfully",
"clientCode": "jJY1av1o",
"Status": "Success"

client/delete

Removing a user from a conference

Input parameters

  • String apikey (project API key)
  • String code (user code)

Request example:

Text 
https://boomstream.com/api/conference/client/delete?apikey=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&format=json

Response example:

JSON 
"message": "Client is deleted successfully",
"clientCode": "jJY1av1o",
"Status": "Success"

delete

Deleting a conference

Input parameters

  • String apikey (project API key)
  • String code (conference code)

Request example:

Text 
https://boomstream.com/api/conference/delete?apikey=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35

Response example:

XML 
<Response>
    <message>Client is deleted successful</message>
    <Status>Success</Status>
</Response>