DescribeBeebotIntent-阿里云帮助中心

Retrieves the intent in a small model scenario.

Operation description

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:DescribeBeebotIntent

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	e5035654-1745-484a-8c5b-165f7c7bcd79
ScriptId	string	Yes	The scenario ID.	c5c5d8c0-c0f1-48a7-be2b-dc46006d888a
IntentId	integer	Yes	The intent ID.	10717802

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request is successful.	true
BeebotRequestId	string	The internal request ID.	0B219FCB-EC71-1F08-BB1B-0E87C20158C8
Code	string	The API status code.	OK
Message	string	The API message.	Success
IntentId	integer	The intent ID.	10717802
Intent	object	The intent information.
IntentId	integer	The intent ID.	10717802
IntentName	string	The intent name.	Got it
AliasName	string	The intent alias.	Okay, got it
CreateUserName	string	The username of the creator.	xxx@voice-navigator-testonaliyun.com
CreateUserId	string	The ID of the creator.	1252504
ModifyUserId	string	The ID of the modifier.	1252504
ModifyUserName	string	The username of the modifier.	xxx@voice-navigator-testonaliyun.com
CreateTime	string	The creation time. The format is YYYY-MM-DD HH:mm:ss.+ZZZZ, where +ZZZZ indicates the time zone offset.	2025-04-21 10:29:59.+0800
ModifyTime	string	The modification time. The format is YYYY-MM-DD HH:mm:ss.+ZZZZ, where +ZZZZ indicates the time zone offset.	2025-04-21 15:52:57.+0800

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "BeebotRequestId": "0B219FCB-EC71-1F08-BB1B-0E87C20158C8",
  "Code": "OK",
  "Message": "Success",
  "IntentId": 10717802,
  "Intent": {
    "IntentId": 10717802,
    "IntentName": "知道了",
    "AliasName": "嗯明白了",
    "CreateUserName": "xxx@voice-navigator-testonaliyun.com",
    "CreateUserId": "1252504",
    "ModifyUserId": "1252504",
    "ModifyUserName": "xxx@voice-navigator-testonaliyun.com\n",
    "CreateTime": "2025-04-21 10:29:59.+0800",
    "ModifyTime": "2025-04-21 15:52:57.+0800"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.