OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

Upload stream-message content

Copy

Continuously write UTF-8 output from a model or business service to the same stream message.

HTTP request

PUT {API_ADDRESS}/msg/append_stream_msg?conversationID={CONVERSATION_ID}&clientMsgID={CLIENT_MSG_ID}&operationID={OPERATION_ID}

Request example

curl --request PUT "${API_ADDRESS}/msg/append_stream_msg?conversationID=si_user_001_user_002&clientMsgID=client_msg_001&operationID=${OPERATION_ID}" \
  --header "Content-Type: text/plain; charset=utf-8" --header "token: ${TOKEN}" \
  --data-binary 'Generated response content'

Request parameters

ParameterLocationRequiredTypeDescription
conversationIDQuery or headerYesstringConversation containing the stream message.
clientMsgIDQuery or headerYesstringClient message ID of the stream message.
operationIDQuery or headerYesstringUnique trace ID for this request.
tokenHeaderYesstringValid user or administrator token.
bodyBodyYesbytesUTF-8 stream-message content.

Response

The server returns write results as a stream. Handle interrupted connections and partial writes; do not retry a chunk until its state is known.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • The body must be valid UTF-8.
  • conversationID and clientMsgID must identify the same appendable stream message.