tencent cloud

直播 SDK

动态与公告
TUILiveKit 产品动态
云直播推拉流 SDK 产品动态
新手指引
产品简介
产品概述
产品优势
性能数据
基本概念
购买指南
TRTC Live 价格总览
Live 视频直播计费说明
开通服务（TUILiveKit）
Demo 体验
Demo 体验指引
跑通 Demo（TUILiveKit）
接入指南
视频直播
准备工作
主播开播
观众观看
直播列表
语聊房
准备工作
主播开播
观众观看
直播列表
推流助手
推流助手（Electron 桌面应用）
推流助手（Web 桌面浏览器）
直播监播
监播页面（Web 桌面浏览器 React 版）
监播页面（Web 桌面浏览器 Vue 版）
UI 自定义
直播视频组件
视频源编辑组件
观众列表组件
聊天弹幕组件
媒体源配置面板
连麦管理面板
直播送礼组件
无 UI 集成
搭建视频直播
搭建语聊房
功能指南
关注主播（TUILiveKit）
至臻画质（TUILiveKit）
输入媒体流进房（TUILiveKit）
礼物系统（TUILiveKit）
客户端 API
Android
iOS
Web
服务端 API（TUILiveKit）
账号系统
REST API
第三方回调
错误码（TUILiveKit）
常见问题
平台编译
用户鉴权
云直播推拉流 SDK
产品简介
购买指南
Demo 体验
免费测试
SDK 下载
License 管理
高级功能
客户端 API
常见问题
无 UI 集成方案
API 文档
OSS information
OSS Attribution Notice
文档直播 SDK服务端 API（TUILiveKit）REST API消息管理发送自定义消息

发送自定义消息

PDF
聚焦模式
字号
最后更新时间： 2026-03-11 13:34:46

功能说明

App 管理员可以通过该接口发送自定义消息。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
美国：adminapiusa.im.qcloud.com
v4/live_engine_http_srv/send_custom_msg
请求接口。
sdkappid
创建应用时即时通信 Chat 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为json。

最高调用频率

200次/秒。

请求包示例

基础形式

{
    "RoomId":"room1",
    "Sender_Account":"user1",
    "BusinessId":"xxxxx",    
    "Data":"zzzzzzz"
}



请求包字段说明

字段
类型
属性
说明
RoomId
String
必填
房间ID。
Sender_Account
String
选填
消息发送者用户ID。
BusinessId
String
必填
标记发送消息类型
Data
Integer
必填
消息内容

消息格式说明

本接口由即时通信 Chat 在群组中发送普通消息包装而来。此消息包装后请求体 MsgBody 中消息格式对应 自定义消息格式，包装后的请求信息如下：
{
    "MsgBody": [ 
        {
            "MsgContent": {
                "Data": "{\\"BusinessId\\":\\"key\\",\\"Data\\":\\"value\\"}"
            },
            "MsgType": "TIMCustomElem"
        }
    ]
}

其中 Data 中的内容对应发消息请求中的 BusinessId 和 Data 字段组成的 json 字符串信息。消息回调中会用到此请求信息，详细描述见 房间内发言之前回调 和 房间内发言之后回调。

应答包体示例


{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-b6454678e8a647ffa476ec1fee1263d1-O-Seq-2433991",
    "Response": {
        "MsgTime": 1750074537,
        "MsgSeq": 26,
        "MsgDropReason" : "MsgFreqCtrl"
    }
}


应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败。
ErrorCode
Integer
错误码，0表示成功，非0表示失败。
ErrorInfo
String
错误信息。
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。
MsgTime
Integer
消息发送的时间戳，对应后台 server 时间。
MsgSeq
Integer
消息序列号，唯一标识一条消息。
MsgDropReason
String
消息丢弃原因；默认为空，否则表明消息被丢弃的原因，当前只支持消息频控丢弃。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试。
100002
请求参数非法，请根据错误描述检查请求是否正确。
100004
房间不存在
100006
操作权限不足，需要管理员账号操作。
100601
因被禁言而不能发送消息，请检查发送者是否被设置为禁言
100602
发消息的频率超限，请延长两次发消息时间的间隔
100603
消息内容过长，目前最大支持12K字节的消息，请调整消息长度
上一篇: 发送普通消息下一篇: 消息格式描述

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈