增加系统通知号 | OpenIM Docs

跳到主要内容

增加系统通知号

简要描述

增加系统通知号，管理员可以以系统通知号身份发送通知消息。

请求方式

post

请求 URL

{API_ADDRESS}/user/add_notification_account

header 名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	operationID 用于全局链路追踪
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "userID": "userID",
  "nickName": "notification1",
  "faceURL": "url"
}

字段名	选填	类型	说明
userID	选填	string	系统通知号 ID
nickName	必填	string	系统通知号昵称
faceURL	必填	string	系统通知号头像

成功返回示例

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

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码,0 表示成功
errMsg	string	错误简要信息,无错误时为空
errDlt	errDlt	错误详细信息,无错误时为空
data	object	系统通知号信息
userID	string	系统通知号 ID
faceURL	string	系统通知号头像
nickName	string	系统通知号名称

失败返回示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "nickName is empty: 1001 ArgsError"
}

失败返回示例的参数说明

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

增加系统通知号