Документация API | Объект Conference

info

Получение информации о конференции по её коду

Входные параметры:

Обязательные параметры:

String apikey (API ключ проекта)
String code (Код конференции)

Выходные параметры

String Title (Название конференции)
String Code (Код конференции)
String FolderCode (Код папки; null, если конференция в корне)
String Description (Описание)
String Public (Открытая конференция: yes/no)
String Lobby (Лобби/зал ожидания: yes/no)
String StartAt (Дата и время начала, формат Y-m-d H:i:s)
String Timezone (Часовой пояс для StartAt)
Integer Duration (Длительность в секундах; null, если не задана)
String ShowRecords (Показывать записи: yes/no)

Пример запроса:

Text

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

Пример ответа:

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

Cписок конференций

Входные параметры

String apikey (API ключ проекта)

Пример запроса:

Text

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

Пример ответа:

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

Cоздание новой конференции

Входные параметры

String apikey (API ключ проекта)
String title (Название конференции)

Необязательные параметры:

String folder (Код папки; алиас folderCode поддерживается для обратной совместимости)
String description (Описание конференции)
String public (Открытая конференция: yes/no; по умолчанию no)
String lobby (Лобби/зал ожидания: yes/no)
String startAt (Дата и время начала, формат Y-m-d H:i:s; хранится в указанном timezone)
String timezone (Часовой пояс для startAt, напр. Europe/Moscow)
Integer duration (Длительность в секундах; если задан startAt без duration — автоматически 1 час)

Пример запроса:

Text

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

Пример ответа:

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

Обновление параметров конференции (название, описание, папка, открытость, лобби, дата начала, часовой пояс, длительность, показ записей)

Входные параметры

Обязательные параметры:

String apikey (API ключ проекта)
String code (Код конференции)

Необязательные параметры:

String title (Название конференции)
String description (Описание конференции)
String folder (Код папки; алиас folderCode поддерживается для обратной совместимости)
String timezone (Часовой пояс для startAt, напр. Europe/Moscow)
String showRecords (Показывать записи: yes/no)
String public (Открытая конференция: yes/no)
String lobby (Лобби/зал ожидания: yes/no)
String startAt (Дата и время начала, формат Y-m-d H:i:s)
Integer duration (Длительность в секундах; если задан startAt без duration и у конференции ещё нет длительности — автоматически 1 час)

Пример запроса:

Text

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

Пример ответа:

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

Приглашение пользователей в конференцию

Входные параметры:

Обязательные параметры:

String apikey (API ключ проекта)
String code (Код конференции)
String email (Email пользователя)

Необязательные параметры:

String name (Имя пользователя отображаемое на коференции)
String timeout (Время жизни ссылки на конференцию)
String notifyEmail (оповещать о приглашении в конференцию по email, “yes” или “no”)
String moderator (сделать пользователя модератором, “yes“ или “no“)
String avatarUrl (URL ссылка на аватар пользователя)

Пример запроса:

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

Пример ответа:

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

Cписок пользователей на конференции

Входные параметры:

String apikey (API ключ проекта)
String code (Код конференции)

Выходные параметры:

String email (email пользователя)
String name (имя пользователя в конференции)
String code ( Код пользователя)
String moderator (Является ли пользователь модератором конференции)
String added (Дата и время добавления пользователя в конференцию)
String is_deleted (удалён пользователь из конференции)

Пример запроса:

Text

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

Пример ответа:

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

Информация о конкретном пользователе на конфреренции по его коду

Входные параметры

String apikey (API ключ проекта)
String code ( Код пользователя)

Выходные параметры

String email (email пользователя)
String name (имя пользователя в конференции)
String code ( Код пользователя)
String moderator (Является ли пользователь модератором конференции)
String added (Дата и время добавления пользователя в конференцию)
String is_deleted (удалён пользователь из конференции)

Пример запроса:

Text

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

Пример ответа:

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

Обновление информации о пользователе (email, имя, возможность модерировать конференцию)

Входные параметры

Обязательные параметры:

String apikey (API ключ проекта)
String code ( Код пользователя)

Необязательные параметры (указывать если хотите изменить):

String email (email пользователя)
String name (имя пользователя в конференции)
String moderator (Сделать пользователя модератором “yes”, сделать обычным участником “no”)

Пример запроса:

Text

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

Пример ответа:

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

Удаление пользователя из конференции

Входные параметры

String apikey (API ключ проекта)
String code ( Код пользователя)

Пример запроса:

Text

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

Пример ответа:

JSON

"message": "Client is deleted successful",
    "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

Удаление конференции

Входные параметры

String apikey (API ключ проекта)
String code ( Код конференции)

Пример запроса:

Text

https://boomstream.com/api/conference/delete?apikey=[API_KEY]&code=[CLIENT_CODE]

Привер ответа:

XML

<Response>
    <message>Client is deleted successful</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>

Объект Conference

info

Входные параметры:

Выходные параметры

list

Входные параметры

create

Входные параметры

update

Входные параметры

invite

Входные параметры:

client/list

Входные параметры:

Выходные параметры:

client/info

Входные параметры

Выходные параметры

client/update

Входные параметры

client/delete

Входные параметры

delete

Входные параметры

Продукты

Решения

Компания

Документы

Контакты

Официальные документы