チャット

チャットを操作するための API です。

チャットは Comet 通信(ロングポーリング)により実現しています。

サイボウズ Live API では、追加されたチャットコメントを待ち受けるためのロングポーリング通信を Pull 通信と呼びます。 また、チャットコメントを投稿するための通信を Push 通信と呼びます。

詳細は、それぞれ チャット Pull(準備中) チャット Push を参照してください。

リクエスト

エンドポイント

  • https://api.cybozulive.com/api/mpChat/V2

利用可能な HTTP メソッド

GET, POST

必須パラメータ

  • chat-type - チャットを指定します。”THEME” または “DIRECT” が指定可能です。id パラメータを指定している場合のみ必須パラメータではありません。

オプションパラメータ

  • chat-member - 絞り込みメンバーの ID を指定します。
  • start-index - コレクションを取得する場合のインデクスを指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • id - 取得対象の ID を指定します。ID を指定した場合はインデクスなどの絞込み条件は無視されます。

レスポンス

要素 説明
/feed/entry/cbl:who 宛先。
/feed/entry/cblChat:muted ミュートかどうか。
/feed/entry/cblChat:type チャット種別。”THEME” または “DIRECT”。

ミュートの ON/OFF を変更する

チャットのミュートの ON/OFF を変更します。 メンバーごとに持つ設定のため、操作は “update_setting” を指定します。

要素 説明
/feed/entry/id 変更するチャットの ID を指定します。(必須)
/feed/entry/cblChat:muted ミュートかどうかです。”true” または “false” が指定可能です。(必須)

Examples

リクエストの例:

POST /api/mpChat/V2
Content-Type: application/atom+xml
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblChat="http://schemas.cybozulive.com/chat/2010">
  <cbl:operation type="update_setting"/>
  <entry>
    <id>MYPAGE,1:1,MP_CHAT,1:2</id>
    <cblChat:muted>true</cblChat:muted>
  </entry>
</feed>