动态与公告

产品动态

公告

产品简介

产品概述

基本概念

应用场景

功能介绍

账号系统

用户资料与关系链

消息管理

群组相关

公众号系统

音视频通话 Call

使用限制

购买指南

计费概述

价格说明

购买指引

续费指引

停服说明

退费说明

开发指引

Demo 专区

开通服务

体验 Demo

快速跑通

下载中心

SDK & Demo 源码

更新日志

聊天互动（含 UI）

TUIKit 组件介绍

快速开始

全功能接入

单功能接入

AI 集成

构建基础界面

更多特性

定义外观

国际化界面语言

推送服务（Push）

服务概述

名词解释

开通服务

快速跑通

厂商通道

数据统计

排查工具

客户端 API

服务端 API

推送回调

高级功能

更新日志

错误码

常见问题

智能客服

功能概述

快速入门

集成指引

管理员操作手册

客服操作手册

更多实践

直播间搭建

AI 聊天机器人方案

超大娱乐协作社群

Discord 实现指南

游戏内集成 Chat 指南

类 WhatsApp Channel 搭建方案

发送红包

Chat 应对防火墙限制相关

无 UI 集成

快速开始

集成 SDK

初始化

登录登出

消息相关

会话相关

群组相关

社群话题

用户管理

离线推送

云端搜索

本地搜索

公众号

客户端 API

JavaScript

Android

iOS & macOS

Swift

Flutter

Electron

Unity

React Native

C 接口

C++

服务端 API

生成 UserSig

REST API

第三方回调

控制台指南

新版控制台介绍

创建并升级应用

基本配置

功能配置

账号管理

群组管理

公众号管理

回调配置

用量统计

资源包查看指南

实时监控

开发辅助工具

访问管理

高级功能

常见问题

uni-app 常见问题

购买相关问题

SDK 相关问题

账号鉴权相关问题

用户资料与关系链相关问题

消息相关问题

群组相关问题

直播群相关问题

昵称头像相关问题

协议与认证

服务等级协议

安全合规认证

IM 政策

隐私政策

数据隐私和安全协议

平滑迁移方案

平滑迁移完整版

平滑迁移简化版

错误码

联系我们

单聊机器人消息回调

PDF

聚焦模式

字号

最后更新时间： 2025-04-01 10:25:07

功能说明
App 后台可以通过该回调实时对单聊消息进行操作，包括：
对单聊消息进行实时记录（例如记录日志，或者同步到其他系统）。
对单聊消息进行数据统计（例如人数，消息数等）。
注意事项
要启用回调，必须配置回调 URL，并打开本回调对应的开关，配置方法详见 第三方回调配置。
回调的方向是即时通信 Chat 后台向 App 后台发起 HTTPS POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
若同时开启发单聊消息之前和之后两种回调，且发单聊消息之前回调返回禁止发言，则发单聊消息之后回调将不会被触发。
若同时开启发单聊消息之前和之后两种回调，且发单聊消息之前回调变动了消息体，则发单聊消息之后回调将使用变动过的消息进行回调。
其他安全相关事宜请参见 第三方回调简介：安全考虑 文档。
可能触发该回调的场景
App 用户通过客户端发送单聊消息，且接收方为机器人账号。
App 管理员通过 REST API（sendmsg 接口）发送单聊消息，且接收方为机器人账号。
回调发生时机
即时通信 Chat 后台收到用户发送的单聊消息并将该消息下发给目标用户之后，且该用户判定为机器人账号。
接口说明
请求 URL 示例
以下示例中 App 配置的回调 URL 为 https://www.example.com。
示例：
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
请求参数说明
参数
说明
https
请求协议为 HTTPS，请求方式为 POST。
www.example.com
回调 URL。
SdkAppid
创建应用时在即时通信 Chat 控制台分配的 SDKAppID。
CallbackCommand
固定为 Bot.OnC2CMessage。
contenttype
固定值为 json。
ClientIP
客户端 IP，格式例如：127.0.0.1。
OptPlatform
客户端平台，取值参见 第三方回调简介：回调协议 中 OptPlatform 的参数含义。
请求包示例
{
    "CallbackCommand": "Bot.OnC2CMessage", // 回调命令
    "From_Account": "jared", // 发送者
    "To_Account": "Jonh", // 接收者
    "MsgSeq": 48374, // 消息序列号
    "MsgRandom": 2837546, // 消息随机数
    "MsgTime": 1557481126, // 消息的发送时间戳，单位为秒 
    "MsgKey": "48374_2837546_1557481126", // 消息的唯一标识，可用于 REST API 撤回单聊消息
    "OnlineOnlyFlag":1,//是否仅发送给在线用户标识。1代表仅发送给在线用户，否则为0；
    "SendMsgResult": 0, // 该条消息的下发结果
    "ErrorInfo": "send msg succeed", // 该条消息下发失败的错误信息，若消息发送成功，则为"send msg succeed"
    "MsgBody": [ // 消息体
        {
            "MsgType": "TIMTextElem", // 文本
            "MsgContent": {
                "Text": "red packet"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data",
    "EventTime": 1670574414123 //毫秒级别，事件触发时间戳
}
请求包字段说明
字段
类型
说明
CallbackCommand
String
回调命令。
From_Account
String
消息发送者 UserID。
To_Account
String
消息接收者 UserID。
MsgSeq
Integer
消息序列号，用于标记该条消息（32位无符号整数）。
MsgRandom
Integer
消息随机数，用于标记该条消息（32位无符号整数）。
MsgTime
Integer
消息的发送时间戳，单位为秒。
单聊消息优先使用 MsgTime 进行排序，同一秒发送的消息则按 MsgSeq 排序，MsgSeq 值越大消息越靠后。
MsgKey
String
该条消息的唯一标识，可根据该标识进行 REST API 撤回单聊消息。
OnlineOnlyFlag
Integer
是否仅发送给在线用户标识。1代表仅发送给在线用户，否则为0。
SendMsgResult
Integer
该条消息的发送结果，0表示发送成功，非0表示发送失败，具体可参见 错误码。
ErrorInfo
String
该条消息下发失败的错误信息，若消息发送成功，则为"send msg succeed"。
MsgBody
Array
消息体，具体参见 消息格式描述。
CloudCustomData
String
消息自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）。
EventTime
Integer
事件触发的毫秒级别时间戳。
应答包示例
App 后台同步数据后，发送回调应答包。
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 0为回调成功，1为回调出错
}
应答包字段说明
字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果：
OK 表示处理成功。
FAIL 表示失败。
ErrorCode
Integer
必填
错误码：
0为回调成功。
1为回调出错。
ErrorInfo
String
必填
错误信息。
参考
﻿第三方回调简介﻿
﻿发单聊消息之前回调﻿
REST API：单发单聊消息﻿
REST API：批量发单聊消息﻿

帮助和支持

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

您也可以联系销售或提交工单以寻求帮助。

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

文档反馈

tencent cloud

即时通信 IM

单聊机器人消息回调

功能说明

注意事项

可能触发该回调的场景

回调发生时机

接口说明

请求 URL 示例

请求参数说明

请求包示例

请求包字段说明

应答包示例

应答包字段说明

参考

帮助和支持

参数	说明
https	请求协议为 HTTPS，请求方式为 POST。
www.example.com	回调 URL。
SdkAppid	创建应用时在即时通信 Chat 控制台分配的 SDKAppID。
CallbackCommand	固定为 Bot.OnC2CMessage。
contenttype	固定值为 json。
ClientIP	客户端 IP，格式例如：127.0.0.1。
OptPlatform	客户端平台，取值参见第三方回调简介：回调协议中 OptPlatform 的参数含义。

字段	类型	说明
CallbackCommand	String	回调命令。
From_Account	String	消息发送者 UserID。
To_Account	String	消息接收者 UserID。
MsgSeq	Integer	消息序列号，用于标记该条消息（32位无符号整数）。
MsgRandom	Integer	消息随机数，用于标记该条消息（32位无符号整数）。
MsgTime	Integer	消息的发送时间戳，单位为秒。单聊消息优先使用 MsgTime 进行排序，同一秒发送的消息则按 MsgSeq 排序，MsgSeq 值越大消息越靠后。
MsgKey	String	该条消息的唯一标识，可根据该标识进行 REST API 撤回单聊消息。
OnlineOnlyFlag	Integer	是否仅发送给在线用户标识。1代表仅发送给在线用户，否则为0。
SendMsgResult	Integer	该条消息的发送结果，0表示发送成功，非0表示发送失败，具体可参见错误码。
ErrorInfo	String	该条消息下发失败的错误信息，若消息发送成功，则为"send msg succeed"。
MsgBody	Array	消息体，具体参见消息格式描述。
CloudCustomData	String	消息自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）。
EventTime	Integer	事件触发的毫秒级别时间戳。

字段	类型	属性	说明
ActionStatus	String	必填	请求处理的结果： OK 表示处理成功。 FAIL 表示失败。
ErrorCode	Integer	必填	错误码： 0为回调成功。 1为回调出错。
ErrorInfo	String	必填	错误信息。