ListAIAgentDialogues API Reference & Parameters - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Lists the history records of a session.

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

ice:ListAIAgentDialogues

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SessionId	string	Yes	The session ID.	f27f9b9be28642a88e18****
RoundLimit	string	No	The conversation round limit. Specifies the number of most recent N rounds of conversation records to return. The value must be a positive integer. This parameter is mutually exclusive with pagination parameters. When this parameter is specified, pagination parameters are ignored.	5
StartTime	integer	Yes	The start UNIX timestamp (inclusive), in milliseconds.	0
EndTime	integer	Yes	The end UNIX timestamp (inclusive), in milliseconds.	17358082464030
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The page size. Maximum value: 100. Default value: 20.	20
Order	string	No	The sort order. Valid values: ASC: ascending order. DESC: descending order. Default value: DESC.	DESC

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7B117AF5-***************
Dialogues	array<object>	The list of conversation records.
	array<object>
DialogueId	string	The unique ID of this dialogue entry.	19de81b3b3d94abda22****
RoundId	string	The conversation round ID.	f27f9b9be28642a88e18****
Producer	string	The producer of this message. Valid values: user: a message produced by the user. agent: a message produced by the agent. Valid values: agent : agent user : user	user
Text	string	The text content of the dialogue.	Hello
ReasoningText	string	The deep thinking text.	I am thinking
AttachedFileList	array<object>	The list of attachments. Contains information about file attachments referenced in the conversation.
	object
Url	string	The URL of the attachment.	https://media.w3.org/2010/05/sintel/trailer.mp3
Id	string	The unique identifier of the attachment.	7B117AF5-***************
Format	string	The format of the attachment, such as mp3, wav, or pdf.	mp3
Type	integer	The attachment type, represented by a numeric value. The meaning of this value is defined by your business logic.	1
Name	string	The file name of the attachment.	MusicDemix
Time	integer	The UNIX timestamp when this dialogue entry was produced, in milliseconds.	1734511087000
Type	string	The type of this message. Valid values: Voice call: greeting: a welcome message. normal: a voice reply. speech: a proactive broadcast. Text conversation: normal: a text reply. announcement: a proactively pushed text message. custom: a custom message.	announcement
Source	string	The source of this message. Valid values: chat: text conversation. call: voice call.	chat
NodeId	string	The node ID. Identifies the flow node that generated this dialogue entry, used to trace which processing node produced the conversation.	e01-cn-to345ikn62o
Extend	string	The extended information. A JSON-formatted extension field used to store additional custom data, such as sentiment labels or intent recognition results.	{\"addTransferLock\":true}

Examples

Success response

JSON format

{
  "RequestId": "7B117AF5-***************",
  "Dialogues": [
    {
      "DialogueId": "19de81b3b3d94abda22****",
      "RoundId": "f27f9b9be28642a88e18****",
      "Producer": "user",
      "Text": "Hello",
      "ReasoningText": "我在思考",
      "AttachedFileList": [
        {
          "Url": "https://media.w3.org/2010/05/sintel/trailer.mp3",
          "Id": "7B117AF5-***************\n",
          "Format": "mp3",
          "Type": 1,
          "Name": "MusicDemix"
        }
      ],
      "Time": 1734511087000,
      "Type": "announcement",
      "Source": "chat",
      "NodeId": "e01-cn-to345ikn62o",
      "Extend": "{\\\"addTransferLock\\\":true}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.