全ルーム一覧取得API

全ルーム一覧取得APIは、システム管理者の権限でルームの一覧を取得するAPIです。

※ 「全ルーム一覧取得API」が利用可能に設定されているAPIアクセスキーを使用する必要があります。

リクエスト内容

フィールド名	フィールド値	備考
action	list_rooms	必須 「全ルーム一覧取得API」であることを示します。
access_token	APIアクセスキー	必須 システム管理者のAPIアクセスキーの取得方法はこちらを参照してください。
limit	1～100の数値	任意 未指定時：100 最大取得件数を指定できます。 0以下の値や100より大きい値を指定した場合は100として扱われます。
offset	0以上の数値	任意 未指定時：0 取得開始位置を指定できます。
room_name	検索したい文字列	任意 未指定時：検索条件なし ルーム名を部分一致で検索できます。
room_state	available	任意 未指定時：絞り込みなし 指定したルームの状態で絞り込むことができます。 利用可能ルームのみを取得したい場合は、availableを指定してください。
order	asc｜desc	任意 未指定時：asc 取得するルームの一覧を並び替えることができます。 昇順の場合はasc、降順の場合はdescを指定してください。 ※ 取得するルームの一覧は、ルーム名順で固定されています。

データ取得に関する制限事項

取得対象のデータ数がlimit未満の場合は、offsetは0になります。
例：limit=100で取得対象のデータ数が80件なら、offset=10と指定しても80件のデータを取得します。

制限事項ページ

リクエストの例

curl -X POST "https://your.domain/cgi-bin/chatlk/managerApi.cgi"
-F "action=list_rooms"
-F "access_token=(APIアクセスキー)"
-F "limit=10"
-F "offset=0"

※ リクエスト先のURLは、お客様の環境に書き換えてください。
　 詳しくはリクエスト先のURLを参照してください。

レスポンス内容

フィールド名	フィールド値、意味
result	ok=成功、ng=失敗
server_time	成功した時のサーバー時間
offset	取得開始行数
all_count	取得したルーム情報の件数
list.item	取得したルーム情報の配列 ※ ルーム情報1件の内容は以下の表を参照してください。

ルーム情報1件の内容

フィールド名	フィールド値、意味
id	ルームのシステムID
name	ルーム名
room_state	available=利用可能、unavailable=利用停止

※ result以外の値はresult=okのときのみ含まれます。

※ result=ngのときのレスポンスについては共通仕様を参照してください。

レスポンス内容の例

// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2025-01-20T12:30:45",
  "offset": "0",
  "all_count": "100",
  "list": {
    "item": [
      {
        "id": "1z68b0kdhr5z",
        "name": "テストルーム",
        "room_state": "available"
      },
      // 以降は省略
    ]
  }
}