接口调用说明
您可以通过该接口获取指定会话标记的内容。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/get_session_mark?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/get_session_mark | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
请求包示例
获取会话标记的内容
{"SessionId": "3251520d-c84a-485a-ad04-9d4b3903f57d" // 会话ID}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
SessionId | String | 必填 | 指定需要操作的会话 ID。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","Mark": "mark this session", // 会话标记的内容"StarStatus": 1, // 会话是否标星"UserTimeoutSwitch": 0 // 用户超时开关}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码： 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
Mark | String | 自定义会话标记字段。 |
StarStatus | Integer | 会话标星字段。 1：表示设置会话标星。 0：表示取消会话标星。 |
UserTimeoutSwitch | Integer | 用户超时开关。 1：表示设置用户超时开关。 0：表示取消用户超时开关。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 描述 |
141002 | 内部错误，请重试。 |
141004 | 参数非法。 |
141005 | 会话不存在或已结束。 |
