Method: users.spaces.threads.updateThreadReadState

更新用户在会话中的阅读状态,用于识别已读和未读消息。如需查看示例,请参阅更新用户的会话已读状态。

需要使用授权范围进行用户身份验证:

  • https://www.googleapis.com/auth/chat.users.readstate

HTTP 请求

PATCH https://chat.googleapis.com/v1/{threadReadState.name=users/*/spaces/*/threads/*/threadReadState}

网址采用 gRPC 转码语法。

路径参数

参数
threadReadState.name

string

会话串已读状态的资源名称。

格式:users/{user}/spaces/{space}/threads/{thread}/threadReadState

查询参数

参数
updateMask

string (FieldMask format)

必需。要更新的字段路径。目前支持的字段路径:

  • lastReadTime

如果 lastReadTime 早于最新消息的创建时间,则会话在界面中显示为未读。

如需将消息串标记为已读,请将 lastReadTime 设置为等于或晚于最新消息创建时间的时间戳。未来的时间戳会被强制转换为当前请求时间。设置负时间戳(1970-01-01T00:00:00Z 之前)会返回 INVALID_ARGUMENT 错误。

请求正文

请求正文包含一个 ThreadReadState 实例。

响应正文

如果成功,则响应正文包含一个 ThreadReadState 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/chat.users.readstate

如需了解详情,请参阅授权指南。