Online Video Platform. Boomstream Platform.
Open in API Explorer

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=[API_KEY]&code=[CONFERENCE_CODE]&format=json

Response example:

JSON 
  "title": "Testik",
    "code": "xxx-xxxx-xxx",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/info?apikey=xxx...xxx&code=xxx-xxxx-xxx&format=json"

list

List of conferences

Input parameters

String apikey (project API key)

Request example:

Text 
https://boomstream.com/api/conference/list?apikey=[API_KEY]&format=json

Response example:

JSON 
"conferences": [
        {
            "title": "Testik",
            "code": "xxx-xxxx-xxx",
            "description": "poppi"
        },
        {
            "title": "Testik",
            "code": "xxx-xxxx-xx",
            "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/list?apikey=xxx...xxx&format=json"

create

Creating a new conference

Input parameters

  • String apikey (project API key)

  • String title (conference title)

Optional parameters:
String folderCode (folder code)
String description (conference description)

Request example:

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

Response example:

JSON 
"Code": "xxx-xxxx-xxx",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/create?apikey=xxx...xxx&title=Testik&description=testovaya&format=json"

update

Updating conference parameters (title, description, folder code)

Input parameters

Required parameters:

  • String apikey (project API key)

  • String code (conference code)

Optional parameters:

  • String title (conference title)

  • String description (conference description)

  • String folderCode (folder code)

Request example:

Text 
 https://boomstream.com/api/conference/update?apikey=[API_KEY]&code=[CONFERENCE_CODE]&title=Konfa&description=vottak&format=xml

Response example:

XML 
<Response>
    <title>Konfa</title>
    <code>xxx-xxxx-xxx</code>
    <folderCode>xxxxxxxx</folderCode>
    <description>vottak</description>
    <Status>Success</Status>
    <Version>1.0</Version>
    <Versions>
        <Item>
            <version>1.0</version>
            <description>Boomstream API v.1.0 loads by default</description>
        </Item>
        <Item>
            <version>1.1</version>
            <description>Boomstream API v.1.1. 
Add &ver=1.1 to the HTTP request to use it. 
Change log: it is changed the response format for the method ppv/listBuyers</description>
        </Item>
        <Item>
            <version>1.2</version>
            <description>Boomstream API v.1.2. 
Add &ver=1.2 to the HTTP request to use it. 
Change log: it is changed the response format for methods ppv/listMedia and ppv/addMedia</description>
        </Item>
    </Versions>
    <RequestURI>/api/conference/update?apikey=xxx-xxx-xxx&code=xxx-xxxx-xxx&title=Konfa&description=vottak&format=xml</RequestURI>
</Response>

invite

Inviting users to a conference

Input parameters:

Required parameters:

  • String apikey (project API key)

  • String code (conference code)

  • String email (user email)

Optional parameters:

  • String name (user's display name in the conference)

  • String timeout (lifetime of the conference link)

  • String notifyEmail (notify the user about the invitation via email, "yes" or "no")

  • String moderator (make the user a moderator, "yes" or "no")

  • String avatarUrl (URL of the user's avatar)

Request example:

Text 
 https://boomstream.com/api/conference/invite?apikey=[API_KEY]&code=[CONFERENCE_CODE]&email=example@boomstream.com&name=Nik&timeout=3600&notifyEmail=yes&moderator=yes&avatarUrl=&format=json

Response example:

JSON 
"name": "Nik",
    "email": "example@boomstream.com",
    "codeConference": 198,
    "code": "xxx-xxxx-xxx",
    "isModerator": true,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....0_JL1PSfoZPVuB1XaPWc7F8eAfP62zQvsKFxrvP1WpQ",
    "inviteLink": "https://conf.boomstream.com/invite.html?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9....0_JL1PSfoZPVuB1XaPWc7F8eAfP62zQvsKFxrvP1WpQ",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/invite?apikey=xxxx..xxxx&code=xxx-xxx-xxx&email=example@boomstream.com&name=Nik&timeout=3600&notifyEmail=yes&moderator=yes&avatarUrl=&format=json"

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 display name in the conference)

  • String code (user code)

  • String moderator (whether the user is a conference moderator)

  • String added (date and time the user was added to the conference)

  • String is_deleted (whether the user has been removed from the conference)

Request example:

Text 
https://boomstream.com/api/conference/client/list?apikey=[API_KEY]&code=[CONFERENCE_CODE]&format=json

Response example:

JSON 
"Clients": [
        {
            "email": "example@boomstream.com",
            "name": "Nik",
            "code": "jJY1av1o",
            "conferenceCode": "xxx-xxxx-xx",
            "moderator": "yes",
            "added": "2024-01-19 12:14:27",
            "is_deleted": "no"
        }
    ],
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/client/list?apikey=xxx...xxx&code=xxx-xxxx-xxx&format=json"
}

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

  • String email (user email)

  • String name (user's display name in the conference)

  • String code (user code)

  • String moderator (whether the user is a conference moderator)

  • String added (date and time the user was added to the conference)

  • String is_deleted (whether the user has been removed from the conference)

Request example:

Text 
https://boomstream.com/api/conference/client/info?apikey=[API_KEY]&code=[CLIENT_CODE]&format=json

Response example:

JSON 
 "email": "example@boomstream.com",
    "name": "Nik",
    "code": "jJY1av1o",
    "conferenceCode": "xxx-xxxx-xxx",
    "moderator": "yes",
    "added": "2024-01-19 12:14:27",
    "is_deleted": "no",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/client/info?apikey=xxx...xxx&code=xxx-xxxx-xxx&format=json"

client/update

Updating user information (email, name, ability to moderate the conference)

Input parameters

Required parameters:

  • String apikey (project API key)

  • String code (user code)

Optional parameters (specify only what you want to change):

  • String email (user email)

  • String name (user's display name in the conference)

  • String moderator (set the user as moderator "yes", or as a regular participant "no")

Request example:

Text 
https://boomstream.com/api/conference/client/update?apikey=[API_KEY]&code=[CLIENT_CODE]&email=example@boomstream.com&name=Nikita&moderator=no&format=json&

Response example:

JSON 
"message": "Client changed successfully",
    "clientCode": "jJY1av1o",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/client/update?apikey=xxx...xxx&code=xxx-xxxx-xxx&email=example@boomstream.com&name=Nikita&moderator=no&format=json&"

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=[API_KEY]&code=[CLIENT_CODE]&format=json

Response example:

JSON 
"message": "Client is deleted successfully",
    "clientCode": "xxx-xxxx-xxx",
    "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. \nAdd &ver=1.1 to the HTTP request to use it. \nChange log: it is changed the response format for the method ppv/listBuyers"
        },
        {
            "version": "1.2",
            "description": "Boomstream API v.1.2. \nAdd &ver=1.2 to the HTTP request to use it. \nChange log: it is changed the response format for methods ppv/listMedia and ppv/addMedia"
        }
    ],
    "RequestURI": "/api/conference/client/delete?apikey=xxx...xxx&code=xxx-xxxx-xxx&format=json"

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=[API_KEY]&code=[CONFERENCE_CODE]

Response example:

XML 
<Response>
    <message>Client is deleted successfully</message>
    <Status>Success</Status>
    <Version>1.0</Version>
    <Versions>
        <Item>
            <version>1.0</version>
            <description>Boomstream API v.1.0 loads by default</description>
        </Item>
        <Item>
            <version>1.1</version>
            <description>Boomstream API v.1.1. 
Add &ver=1.1 to the HTTP request to use it. 
Change log: it is changed the response format for the method ppv/listBuyers</description>
        </Item>
        <Item>
            <version>1.2</version>
            <description>Boomstream API v.1.2. 
Add &ver=1.2 to the HTTP request to use it. 
Change log: it is changed the response format for methods ppv/listMedia and ppv/addMedia</description>
        </Item>
    </Versions>
    <RequestURI>/api/conference/delete?apikey=xxx...xxx&code=xxx-xxxx-xxx</RequestURI>
</Response>