Skip to main content
Sessions

セッションの一覧取得

フィルターとカーソルページネーションで Forward セッションを一覧取得します。

GET /api/v1/forward/sessions 認証されたアカウント配下のセッションを一覧取得します。デフォルトでは作成日時の降順で並び、アーカイブ済みのセッションは返されません。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または SAT>

Query parameters

ParameterTypeRequiredDefaultDescription
identity_idsstring or arrayNo-1 つ以上の Identity ID でフィルターします。カンマ区切りの文字列に対応。
template_idstringNo-Forward Template ID でフィルターします。
source_typestringNo-api、im、schedule、または batch でフィルターします。
created_at[gt]stringNo-この RFC 3339 タイムスタンプより後に作成。
created_at[gte]stringNo-この RFC 3339 タイムスタンプ以降に作成。
created_at[lt]stringNo-この RFC 3339 タイムスタンプより前に作成。
created_at[lte]stringNo-この RFC 3339 タイムスタンプ以前に作成。
updated_at[gt]stringNo-この RFC 3339 タイムスタンプより後に更新。
updated_at[gte]stringNo-この RFC 3339 タイムスタンプ以降に更新。
updated_at[lt]stringNo-この RFC 3339 タイムスタンプより前に更新。
updated_at[lte]stringNo-この RFC 3339 タイムスタンプ以前に更新。
limitintegerNo201 ページあたりの件数。最大 100。
after_idstringNo-次ページ用カーソル。前ページのレスポンスの last_id を指定します。
before_idstringNo-前ページ用カーソル。現在のページのレスポンスの first_id を指定します。
orderstringNodesc作成日時のソート順: desc または asc。
include_archivedbooleanNofalseアーカイブ済みのセッションを含めます。

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"
次のページを取得： 
curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions?limit=20&order=desc&after_id=sess_xxx' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK 
{
  "data": [
    {
      "id": "sess_xxx",
      "type": "session",
      "identity_id": "idn_xxx",
      "template": {
        "id": "tmpl_support",
        "type": "template",
        "name": "Support assistant",
        "model": "ultimate",
        "version": 3
      },
      "source_type": "im",
      "status": "idle",
      "title": "Customer support session",
      "metadata": {
        "source": "dingtalk"
      },
      "config": {
        "environment_variables": {
          "API_KEY": "sk-xxx"
        }
      },
      "stats": {
        "active_seconds": 30,
        "duration_seconds": 3600
      },
      "usage": {
        "total_credits": 12.5
      },
      "archived_at": null,
      "created_at": "2026-06-22T10:00:00Z",
      "updated_at": "2026-06-22T11:00:00Z"
    }
  ],
  "first_id": "sess_xxx",
  "last_id": "sess_xxx",
  "has_more": false
}

Response fields

FieldTypeDescription
dataarray現在のページの Session オブジェクト。
first_idstring|nullこのページの最初のレコードの ID。
last_idstring|nullこのページの最後のレコードの ID。
has_morebooleanさらにレコードが残っているかどうか。

Errors

HTTPTypeCodeTrigger
400invalid_request_errorinvalid_time_range時間フィルターが無効。
400invalid_request_errorinvalid_time_filter時間フィルターの形式が無効。
400invalid_request_errorinvalid_paginationページネーションパラメーターが無効。
400invalid_request_errorinvalid_limitlimit が無効、または最大値を超えている。
400invalid_request_errorinvalid_orderorder が asc または desc ではない。
401authentication_errorauthentication_requiredPAT または SAT が無効または期限切れ。

Notes

  • after_id と before_id は併用できません。
  • 一覧は created_at でソートされます。作成日時が同じ場合は Session ID を同じ方向でソートし、安定したページネーションを保証します。
  • ページを続けて取得する場合は、同じフィルター条件と order を維持してください。
  • 現在の設計では status によるフィルタリングはサポートしていません。
  • usage.total_credits は新しく作成された Session にのみ返されます。過去の Session では省略される場合があります。

セッションの作成

セッションの取得

はじめに
Agent の定義
Agent 環境の設定
Agent にタスクを委任する
Agent 連携
Agent コンテキストの管理
アカウント
ベストプラクティス
お知らせ
API リファレンス
セッションの一覧取得 - Qoder