文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>即时通信 IM>智能客服（Desk）>服务端配置>服务端 API>消息相关接口>发送消息

发送消息

最近更新时间：2025-07-08 10:15:12

我的收藏

本页目录：

接口调用说明

App 管理员可以通过该接口给用户发送消息。用户转人工后，人工客服也能看到该消息。
该接口适用于以下两种场景：
1. 指定会话的 SessionId 发送消息，该场景适用于所有用户端的集成方式，包括网页/H5（免开发）、应用（SDK 轻量开发）。
2. 指定客服号和用户的 UserID 发送消息，该场景仅适用于"应用（SDK 轻量开发）"的用户端集成方式。该接口仅支持指定客服号给用户发送消息。
请求 URL 示例：
https://console.tim.qq.com/v4/desk_http_svc/send_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/desk_http_svc/send_msg
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为json。

请求包示例

指定会话的 SessionId 发送消息

{
    "SessionId": "fd8a2e30-54de-4e40-bcaf-02718409c5cf",
    "MsgRandom": 8436874,
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "欢迎使用智能客服，很高兴为您服务！"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}

指定客服号和用户的 UserID 发送文本消息（仅适用于"应用（SDK 轻量开发）"的用户端集成方式）

{
    "FromAccount": "@customer_service_account",
    "ToAccount": "user45",
    "MsgRandom": 82139,
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "欢迎注册xx商城，您可在此购买想要的商品，如有疑问请联系客服。"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}

发送卡片自定义消息

其中自定义消息的 Data 字段可参考 卡片消息 的说明。其他智能客服定义的自定义消息格式可参见 无 UI 用户端集成 ，将该文档中定义的 JSON 数据结构序列化后，放到 Data 字段即可。
{
    "FromAccount": "@customer_service_account",
    "ToAccount": "user45",
    "MsgRandom": 82139,
    "MsgBody": [
        {
            "MsgType": "TIMCustomElem",
            "MsgContent": {
                "Data": "{\\"src\\": \\"22\\",\\"content\\": {\\"header\\": \\"卡片标题\\",\\"desc\\": \\"卡片描述\\",\\"pic\\": \\"https://cloudcache.tencent-cloud.com/qcloud/portal/kit/images/presale.a4955999.jpeg\\",\\"url\\": \\"https://www.qcloud.com/\\"},\\"customerServicePlugin\\": 0}"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}

请求包字段说明

字段
类型
属性
说明
SessionId
String
选填
会话 ID。若填了该字段，则无需填 FromAccount 和 ToAccount 字段。
FromAccount
String
选填
发送方 UserID，只适用于"应用/客户端"的用户端集成方式，且发送方必须为客服号。
ToAccount
String
选填
接收方 UserID，只适用于"应用/客户端"的用户端集成方式，接收方为普通用户。
MsgRandom
Integer
必填
消息随机数（32位无符号整数），用于去重。
MsgBody
Array
必填
消息内容，具体格式请参见 消息格式描述。智能客服定义的自定义消息格式（如卡片消息、订单消息等）请参加 无 UI 用户端集成，将文档中定义好的 JSON 数据结构序列化后放到自定义消息的 Data 字段。
CloudCustomData
String
选填
消息自定义数据，具体请参见 CloudCustomData。
ExcludeFromUserRespTimeout
Integer
选填
用户与人工客服聊天时，控制该条消息是否计入“用户回复超时”的倒计时。0为计时，1为不计时，默认为0。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
错误码：
0表示成功。
非0表示失败。
ErrorInfo
String
错误信息。
ActionStatus
String
请求处理的结果。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
描述
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。
141002
内部错误，请重试。
141004
参数非法。
141005
会话不存在或已结束。

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

查询单聊消息（v4/openim/admin_getroammsg）
中国站
目录