PageQueryAgentListNew-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Queries the agent list by paging (managed pattern V2).

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

aiccs:PageQueryAgentListNew

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentName	string	No	The agent name.	Intelligent Customer Service Assistant
AgentId	string	No	Agent ID	12345
PageIndex	integer	No	The page number. [Deprecated] Use PageNo instead.	1
PageSize	integer	No	The number of entries per page.	20
PageNo	integer	No	The page number.	1
IsAvailable	boolean	No	Specifies whether the agent is available for outbound calls. A value of True indicates that the currently deployed branch of the agent has a published version and is available for outbound calls.	true

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	Access denied due to insufficient permissions
RequestId	string	The request ID.	12345678-1234-1234-1234-123456789012
Message	string	The description of the status code.	success
Data	object	The returned data.
PageSize	integer	The page size.	41
Total	integer	The total number of records.	6
PageNo	integer	The current page number.	28
List	array<object>	The data list.
	object	The data list.
DeployBranchName	string	The name of the active branch.	master
ModifyTime	string	The last modification time, in the format of YYYY-MM-DD HH:mm:ss.	2024-01-15 10:30:00
Description	string	The agent description.	Intelligent customer service assistant that provides automated customer service support
AgentMode	integer	The agent building mode. Valid values: 0: prompt mode (PROMPT). 1: dialog flow mode (CONVERSATION).	0
CreateTime	string	The creation time, in the format of YYYY-MM-DD HH:mm:ss.	2024-01-20 12:00:00
EffectiveVersionId	integer	The ID of the active version.	71
Scene	string	The scenario.	Personal lead conversion
ApplicationCode	string	The application code.	aicc_demo_app
DeployBranchId	integer	The ID of the deployed branch.	24
LatestPublishTime	string	The latest version publish time, in the format of YYYY-MM-DD HH:mm:ss.	2024-01-20 12:00:00
IsAvailable	boolean	Indicates whether the agent is available for outbound calls. A value of True indicates that the currently deployed branch of the agent has a published version and is available for outbound calls.	true
AgentId	integer	The agent ID.	51
AgentName	string	The agent name.	Intelligent Customer Service Assistant
EffectiveVersionName	string	The name of the active version.	v1.0.0
Code	string	The status code.	OK
Success	boolean	Indicates whether the API call was successful. true: Successful. false: Failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "Access denied due to insufficient permissions",
  "RequestId": "12345678-1234-1234-1234-123456789012",
  "Message": "success",
  "Data": {
    "PageSize": 41,
    "Total": 6,
    "PageNo": 28,
    "List": [
      {
        "DeployBranchName": "master",
        "ModifyTime": "2024-01-15 10:30:00",
        "Description": "智能客服助手，提供自动化的客户服务支持",
        "AgentMode": 0,
        "CreateTime": "2024-01-20 12:00:00",
        "EffectiveVersionId": 71,
        "Scene": "个人线索转化",
        "ApplicationCode": "aicc_demo_app",
        "DeployBranchId": 24,
        "LatestPublishTime": "2024-01-20 12:00:00",
        "IsAvailable": true,
        "AgentId": 51,
        "AgentName": "智能客服助手",
        "EffectiveVersionName": "v1.0.0"
      }
    ]
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.