チャットボット所属ルーム一覧取得API

チャットボット所属ルーム一覧取得APIは、チャットボットが所属しているルームの一覧を取得するAPIです。

リクエスト内容

フィールド名	フィールド値	備考
action	list_assign_rooms	必須 「チャットボット所属ルーム一覧取得API」であることを示します。
access_token	APIアクセスキー	必須 チャットボットの作成方法はこちらを参照してください。
target	日時｜unread	任意 未指定時：絞り込みなし サーバー時間(UTC)を基準に、指定した日時以降にメンバーとなったルームで絞り込むことができます。 ※ 日時は2026-01-23T09:00:00の形式で指定してください。 未読のあるルームのみを取得したい場合は、unreadを指定してください。
limit	1～100の数値	任意 未指定時：100 最大取得件数を指定できます。 0以下の値や100より大きい値を指定した場合は100として扱われます。
offset	0以上の数値	任意 未指定時：0 取得開始位置を指定できます。
room_name	検索したい文字列	任意 未指定時：検索条件なし ルーム名を部分一致で検索できます。

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

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

制限事項ページ

リクエストの例

curl -X POST "https://your.domain/cgi-bin/chatlk/chatBot.cgi"
-F "action=list_assign_rooms"
-F "access_token=(APIアクセスキー)"
-F "target=2026-01-23T09:00:00"
-F "limit=10"

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

レスポンス内容

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

ルーム情報1件の内容

フィールド名	フィールド値、意味
id	ルームのシステムID
name	ルーム名
memo	ルーム詳細
unread_count	ルームの未読数

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

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

レスポンス内容の例

// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2026-04-10T09:00:00",
  "offset": "0",
  "all_count": "100",
  "list": {
    "item": [
      {
        "id": "1z68b0kdhr5z",
        "name": "テストルーム",
        "memo": "テストルームの詳細",
        "unread_count": "0"
      },
      // 以降は省略
    ]
  }
}