SendAgentConversationMessage - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Sends an agent diagnostic message.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/conversations/{conversationId}/messages HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The diagnostic message request.	{"message":"Why do messages keep accumulating?","executionProfile":"standard"}
messageType	string	No	The special message type. Set to ticket_request to request the agent to draft a ticket. Omit this parameter for normal questions and draft corrections. The ticket is reviewed and submitted by the frontend.	ticket_request
ticketRequestId	string	No	The unique identifier of the ticket request. Pass this parameter in pairs with messageType. The value must be 1 to 64 characters in length and can contain letters, digits, underscores, and hyphens.	ticket-request-example-001
message	string	Yes	The user diagnostic question. You must specify at least one of the message, images, and attachments parameters.	Why do messages keep accumulating in the rmq-cn-example instance?
clientContext	string	No	The supplementary context provided by the caller.	The alert time is 2026-08-19 19:30:00
images	array<object>	No	The images sent with the message. You can send up to two images. The recommended maximum size for each original image is 2 MiB.
	object	No
mediaType	string	Yes	The media type of the image.	image/png
dataBase64	string	Yes	The Base64-encoded data of the image, excluding the data URL prefix.	iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVR4nGNgAAIAAAUAAXpeqz8AAAAASUVORK5CYII=
attachments	array<object>	No	The client logs uploaded for the current session. You can attach up to five logs. Call the UploadAgentConversationLog operation first, and then pass the returned name, path, and size exactly as they are.
	object	No
kind	string	Yes	The type of the attachment. Set the value to client_log.	client_log
fileName	string	Yes	The file name returned by the upload operation.	client.log
sandboxPath	string	Yes	The session-relative reference returned by the upload operation.	client-logs/0198c8a91f4d7f01a3c21e99/client.log
sizeBytes	integer	Yes	The file size returned by the upload operation, in bytes.	114
keptLines	integer	No	The number of retained lines after trimming.	2
totalLines	integer	No	The total number of lines in the original log.	2
timeRangeStart	string	No	The start time of the trimmed range, in ISO 8601 format with time zone.	2026-09-12T10:00:00+08:00
timeRangeEnd	string	No	The end time of the trimmed range, in ISO 8601 format with time zone.	2026-09-12T11:00:00+08:00

Response elements

Element	Type	Description	Example
	string	The Server-Sent Events (SSE) diagnostic event stream.	event: text_delta\\ndata: {"type":"text_delta","content":"Troubleshooting"}

Examples

Success response

JSON format

"event: text_delta\\\\ndata: {\"type\":\"text_delta\",\"content\":\"Troubleshooting\"}"

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.