Listar sessões - Qoder CN Series: Central de Documentação do Alibaba Cloud

Liste sessões de Forward com filtros e paginação por cursor.

Cabeçalhos da requisição

Cabeçalho	Obrigatório	Descrição
`Authorization`	Sim	`Bearer <PAT>`

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`identity_ids`	string ou array	Não	-	Filtra por um ou mais Identity IDs. Aceita strings separadas por vírgula.
`template_id`	string	Não	-	Filtra pelo ID do Forward Template.
`source_type`	string	Não	-	Filtra por `api`, `im` ou `schedule`.
`created_at[gt]`	string	Não	-	Criação estritamente posterior a este timestamp RFC 3339.
`created_at[gte]`	string	Não	-	Criação igual ou posterior a este timestamp RFC 3339.
`created_at[lt]`	string	Não	-	Criação estritamente anterior a este timestamp RFC 3339.
`created_at[lte]`	string	Não	-	Criação igual ou anterior a este timestamp RFC 3339.
`updated_at[gt]`	string	Não	-	Atualização estritamente posterior a este timestamp RFC 3339.
`updated_at[gte]`	string	Não	-	Atualização igual ou posterior a este timestamp RFC 3339.
`updated_at[lt]`	string	Não	-	Atualização estritamente anterior a este timestamp RFC 3339.
`updated_at[lte]`	string	Não	-	Atualização igual ou anterior a este timestamp RFC 3339.
`limit`	integer	Não	20	Itens por página. Máximo: 100.
`after_id`	string	Não	-	Cursor para registros posteriores ao Session ID informado. Incompatível com `before_id`.
`before_id`	string	Não	-	Cursor para registros anteriores ao Session ID informado. Incompatível com `after_id`.
`order`	string	Não	`desc`	Ordem de classificação: `desc` ou `asc`.
`include_archived`	boolean	Não	`false`	Inclui sessões arquivadas.

Exemplo de requisição

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"

Exemplo de resposta

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
}

Campos da resposta

Campo	Tipo	Descrição
`data`	array	Objetos de sessão na página atual.
`first_id`	string	null	ID do primeiro registro nesta página.
`last_id`	string	null	ID do último registro nesta página.
`has_more`	boolean	Indica se há mais registros disponíveis.

Erros

HTTP	Tipo	Código	Gatilho
400	`invalid_request_error`	`invalid_time_range`	Filtros de tempo inválidos.
400	`invalid_request_error`	`invalid_pagination`	Parâmetros de paginação inválidos.
401	`authentication_error`	`authentication_required`	PAT inválido ou expirado.

Observações

Os parâmetros after_id e before_id são mutuamente exclusivos.
O design atual não oferece suporte a filtragem por status.
O campo usage.credits pode ser omitido caso o módulo de créditos não esteja ativado.

Cabeçalhos da requisição

Parâmetros de consulta

Exemplo de requisição

Exemplo de resposta

Campos da resposta

Erros

Observações

APIs relacionadas