服务端 API

更新通知账号

使用 更新通知账号 从可信后端修改通知账号的昵称或头像。请求中至少需要传入 nickName 或 faceURL 中的一个字段。

HTTP 请求

POST {API_ADDRESS}/user/update_notification_account

请求示例

curl --request POST "${API_ADDRESS}/user/update_notification_account" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: 1646445464564" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "userID": "notice_001",
  "nickName": "运营通知",
  "faceURL": "https://cdn.example.com/avatar/notice-new.png"
}'

安全提示：通知账号资料会影响客户端展示，请在业务后台完成权限校验后再调用该接口。

参数

此接口通过请求头传入链路追踪信息和鉴权凭证，通过 JSON 请求体传递通知账号资料。

请求头

请求头	示例值	是否必填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议每个请求独立生成。
token	eyJhbxxxx3Xs	必填	string	管理员 token。

请求体参数

{
  "userID": "notice_001",
  "nickName": "运营通知",
  "faceURL": "https://cdn.example.com/avatar/notice-new.png"
}

参数名	是否必填	类型	说明
userID	必填	string	需要更新的通知账号 ID。
nickName	条件必填	string	新昵称。`nickName` 和 `faceURL` 至少传一个。
faceURL	条件必填	string	新头像地址。`nickName` 和 `faceURL` 至少传一个。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

响应属性列表

参数名	类型	说明
errCode	int	错误码，0 表示成功。
errMsg	string	错误简要信息，成功时为空。
errDlt	errDlt	错误详细信息，成功时为空。
data	object	成功时为空对象。

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "faceURL and nickName is empty at the same"
}

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档。
errMsg	string	错误简要信息。
errDlt	errDlt	错误详细信息。

常见错误场景

错误场景	可能原因	处理方式
参数为空	`nickName` 和 `faceURL` 都为空。	至少传入一个需要更新的字段。
账号不存在	`userID` 不存在或不是可更新账号。	先通过搜索通知账号确认账号。

这个页面有帮助吗？