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

会话标记

最近更新时间：2025-07-23 09:49:02

我的收藏

本页目录：

接口调用说明

业务可以通过该接口标记某些特定的会话，给特定会话标星、添加自定义字段，也可以设置会话是否会因为用户消息超时而关闭。

请求 URL 示例

https://console.tim.qq.com/v4/desk_http_svc/mark_session?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

请求包示例

标记会话：
{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066",  // 会话ID
    "Mark": "mark this session"      // 会话标记
}
设置会话标星：
{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066",  // 会话ID
    "StarStatus": 1 ,    // 会话标星
    "UserTimeoutSwitch": 1 // 设置用户消息超时开关
}
设置会话标星和取消用户超时：
{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066",  // 会话ID
    "StarStatus": 1 ,    // 会话标星
    "UserTimeoutSwitch": 0 // 取消用户消息超时
}

请求包字段说明

字段
类型
属性
说明
SessionId
String
必填
指定需要操作的会话 ID。
Mark
String
选填
自定义会话标记字段，业务侧可以使用此字段给会话设置自定义数据。此字段最大支持200个字节， 不填保持不变。
StarStatus
Integer
选填
会话标星字段。
1：表示设置会话标星。
0：表示取消会话标星。
不填保持不变。
UserTimeoutSwitch
Integer
选填
用户超时开关。
1：表示设置用户超时开关。
0：表示取消用户超时开关。
不填保持不变。

应答包体示例

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

应答包字段说明

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

错误码说明

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

接口调试工具

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

参考



中国站
目录