ライブチャット投稿履歴取得API

ホーム

【記事Topへ】

ライブチャット投稿履歴取得APIを利用することで、
過去のライブ開催時のライブチャット履歴を取得することができます。

■JavaScriptによるAPI呼び出し関数書式

loadEqMeta(param)

param：各パラメータをオブジェクト型で生成

■API呼び出しURL

http(s)://api01-platform.stream.co.jp/apiservice/getLiveChatMsgArch/?token=xxxx&各パラメータ

■パラメータ

項目名	必須	説明	フォーマット	デフォルト値
token	○	アカウント（CID）毎に発行されたトークン	文字列	無し
lplid	○	ライブログID	半角数-半角数（例）12-3	無し
type	---	ダウンロードのタイプを指定「text」「file」が指定可能	文字列	file

■レスポンス例：正常時

number,delete,time,soket_id,name,message
1,false,2019/06/17 15:48:54,master,システム,【○○】さんが入室しました
2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました
3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,○○,△△部の○○開いてます。
4,false,2019/06/17 15:49:47,master,システム,【○○】さんが退室しました
5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました
6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです
7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。
8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。
9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね！しました。
10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました

※エラー時は HTTPステータス 404エラーとなります。

■JavaScriptによるAPI呼び出しサンプル

※当サンプルは、弊社一部環境で動作確認をいたしましたが、
　全環境にて動作保障するものではございませんので、予めご了承ください。
　また、当サンプルを使ったお客様ページの構成等はサポート対象外となりますので、
　併せてご理解くださいますようお願いいたします。

HTMLサンプル

<!DOCTYPE html>

<html>

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    <script type="text/Javascript" src="sample.js"></script>

    <script type="text/Javascript">

      function callApi() {

        const param = new Object();

        // lplid
        const lplidString= document.getElementById('lplid').value;
        let lplidArray= "";
        if (lplidString != "") {
          lplidArray = lplidString.split(",");
          }
        param.lplid = lplidArray;

        param.type = document.getElementById('type').value == "" ? null : document.getElementById('type').value;

        loadEqMeta(param);

      }

    </script>

  </head>

  <body>

    <table border="0">

      <p>---API引数---</p>

      <tr>
        <td width="100">lplid:</td>
        <td width="200">
          <input id="lplid" type="text" value=""/>
        </td>
      </tr>

      <tr>
        <td>type:</td>
        <td>
          <select name="type" id="type" value="">
            <option value=""></option>
            <option value="text">text</option>
            <option value="file">file</option>
          </select>
        </td>
      </tr>

    </table>

    <br>

    <form name="test">
      <input type="button" onClick="callApi()" value="getLiveChatMsgArch" />
    </form>

    <br>

  </body>

  <p>---API取得値---</p>

  <iframe id="result" width="100%" height="50%" frameborder="0"></iframe>

</html>

JSサンプル

※下記サンプルコードをご利用になる場合は、「const token = “”;」の「””」の中に、
　EQ管理画面の「契約会社情報」に表示されている「ReadAPIのToken」を追記してください。

　確認方法について詳細は、「ReadAPIを呼び出す方式」
　－「■Token情報確認方法について」をご参照ください。

/**
* jsonp loadEqMeta
* @param param getLiveChatMsgArch
*/

function loadEqMeta(param) {

  // API reference
  const protocol = (window.location.protocol == 'https:' ? 'https://' : 'http://');
  const apiBase = protocol + "api01-platform.stream.co.jp";

  // token
  const token = "";

  // api name
  const apiPathByParam = "/apiservice/getLiveChatMsgArch/";

  // URL create
  let apiUrl = apiBase;
  apiUrl += apiPathByParam;
  apiUrl += "?token=" + token;

  // lplid
  apiUrl += "&lplid=" + param.lplid;

  // type
  apiUrl += (param.type == null) ? "" : "&type=" + param.type;

  // add to header
  const objScript = document.createElement("script");
  objScript.src = apiUrl;
  document.getElementsByTagName("head")[0].appendChild(objScript);

  // iframe
  document.getElementById("result").src = apiUrl;

}

ReadAPIの仕様

■JavaScriptによるAPI呼び出し関数書式

■API呼び出しURL

■パラメータ

■レスポンス例：正常時

■JavaScriptによるAPI呼び出しサンプル

このセクションの記事