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

触发会话任务流

最近更新时间：2026-04-27 10:59:51

我的收藏

本页目录：

接口调用说明

App 管理员可以通过该接口主动触发任务流执行，仅适用于“应用（SDK 轻量开发）”的用户端集成方式。
该接口适用于以下两种场景：
指定会话的 SessionId ，指定会话触发任务流。
指定客服号和用户的 UserID ，触发该用户和客服号的会话任务流。
请求 URL 示例：
https://console.tim.qq.com/v4/desk_http_svc/trigger_task?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

请求包示例

指定会话的 SessionId 触发任务流

{
    "SessionId": "d817e9c0-bb23-462a-8048-ae0f66103b1b",
    "TaskType": 0,
    "TaskId": 3466,
    "Variables": {
        "orderid": "ORD-20260326-001",
        "userid": "user156",
        "amount": 1000
    }
}

指定客服号和用户的 UserID 触发任务流

{
    "ClientUserId": "user156",
    "IMAgentUserID": "@customer_service_account",
    "TaskType": 0,
    "TaskId": 3460,
    "Variables": {
        "orderid": "ORD-20260326-001",
        "userid": "user156",
        "amount": 1000
    }
}

请求包字段说明

字段
类型
属性
说明
SessionId
String
选填
会话 ID。若填了该字段，则无需填 FromAccount 和 ToAccount 字段。
ClientUserId
String
选填
用户 ID，只适用于“应用/客户端”的用户端集成方式。
IMAgentUserID
String
选填
客服号的 UserID，只适用于“应用/客户端”的用户端集成方式。
TaskType
Integer
必填
任务流模型，此字段可取值为：
0：标准任务流。
1：智能任务流。
TaskId
Integer
必填
任务流 ID。
Variables
Object
选填
触发任务流支持传入变量，包含了一个 map，key 是变量名，value 是变量值。
注意：
这里 value 仅支持 String 和 Integer 类型传入。

应答包体示例

{
    "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）
中国站