Chat object

Methods: Chat settings | Chat messages | Remove a chat message

chat/init

Chat settings.

Input parameters

Required parameters:

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

Optional parameters:

  • Boolean enabled (Turn On/Off chat). Values are 1 and 0
  • Integer last_rows (Number of last messages from the history)
  • String default_message (Default message before chat messages)
  • String nickname (Admin's Nickname). Limit is 100 letters.

Sample query:

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

Sample response:

<Response>
   <Message>Chat is settings is updated</Message>
   <Status>Success</Status>
</Response>

chat/info

Getting of chat messages from Live event.

Input parameters

Required parameters:

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

Optional parameters:

  • Date start Start date as YYYY-MM-DD, for example 2020-01-01. A week ago from the end date by default.
  • Date end End date as YYYY-MM-DD, for example 2020-05-01. Current date by default.
  • String order (Sort of output) Options of sorting are: asc (to increase), desc (to decrease). By default is asc.
  • Integer page Page of output. By default is page=1

Sample query:

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

Sample response:

<Response>
   <Period>01.01.2019 - 10.05.2020</Period>
   <Start>01.01.2019</Start>
   <End>10.05.2020</End>
   <Page>1</Page>
   <PageLimit>1000</PageLimit>
   <PageCount>1</PageCount>
   <ItemCount>1</ItemCount>
   <ItemFormat>
      <date>Date</date>
      <code>Message code</code>
      <nickname>Nickname</nickname>
      <identity>Identity of user</identity>
      <message>Message</message>
   </ItemFormat>
   <Items>
      <Item>
         <date>2020-05-21 02:40:15</date>
         <code>TBcPNylXveGc9TGUX0piOmPg6Av0Wman</code>
         <nickname>Alexander</nickname>
         <identity>customer@email.com</identity>
         <message>test</message>
      </Item>
   </Items>
   <Status>Success</Status>
</Response>

chat/deleteMessage

Remove a chat message from Live event.

Input parameters

Required parameters:

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

Sample query:

https://boomstream.com/api/chat/deleteMessage?apikey=[API_KEY]&code=XXXXXXXX&message=TBcPNylXveGc9TGUX0piOmPg6Av0Wman

Sample response:

<Response>
   <Message>Chat message is removed from history</Message>
   <Status>Success</Status>
</Response>