即时通信 IM 发送流式消息-智能客服-文档中心-腾讯云

接口调用说明
App 管理员可以通过该接口给用户发送流式消息。用户转人工后，人工客服也能看到该消息。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/send_stream_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/desk_http_svc/send_stream_msg
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
请求包示例
首次调用：
{
    "SessionId": "fd8a2e30-54de-4e40-bcaf-02718409c5cf",    //标识会话的ID
    "Chunk": "Hello, "      //消息内容
}
首次响应：
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MsgKey": "124_1600045926_716f784b2bbd6ce9415027715"  //返回的消息标识，后续调用需要传递此参数
}

后续调用追加文本：
{
    "SessionId": "fd8a2e30-54de-4e40-bcaf-02718409c5cf",
    "Chunk": "this is ",
    "MsgKey": "124_1600045926_716f784b2bbd6ce9415027715"
}
最后一次调用：
{
    "SessionId": "fd8a2e30-54de-4e40-bcaf-02718409c5cf",
    "Chunk": "Tencent Cloud.",
    "MsgKey": "124_1600045926_716f784b2bbd6ce9415027715",
    "Finish": 1    //此字段为1，标识流式消息结束
}
请求包字段说明
字段
类型
属性
说明
SessionId
String
必填
会话 ID
Chunk
String
必填
消息内容
MsgKey
String
选填
首次调用 API 时不填，从第二次开始调用需要填写
Finish
Integer
选填
最后一次调用时，此字段为1，标识该流式输出已结束
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
应答包字段说明
字段
类型
说明
ErrorCode
Integer
错误码：
0表示成功
非0表示失败
ErrorInfo
String
错误信息
ActionStatus
String
请求处理的结果
MsgKey
String
返回消息的唯一标识，用于后续文本输出
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
20001
请求包非法
20002
UserSig 或 A2 失效
20003
消息发送方或接收方 UserID 无效或不存在，请检查 UserID 是否已导入即时通信 IM
20004
网络异常，请重试
20005
服务器内部错误，请重试
20006
触发发送单聊消息之前回调，App 后台返回禁止下发该消息
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范
90002
JSON 格式请求包中 MsgBody 不符合消息格式描述，或者 MsgBody 不是 Array 类型，请参见 TIMMsgElement 对象 的定义
90005
JSON 格式请求包体中缺少 MsgRandom 字段或者 MsgRandom 字段不是 Integer 类型
90007
JSON 格式请求包体中 MsgBody 类型不是 Array 类型，请将其修改为 Array 类型
90009
请求需要 App 管理员权限
90010
JSON 格式请求包不符合消息格式描述，请参见 TIMMsgElement 对象 的定义
93000
JSON 数据包超长，消息包体请不要超过12k
141000
非智能客服的应用不允许调用此接口接口
141002
系统内部错误，请重试
141004
请求参数非法，请检查后重试
141005
该会话不存在
141006
SessionID 非法
接口调试工具
通过 REST API 在线调试工具 调试本接口。

参数	说明
v4/desk_http_svc/send_stream_msg	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
SessionId	String	必填	会话 ID
Chunk	String	必填	消息内容
MsgKey	String	选填	首次调用 API 时不填，从第二次开始调用需要填写
Finish	Integer	选填	最后一次调用时，此字段为1，标识该流式输出已结束

错误码	描述
20001	请求包非法
20002	UserSig 或 A2 失效
20003	消息发送方或接收方 UserID 无效或不存在，请检查 UserID 是否已导入即时通信 IM
20004	网络异常，请重试
20005	服务器内部错误，请重试
20006	触发发送单聊消息之前回调，App 后台返回禁止下发该消息
90001	JSON 格式解析失败，请检查请求包是否符合 JSON 规范
90002	JSON 格式请求包中 MsgBody 不符合消息格式描述，或者 MsgBody 不是 Array 类型，请参见 TIMMsgElement 对象的定义
90005	JSON 格式请求包体中缺少 MsgRandom 字段或者 MsgRandom 字段不是 Integer 类型
90007	JSON 格式请求包体中 MsgBody 类型不是 Array 类型，请将其修改为 Array 类型
90009	请求需要 App 管理员权限
90010	JSON 格式请求包不符合消息格式描述，请参见 TIMMsgElement 对象的定义
93000	JSON 数据包超长，消息包体请不要超过12k
141000	非智能客服的应用不允许调用此接口接口
141002	系统内部错误，请重试
141004	请求参数非法，请检查后重试
141005	该会话不存在
141006	SessionID 非法

发送流式消息

本页目录：

接口调用说明

请求 URL 示例

请求参数说明

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具