SteerAgentConversation - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

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

rocketmq:SteerAgentConversation

none

*All Resource

*

None

Request syntax

POST /api/v1/conversations/{conversationId}/actions/steer HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
conversationId	string	Yes	The session ID.	0198c8a91f4d7f01a3c21e97

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The agent guidance request.	{"commandId":"cmd-20260819-0001","message":"Please check the online status of the consumer group first"}
commandId	string	Yes	The idempotent command ID.	cmd-20260819-0001
message	string	Yes	The appended guidance information for the agent.	Please check the online status of the consumer group first

Response elements

Element	Type	Description	Example
	object
accepted	boolean	Indicates whether the guidance is accepted.	true
messageId	string	The guidance message ID.	msg-20260819-0001

Examples

Success response

JSON format

{
  "accepted": true,
  "messageId": "msg-20260819-0001"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.