logo
控制台登录/注册
文档
客户端 API
服务端 API
即时通讯
API 概览
发布日志
调用方式
在线调试服务端 API
连接至 ZEGO 文档 MCP 服务link
用户
房间
群组
消息
呼叫邀请
会话
机器人
ZIM Audio
回调说明
全局返回码
服务端 API 调测指南
当前页

设置会话标记

POST

https://zim-api.zego.im/

调用此接口，可为多名用户对多个会话设置或取消标记。每个会话至多可存在 30 个标记。

客户端将通过 ZIM SDK 的回调接口，接收会话的标记变化。

iOSAndroidmacOSWindows
conversationChangedonConversationChangedconversationChangedonConversationChanged
Web小程序FlutterReact Native
conversationChangedconversationChangedonConversationChangedconversationChanged
Unity3Duni-app | uni-app xHarmonyOS
OnConversationChangedconversationChangedconversationChanged
说明
调用频率限制：20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [SetConvMark]

    接口原型参数

    https://zim-api.zego.im/?Action=SetConvMark

    AppId uint32必填

    💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    操作用户 ID（已在客户端调用 login 方法登录 ZIM 服务，或已调用 服务端 API 完成注册）。

    说明

    FromUserId 仅支持数字，英文字符和 "'!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'"。

    ConvMarkInfoList object[]required
    Possible values: <= 100
    会话标记的对象，每次最多 100 个，超过100或者为0报错。
  • Array[
    • UserId string必填

    为此 UserID 的用户设置或取消会话标记。

    说明

    当目标会话为群聊时，此用户需已在群聊中。

    说明

    UserId 仅支持数字，英文字符和 {"'!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'"}。

    SetMarkC2c object
    SetMarkC2c 与SetMarkGroup 至少选择一个。
    单聊会话列表（JSON Object）。key 为会话 ID，value 为仅包含 key 为 MarkContent 的 JSON Object。列表最多可包含 100 个会话。
    property name* object
    MarkContent number必填

    可选值: >= 1 and <= 30

    会话标记。取值为 [1, 30] 的整数。

    SetMarkGroup object
    SetMarkC2c 与SetMarkGroup 至少选择一个。
    群聊会话列表（JSON Object）。key 为会话 ID，value 为仅包含 key 为 MarkContent 的 JSON Object。列表最多可包含 100 个会话（群聊会话需已存在，且为未被删除）。
    property name* object
    MarkContent number必填

    可选值: >= 1 and <= 30

    会话标记。取值为 [1, 30] 的整数。

    Action boolean必填

    标记操作：

    • true：设置标记。
    • false：取消标记。
  • ]

Responses​

OK
Schema
    Code number

    返回码。

    以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考 全局返回码。

    说明

    当您发起请求设置或取消多个会话的标记时：

    • 只需成功对至少一个会话完成操作，Code 都会返回 0，表示成功。此时请参考 FailList 中的具体信息，了解失败操作详情。
    • 如果所有会话的操作都失败，Code 会返回相关返回码，具体请参考 全局返回码。
    返回码说明处理建议
    660000001业务类通用错误。请重试，或联系 ZEGO 技术支持。
    660000002输入参数错误。请检查输入的参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660800001查询用户信息出错。请联系 ZEGO 技术支持。
    660800054对所有的会话的标记操作都失败。请联系 ZEGO 技术支持。
    Message string

    请求结果的说明信息。

    RequestId string

    请求 ID。

    FailList object[]

    会话标记失败用户列表。

    • Code 为 0：
    • FailList 为空，为所有用户的会话标记操作都成功。
    • FailList 不为空，表示为部分用户的会话标记操作失败，请参考 FailList 中的 SubCode 和 SubMessage 处理。
    • Code 不为 0：
    • FailList 为空，表示参数错误、接口频率限制、系统错误。
    • FailList 不为空，表示为全部用户的会话标记操作都失败。
  • Array[
    • SubCode number

    用于标识为一名用户执行会话标记操作的结果。

    SubMessage string

    描述为一名用户执行会话标记操作的结果。

    UserId string

    会话标记操作目标用户的 ID。

    FailList object[]

    标记操作目标会话失败列表。

    • SubCode 为 0：
    • FailList 为空，对目标用户的所有目标会话都操作成功。
    • FailList 不为空，表示对目标用户的部分目标会话操作失败，请参考 FailList 中的 Code 和 Message 处理。
    • SubCode 不为 0：
    • FailList 为空，表示参数错误、接口频率限制、系统错误。
    • FailList 不为空，表示对目标用户的所有目标会话都操作失败。
  • Array[
    • Code number

    操作失败返回码。

    Message string

    操作失败描述。

    ConvId string

    会话 ID。

    • 单聊会话：会话 ID 为用户 ID。
    • 群聊会话：会话 ID 为群组 ID。
    ConvType number

    可选值: [0, 2]

    会话类型。

    • 0：单聊会话。
    • 2：群聊会话。
  • ]
  • ]

上一篇

查询群聊会话消息列表

下一篇

清除单个会话消息未读数

当前页

返回到顶部