Skip to main content
Sessions

列出 Sessions

按筛选条件分页列出 Forward Session。

GET /api/v1/forward/sessions 返回当前账号下的 Session 列表,默认按创建时间倒序排列;归档 Session 默认不返回。

请求头

Header是否必填说明
AuthorizationBearer <PAT 或 SAT>

查询参数

参数类型是否必填默认值说明
identity_idsstring或array-按一个或多个 Identity ID 过滤,支持逗号分隔。
template_idstring-按 Forward Template ID 过滤。
source_typestring-apiimschedulebatch 过滤。
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 时间。
limitinteger20分页大小,最大 100。
after_idstring-向后翻页游标,传入上一页响应的 last_id
before_idstring-向前翻页游标,传入当前页响应的 first_id
orderstringdesc创建时间排序方向:descasc
include_archivedbooleanfalse是否包含已归档 Session。

示例请求

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"

示例响应

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
}

响应字段

字段类型说明
dataarray当前页的 Session 对象。
first_idstringnull
last_idstringnull
has_moreboolean是否还有更多记录。

错误

HTTPTypeCode触发条件
400invalid_request_errorinvalid_time_range时间筛选范围不合法。
400invalid_request_errorinvalid_time_filter时间筛选格式不合法。
400invalid_request_errorinvalid_pagination分页参数不合法。
400invalid_request_errorinvalid_limitlimit 不合法或超过最大值。
400invalid_request_errorinvalid_orderorder 不是 ascdesc
401authentication_errorauthentication_requiredPAT 或 SAT 无效或已过期。

备注

  • after_idbefore_id 不能同时传入。
  • 列表按 created_at 排序;创建时间相同时按 Session ID 同方向排序,保证分页稳定。
  • 连续翻页时应保持相同的筛选条件和 order
  • 当前设计不支持按 status 筛选。
  • usage.total_credits 仅新创建的 Session 返回;历史 Session 可能会省略。

相关