tencent cloud

Chat

제품 소개
제품 개요
Basic Concepts
응용 시나리오
기능 소개
계정 시스템
사용자 정보 및 관계망
메시지 관리
그룹 시스템
Official Account
Audio/Video Call
사용 제한
구매 가이드
과금 개요
요금 안내
Purchase Instructions
Renewal Guide
연체 안내
Refund Policy
다운로드 센터
SDK & Demo 소스 코드
업데이트 로그
시나리오 솔루션
Live Streaming Setup Guide
AI Chatbot
대규모 엔터테인먼트 협업 커뮤니티
Discord 구현 가이드
IM을 게임에 통합하는 방법
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
클라이언트 APIs
SDK API(Web)
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
서버 APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
콘솔 가이드
New Console Introduction
애플리케이션 생성 및 업그레이드
기본 설정
기능 설정
계정 관리
그룹 관리
Official Channel Management
콜백 설정
모니터링 대시보드
Viewing Guide for Resource Packages
Real-Time Monitor
개발 보조 툴
액세스 관리
Advanced Features
FAQ
uni-app FAQs
구매
SDK 관련 질문
계정 인증
사용자 정보 및 관계망
메시지
그룹
라이브 방송 그룹
닉네임 및 프로필 사진
협약 및 인증
Service Level Agreement
컴플라이언스 인증
IM 정책
개인 정보 보호 정책
데이터 개인 정보 보호 및 보안 계약
에러 코드
문의하기
문서Chat서버 APIsRESTful APIsChatbotsSending a streaming response message

Sending a streaming response message

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-23 15:21:55

Feature Overview

Send streaming response messages to the robot via this API.
For a complete text, you may need to call this API multiple times to output the parts sequentially to the client.
On the first call to this API, the backend generates a MsgKey to represent the message this time. Subsequent calls require transmitting the MsgKey as parameter to the IM server.
If the App uses TUIKit version 7.7.5282 or higher, it can automatically display streaming output message effect.
If the App does not use TUIKit, it needs to manually display the streaming output effect according to the streaming text output protocol.

API Calling Description

Sample Request URL

https://xxxxxx/v4/openim_robot_http_svc/send_stream_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, refer to REST API introduction.
Parameter
Description
xxxxxx
The dedicated domain name for the country/region where the SDKAppID resides:
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Tokyo：adminapijpn.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/openim_robot_http_svc/send_stream_msg
Request API.
sdkappid
SDKAppID assigned by the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see app admin.
usersig
Signature generated by the App administrator account. For details, see generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0, 4294967295].
contenttype
The request format is fixed as json.

Maximum Call Frequency

200 times/second.

Sample Request

First time sending streaming text.
{
    "From_Account": "@RBT#my_bot",
    "To_Account": "user01",
    "Chunk": "hello, "
}
Subsequent API calls continue output text.
{
    "From_Account": "@RBT#my_bot",
    "To_Account": "user01",
    "Chunk": "world",
    "MsgKey": "606781340_3986845397_1706000918",
    "Finish": 1
}

Request Fields

Field
Type
Attribute
Description
From_Account
String
Required
sender UserID (used to specify the message sender account).
To_Account
String
Required
message receiver UserID.
Chunk
String
Required
A segment of text in the streaming text message.
MsgKey
String
Optional.
Leave it blank when calling the API for the first time. From the second call onward, this field must be included.
Finish
Integer
Optional.
On the last call, flag the streaming output as ended.

Sample Response

normal response
{
    "ActionStatus":"OK",
    "ErrorInfo":"",
    "ErrorCode":0,
    "MsgKey":"606781340_3986845397_1706000918"
}

Response Fields

Field
Type
Description
ActionStatus
String
Request processing result:
OK: means processing is successful.
FAIL: means processing failed.
ErrorCode
Integer
Error Code:
0: success.
Non-zero: Indicates Failure.
ErrorInfo
String
Error message.
MsgKey
String
The unique message identifier returned by the IM backend is used for follow-up text output.

Error Codes

Unless a network error occurs (such as 502), the HTTP return code of this API is 200. The actual error code and error information are in the ErrorCode and ErrorInfo fields of the response payload.
Common error codes (60000 to 79999), see the Error Code document.
Private error codes of this API are as follows:
Error Code
Description
10002
Internal system error, please retry.
10004
Incorrect parameter. Please check the request parameters.

API Debugging Tool

Debug this API through the REST API online debugging tool.

References

Query account (v4/im_open_login_svc/account_check)
Set profile (v4/profile/portrait_set)
이전 주제: Getting Server IP Addresses다음 주제: Pulling Chatbot Accounts

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백