Qoder CN シリーズ:セッションの一覧表示

リクエストヘッダー

ヘッダー	必須	説明
Authorization	はい	Bearer <PAT>

クエリパラメーター

パラメーター	型	必須	デフォルト	説明
identity_ids	string | array	いいえ	-	1 つ以上のアイデンティティ ID でフィルタリングします。カンマ区切りの文字列に対応しています。
template_id	string	いいえ	-	フォワードテンプレート ID でフィルタリングします。
source_type	string	いいえ	-	api、im、または schedule でフィルタリングします。
created_at[gt]	string	いいえ	-	この RFC 3339 タイムスタンプより後に作成されたレコードを取得します。
created_at[gte]	string	いいえ	-	この RFC 3339 タイムスタンプ以降に作成されたレコードを取得します。
created_at[lt]	string	いいえ	-	この RFC 3339 タイムスタンプより前に作成されたレコードを取得します。
created_at[lte]	string	いいえ	-	この RFC 3339 タイムスタンプ以前に作成されたレコードを取得します。
updated_at[gt]	string	いいえ	-	この RFC 3339 タイムスタンプより後に更新されたレコードを取得します。
updated_at[gte]	string	いいえ	-	この RFC 3339 タイムスタンプ以降に更新されたレコードを取得します。
updated_at[lt]	string	いいえ	-	この RFC 3339 タイムスタンプより前に更新されたレコードを取得します。
updated_at[lte]	string	いいえ	-	この RFC 3339 タイムスタンプ以前に更新されたレコードを取得します。
limit	整数	いいえ	20	1 ページあたりのアイテム数。最大 100 です。
after_id	string	いいえ	-	指定されたセッション ID より後のレコードを取得するためのカーソル。before_id とは併用できません。
before_id	string	いいえ	-	指定されたセッション ID より前のレコードを取得するためのカーソル。after_id とは併用できません。
order	string	いいえ	desc	並び順： desc または asc。
include_archived	boolean	いいえ	false	アーカイブ済みのセッションを含めます。

リクエスト例

curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/sessions?identity_ids=idn_xxx,idn_yyy&template_id=tmpl_support&source_type=im&created_at[gte]=2026-06-01T00:00:00Z&limit=20' \
  -H "Authorization: Bearer $QODER_PAT"

レスポンス例

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",
      "incremental_streaming_enabled": true,
      "metadata": {
        "source": "dingtalk"
      },
      "config": {
        "environment_variables": {
          "API_KEY": "sk-xxx"
        }
      },
      "stats": {
        "active_seconds": 30,
        "duration_seconds": 3600
      },
      "usage": {
        "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
}

レスポンスフィールド

フィールド	型	説明
data	array	現在のページのセッションオブジェクト。
first_id	string | null	このページの最初のレコードの ID。
last_id	string | null	このページの最後のレコードの ID。
has_more	boolean	さらにレコードが残っているかどうか。

エラー

HTTP	タイプ	コード	トリガー
400	invalid_request_error	invalid_time_range	時間フィルターが無効です。
400	invalid_request_error	invalid_pagination	ページネーションパラメーターが無効です。
401	authentication_error	authentication_required	PAT が無効または期限切れです。

注意事項

• after_id と before_id は併用できません。

• 現在の設計では、status によるフィルタリングはサポートされていません。

• クレジットモジュールが有効でない場合、usage.credits は省略される可能性があります。

関連 API

• Create Session

• Get Session