logo

Chat object

api
chat

Methods: init | info | createMessage | updateMessage | deleteMessage

init

Chat settings

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Live event code)

Optional parameters:

  • Boolean enabled (Turn chat On/Off); values: 1 or 0
  • Integer last_rows (Number of last messages from the history)
  • String default_message (Default message before chat messages)
  • String owner_nickname (Admin nickname); limit: 100 characters
  • Boolean show_users (Show users list button in the chat)

Output parameters

  • Boolean IsEnabled (Chat status)
  • Boolean SaveNickname (Save nickname setting)
  • Boolean ShowUsers (Show users button status)
  • String OwnerNickname (Admin nickname)
  • Integer LastRows (Number of messages from history)
  • String DefaultMessage (Default message)

Example request:

Text 
https://boomstream.com/api/chat/init?apikey=[API_KEY]&code=XXXXXXXX&enabled=1&owner_nickname=Administrator&last_rows=10&default_message=Start%20message

Example response:

XML 
<?xml version="1.0" encoding="utf-8"?>
<Response>
    <IsEnabled>true</IsEnabled>
    <SaveNickname>true</SaveNickname>
    <ShowUsers>false</ShowUsers>
    <OwnerNickname>User</OwnerNickname>
    <LastRows>10</LastRows>
    <DefaultMessage>Message</DefaultMessage>
    <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>
    </Versions>
    <RequestURI>/api/chat/init?apikey=286b9d5caba7ff5f013c814d0ec60a8e&amp;code=cff3vgXP&amp;enabled=1&amp;owner_nickname=User&amp;last_rows=10&amp;default_message=Message&amp;show_users</RequestURI>
</Response>

info

Chat message info

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Live event code)

Optional parameters:

  • Date start (Start date as YYYY-MM-DD, e.g., 2020-01-01); default: one week ago from end date
  • Date end (End date as YYYY-MM-DD, e.g., 2020-05-01); default: current date
  • String order (Sort order); options: asc (ascending), desc (descending); default: asc
  • Integer page (Page number); default: page=1

Output parameters

  • String Period (Period range)
  • String Start (Start date)
  • String End (End date)
  • Integer Page (Current page)
  • Integer PageLimit (Items per page)
  • Integer PageCount (Total pages)
  • Integer ItemCount (Total items)
  • Array Items (List of messages with date, code, nickname, identity, message)

Example request:

Text 
https://boomstream.com/api/chat/info?apikey=[API_KEY]&code=XXXXXXXX&start=2019-01-01&end=2020-05-21&order=asc

Example response:

XML 
<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Period>01.01.2021 - 01.12.2021</Period>
    <Start>01.01.2021</Start>
    <End>01.12.2021</End>
    <Page>0</Page>
    <PageLimit>1000</PageLimit>
    <PageCount>0</PageCount>
    <ItemCount>0</ItemCount>
    <ItemFormat>
        <date>Date</date>
        <code>Message code</code>
        <nickname>Nickname</nickname>
        <identity>Identity of user</identity>
        <message>Message</message>
    </ItemFormat>
    <Items/>
    <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>
    </Versions>
    <RequestURI>/api/chat/info?apikey=286b9d5caba7ff5f013c814d0ec60a8e&amp;code=cff3vgXP&amp;start=2021-01-01&amp;end=2021-12-01&amp;order=asc&amp;page</RequestURI>
</Response>

createMessage

Create a chat message

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Live event code)
  • String username (Username)
  • String message (Message text)

Output parameters

  • String Message (Operation result message)

Example request:

Text 
https://boomstream.com/api/chat/createMessage?apikey=[API_KEY]&code=XXXXXXXX&username=user&message=test

Example response:

XML 
<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Message>Message is created</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>
    </Versions>
    <RequestURI>/api/chat/createMessage?apikey=286b9d5caba7ff5f013c814d0ec60a8e&amp;code=cff3vgXP&amp;username=usr&amp;message=Test</RequestURI>
</Response>

updateMessage

Update a chat message

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Live event code)
  • String code_message (Chat message code)
  • String message (New message text)

Output parameters

  • String date (Message date)
  • String codeMessage (Message code)
  • String nickname (User nickname)
  • String identity (User identity)
  • Boolean isOwner (Whether the user is the owner)

Example request:

Text 
https://boomstream.com/api/chat/updateMessage?apikey=[API_KEY]&code=XXXXXXXX&code_message=[CODE_MESSAGE]&message=update

Example response:

XML 
<?xml version="1.0" encoding="utf-8"?>
<Response>
    <date>2021-11-03 11:23:54</date>
    <codeMessage>MZDupnoSVWYDW77jnWrKQCmAiRA7aSqb</codeMessage>
    <nickname>1</nickname>
    <identity>admin@boomstream.com</identity>
    <isOwner>false</isOwner>
    <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>
    </Versions>
    <RequestURI>/api/chat/updateMessage?apikey=286b9d5caba7ff5f013c814d0ec60a8e&amp;code=cff3vgXP&amp;code_message=MZDupnoSVWYDW77jnWrKQCmAiRA7aSqb&amp;message=upd</RequestURI>
</Response>

deleteMessage

Delete a chat message

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Live event code)
  • String code_message (Chat message code)

Output parameters

  • String Message (Operation result message)

Example request:

Text 
https://boomstream.com/api/chat/deleteMessage?apikey=[API_KEY]&code=XXXXXXXX&code_message=[CODE_MESSAGE]

Example response:

XML 
<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Message>Chat message is removed from history</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>
    </Versions>
    <RequestURI>/api/chat/deleteMessage?apikey=286b9d5caba7ff5f013c814d0ec60a8e&amp;code=cff3vgXP&amp;code_message=MZDupnoSVWYDW77jnWrKQCmAiRA7aSqb</RequestURI>
</Response>