logo

Объект Conference

конференция

Методы:info | list | create | update | invite | client/list | client/info | client/update | client/delete| delete

info

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

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

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

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

  • String code (Код конференции)

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

  • String Title (Название конференции)

  • String Description (Описание)

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

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

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

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. \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=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&format=json"

list

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

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

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

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

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

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

JSON 
"conferences": [
        {
            "title": "Testik",
            "code": "3e33df55-b6bf-4b59-ad1d-6eb2bea78872",
            "description": "poppi"
        },
        {
            "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. \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=1453d715690dfc600031ecdd448d4cf4&format=json"

create

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

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

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

  • String title (Название конференции)

Необязательные параметры:
String folderCode (Код папки)
String description (Описание конференции)

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

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

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

JSON 
"Code": "03d71d2d-2f1c-418e-96f5-c92ce2ed430b",
    "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=1453d715690dfc600031ecdd448d4cf4&title=Testik&description=testovaya&folderCode=a8GESjhK&format=json"

update

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

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

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

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

  • String code (Код конференции)

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

  • String title (Название конференции)

  • String description (Описание конференции)

  • String folderCode (Код папки)

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

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

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

XML 
<Response>
    <title>Konfa</title>
    <code>03d71d2d-2f1c-418e-96f5-c92ce2ed430b</code>
    <folderCode>a8GESjhK</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 &amp;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 &amp;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=1453d715690dfc600031ecdd448d4cf4&amp;code=03d71d2d-2f1c-418e-96f5-c92ce2ed430b&amp;title=Konfa&amp;description=vottak&amp;format=json%22</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=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&email=n.kuznetsov@hwdmedia.com&name=Nik&timeout=3600&notifyEmail=yes&moderator=yes&avatarUrl=&format=json

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

JSON 
"name": "Nik",
    "email": "n.kuznetsov@hwdmedia.com",
    "codeConference": 198,
    "code": "0c5db8c0-c2ab-4833-bda8-bf5e8d03da35",
    "isModerator": true,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjb25mLmJvb21zdHJlYW0uY29tIiwiYXVkIjoiYm9vbXN0cmVhbS5jb20iLCJpYXQiOjE3MDU2NTUwNjYsInN1YiI6Im1lZXQuaml0c2kiLCJleHAiOjE3MDU2NTg2NjYsIm5iZiI6MTcwNTY1NDA2Niwicm9vbSI6IjBjNWRiOGMwLWMyYWItNDgzMy1iZGE4LWJmNWU4ZDAzZGEzNSIsIm1vZGVyYXRvciI6dHJ1ZSwiY29udGV4dCI6eyJ1c2VyIjp7Im5hbWUiOiJOaWsiLCJlbWFpbCI6Im4ua3V6bmV0c292QGh3ZG1lZGlhLmNvbSIsImF2YXRhciI6Imh0dHBzOi8vZ3JhdmF0YXIuY29tL2F2YXRhci81MT9zPTEyOCZyPVBHJmQ9cm9ib2hhc2gifX19.0_JL1PSfoZPVuB1XaPWc7F8eAfP62zQvsKFxrvP1WpQ",
    "inviteLink": "https://hwd.boomstream.com/invite.html?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjb25mLmJvb21zdHJlYW0uY29tIiwiYXVkIjoiYm9vbXN0cmVhbS5jb20iLCJpYXQiOjE3MDU2NTUwNjYsInN1YiI6Im1lZXQuaml0c2kiLCJleHAiOjE3MDU2NTg2NjYsIm5iZiI6MTcwNTY1NDA2Niwicm9vbSI6IjBjNWRiOGMwLWMyYWItNDgzMy1iZGE4LWJmNWU4ZDAzZGEzNSIsIm1vZGVyYXRvciI6dHJ1ZSwiY29udGV4dCI6eyJ1c2VyIjp7Im5hbWUiOiJOaWsiLCJlbWFpbCI6Im4ua3V6bmV0c292QGh3ZG1lZGlhLmNvbSIsImF2YXRhciI6Imh0dHBzOi8vZ3JhdmF0YXIuY29tL2F2YXRhci81MT9zPTEyOCZyPVBHJmQ9cm9ib2hhc2gifX19.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=1453d715690dfc600031ecdd448d4cf4&code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35&email=n.kuznetsov@hwdmedia.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=1453d715690dfc600031ecdd448d4cf4&code=3e33df55-b6bf-4b59-ad1d-6eb2bea78872&format=json

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

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",
    "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=1453d715690dfc600031ecdd448d4cf4&code=3e33df55-b6bf-4b59-ad1d-6eb2bea78872&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=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&format=json

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

JSON 
 "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",
    "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=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&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=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&email=tany@hwdmedia.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=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&email=tany@hwdmedia.com&name=Nikita&moderator=no&format=json&"

client/delete

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

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

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

  • String code ( Код пользователя)

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

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

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

JSON 
"message": "Client is deleted successful",
    "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/delete?apikey=1453d715690dfc600031ecdd448d4cf4&code=jJY1av1o&format=json"

delete

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

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

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

  • String code ( Код конференции)

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

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

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

XML 
<Response>
    <message>Client is deleted successfu</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 &amp;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 &amp;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=1453d715690dfc600031ecdd448d4cf4&amp;code=0c5db8c0-c2ab-4833-bda8-bf5e8d03da35</RequestURI>
</Response>