API 参考
圈组

修改自己的成员信息

更新时间: 2024/07/17 17:57:35

云信服务端提供 API,支持用户修改自己在服务器内展示的成员信息。

功能介绍

用户加入服务器后,可按需修改自己在服务器内展示的成员信息。修改后,自己将收到“修改服务器成员信息”(SERVER_MEMBER_UPDATE(14))的系统通知。

如果您的应用需要其他服务器成员也能够接收该系统通知,请通过云信官网提供的联系方式咨询商务经理开通。开通后,其他服务器成员接收该系统通知的条件,参见服务器相关事件通知

URL

httpPOST https://api.netease.im/nimserver/qchat/updateServerMember.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accidString操作者的 IM 账号
serverIdString服务器 ID
nickString昵称,最大长度 64 字符
avatarString头像的 URL,最大长度 1024 字符
customString自定义扩展字段,最大长度 1024 字符
bidString安全通的自定义反垃圾(即内容审核)业务的 ID。自定义反垃圾业务主要用来针对单条消息或单次操作的资料信息进行除了默认反垃圾业务以外的内容审核。如需配置自定义反垃圾,请通过云信官网首页提供的微信、在线聊天和电话等方式联系商务经理进行配置,并获取对应的业务 ID。可转换为 JSON 格式,如:{"textbid":"","picbid":""}

返回参数

参数
类型
说明
code int 状态码
serverMember String 服务器成员信息,具体字段见下表
serverMember 的字段
类型
说明
serverId Long 服务器 ID
accid String 成员的 IM 账号
nick String 成员昵称
avatar String 成员头像的 URL
custom String 成员自定义扩展字段
type int 成员类型:0-普通成员,1-服务器所有者
joinTime Long 成员加入服务器的时间
inviter String 该成员的邀请者的 IM 账号
validFlag int 有效标志:0-无效,1-有效。如成员已不在服务器内,则为无效
createTime Long 成员信息在数据库的创建时间
updateTime Long 成员信息在数据库的更新时间

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk**w0803mgq3" -H "Nonce: 4tggger**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1513535&nick=update' 'https://api.netease.im/nimserver/qchat/updateServerMember.action'

返回示例

HTTP 响应:JSON

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "serverMember": {
    "serverId": 123, 
    "accid": "lisi", 
    "nick": "nick", 
    "avatar": "avatar",  
    "custom": "custom", 
    "type": 0, 
    "joinTime": 1234, 
    "inviter": "zhangsan", 
    "validFlag": 1,
    "createTime": 1234, 
    "updateTime": 1234 
  }
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查服务器资料中是否包含违规或敏感内容。如果已开通安全通且被检测到存在违规或敏感信息,可能会被安全通的内容审核判定为“不通过”
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的 IM 账号、服务器 ID 或自定义反垃圾业务 ID (bid)是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码