ListIntents-阿里云帮助中心

Retrieves intents from the legacy canvas interface.

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

outboundbot:ListIntents

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	af81a389-91f0-4157-8d82-720edd02b66a
ScriptId	string	Yes	The script ID.	b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
Keyword	string	No	A keyword to filter intents.	还款
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	The returned data.
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The status code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
Intents	object	The paginated list of intents.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of intents.	20
List	array<object>	The list of intents.
	object	Details of an intent.
Utterances	string	The user utterances that trigger the intent.	["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]
IntentDescription	string	The description of the intent.	同意还款意图
UpdateTime	integer	The time when the intent was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1578469042851
CreateTime	integer	The time when the intent was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1578469042851
Keywords	string	The keywords of the intent.	["还款"]
ScriptId	string	The script ID.	6ef95fd5-558f-4ee8-af34-b2ede087a87c
IntentId	string	The intent ID.	a8494b35-eefb-4c8a-887b-b60d2f0fa57a
IntentName	string	The intent name.	统一还款

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Intents": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20,
    "List": [
      {
        "Utterances": "[\"ok\",\"好的\",\"好吧\",\"好嘞\",\"可以\",\"行啊\",\"行吧\",\"那行\",\"知道了\",\"我看一下\",\"能的\",\"等会吧\",\"等一下\",\"马上还\",\"等一会\",\"过两天\",\"我会想办法处理\"]",
        "IntentDescription": "同意还款意图",
        "UpdateTime": 1578469042851,
        "CreateTime": 1578469042851,
        "Keywords": "[\"还款\"]",
        "ScriptId": "6ef95fd5-558f-4ee8-af34-b2ede087a87c",
        "IntentId": "a8494b35-eefb-4c8a-887b-b60d2f0fa57a",
        "IntentName": "统一还款"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.