ListAIAgentInstance - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of AI agents.

Operation description

Request description

You can call this operation to query a list of AI agents based on the AIAgentId. The optional parameters include StartTime, EndTime, PageSize, and PageNumber. The returned result includes the status, runtime configurations, template configurations, custom information, and the URL of call log file for each AI agent.

Note:

The default value of PageSize is 10, and the default value of PageNumber is 1.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListAIAgentInstance	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AIAgentId	string	Yes	The ID of the AI agent.	39f8e0bc005e4f309379701645f4***
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter does not have a default value.	2023-01-01T00:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter does not have a default value.	2023-01-02T00:00:00Z
PageSize	long	No	The number of entries per page. Default value: 10. Valid values: 0 to 100.	10
PageNumber	long	No	The page number. Default value: 1. Valid values: 1 to 100.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Instances	array<object>	The list of the AI agents.
Instances	object
CallLogUrl	string	The URL of the call log file for the AI agent. The structure of the file is CallLog in the JSON format.	https://example.com/call_logs/12345.json
RuntimeConfig	AIAgentRuntimeConfig	The runtime configurations of the AI agent.	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Status	string	The state of the instance. Valid values: Executing Finished	Finished
TemplateConfig	AIAgentTemplateConfig	The template configurations of the AI agent.	{"VoiceChat": {"VoiceId": "zhixiaoxia"}}
UserData	string	The custom information.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
RequestId	string	The request ID.	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Examples

Sample success responses

JSONformat

{
  "Instances": [
    {
      "CallLogUrl": "https://example.com/call_logs/12345.json",
      "RuntimeConfig": {
        "VoiceChat": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "VisionChat": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "ChannelId": "70f22d5784194938a7e387052f2b3208\n",
        "AvatarChat3D": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        }
      },
      "Status": "Finished",
      "TemplateConfig": {
        "VoiceChat": {
          "Greeting": "",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": ""
            }
          ],
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": {},
          "EnableIntelligentSegment": true,
          "AvatarUrlType": "USER",
          "BailianAppParams": {},
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "AvatarUrl": "http://example.com/a.jpg",
          "WakeUpQuery": "",
          "AppId": "",
          "Volume": 100,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "GracefulShutdown": true,
          "EnablePushToTalk": false
        },
        "MessageChat": {
          "AppId": ""
        },
        "VisionChat": {
          "Greeting": "Good morning, my friend!\n",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": ""
            }
          ],
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": {},
          "EnableIntelligentSegment": true,
          "BailianAppParams": {},
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "WakeUpQuery": "",
          "AppId": "",
          "Volume": 100,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "GracefulShutdown": false,
          "EnablePushToTalk": false
        },
        "AvatarChat3D": {
          "Greeting": "",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": ""
            }
          ],
          "UserOnlineTimeout": 60,
          "UserOfflineTimeout": 5,
          "WorkflowOverrideParams": {},
          "EnableIntelligentSegment": true,
          "BailianAppParams": {},
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "WakeUpQuery": "",
          "AppId": "",
          "Volume": 100,
          "AvatarId": 1231,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "GracefulShutdown": true,
          "EnablePushToTalk": false
        }
      },
      "UserData": {
        "Email": "johndoe@example.com",
        "Preferences": {
          "Language": "en"
        }
      }
    }
  ],
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Error codes

For a list of error codes, visit the Service error codes.