GetChatSessionList - Energy Expert - Alibaba Cloud Documentation Center

Retrieves a list of a user's Q&A sessions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

energy:GetChatSessionList

none

*All Resource

*

None

Request syntax

POST /api/v2/aidoc/document/chat/session/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
name	string	No	The session name.	oklabs
userId	string	No	The unique ID of the user. If this parameter is left empty, the ID of the account that calls the SDK is used by default.	12222
currentPage	integer	No	The page number for paging. The default value is 1.	1
pageSize	integer	No	The number of entries per page. The default value is 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
sessionList	array<object>	The list of sessions.
	object
sessionId	string	The ID of the Q&A session. This ID is used to track multiple Q&A pairs for the same user.	5c748ef9-3f23-4b5a-916f-966c0d2c6dcd
name	string	The session name.	student_app_spelling
userId	string	The user ID for the current session.	12222
folderId	string	The ID of the folder. This specifies the scope of documents for the query.	3493370b-4884-47dd-95ed-49038769af53
createTime	integer	The timestamp when the session was created. This is a UNIX timestamp in milliseconds.	2025-01-01T14:45:17Z
updateTime	integer	The timestamp of the last update. This is a UNIX timestamp in milliseconds.	2024-12-30T02:05:03Z
total	integer	The total number of records.	21
totalPage	integer	The total number of pages.	3
currentPage	integer	The current page number.	1
pageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
  "data": {
    "sessionList": [
      {
        "sessionId": "5c748ef9-3f23-4b5a-916f-966c0d2c6dcd",
        "name": "student_app_spelling",
        "userId": "12222",
        "folderId": "3493370b-4884-47dd-95ed-49038769af53",
        "createTime": 0,
        "updateTime": 0
      }
    ],
    "total": 21,
    "totalPage": 3,
    "currentPage": 1,
    "pageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.