API 参考
在线调试

更新聊天室在线成员信息

更新时间: 2024/07/17 17:26:06

该接口用于更新聊天室在线成员(固定成员和游客)信息,包括昵称、头像、扩展字段信息。

  • 固定成员可修改在线信息,同时可以指定是否修改固定成员持久化信息。若固定成员不在线,且无需持久化时,接口返回聊天室成员不在线的错误信息。
  • 游客可修改在线信息。游客不在线时,接口返回聊天室成员不在线的错误信息。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}

请求 Header 的参数说明请参见 请求 Header

路径参数

参数名称 类型 是否必选 描述
account_id String 必选 需要更新信息的成员账号 ID。

请求体参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
persistence Boolean 可选 是否修改固定成员持久化信息。false(默认):不持久化;true:持久化。
  • 该参数只对固定成员生效,对游客不生效
  • 固定成员不在线,且无需持久化时,接口返回聊天室成员不在线的错误信息
  • room_nick String 可选 成员在聊天室中的昵称,需要通过反垃圾审核。
    room_avatar String 可选 成员在聊天室中的头像,需要通过反垃圾审核。
    extension String 可选 自定义扩展字段,字段上限为 4096 字符,需要通过反垃圾审核。
    notification_enabled Boolean 可选 操作完成后是否发送通知消息。false(默认):不发送;true:发送。
    notification_extension String 可选 通知扩展字段,JSON 格式,长度上限为 2048 字符。
    antispam_configuration Object 可选 安全通相关配置项。

    请求体示例

    json{
        "room_id": 1602735437,
        "extension": "laborum",
        "room_avatar": "deserunt non irure id",
        "notification_extension": "sit laboris ullamco ut Ut",
        "notification_enabled": true,
        "room_nickname": "梁磊0001"
    }
    

    响应

    Header

    响应 Header 的参数说明请参见 响应 Header

    响应体参数

    参数名称 类型 描述 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    data Object 返回的 JSON 数据对象,请求失败则返回空对象。

    响应体示例

    json{
        "code": 200,
        "msg": "success",
        "data": {}
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频率超限 rate limit exceeded
    102404 用户不存在 account not exist
    113410 聊天室服务未开通 chatroom service disabled
    113404 聊天室不存在 chatroom not exist
    113406 聊天室已关闭 chatroom closed
    114404 聊天室成员不存在 chatroom member not exist
    114408 聊天室成员已删除 Member: %s was already deleted
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码