Skip to main content

Admin Adding a System Notification Account

Brief Description

  • Administrators can add a system notification account for sending notification messages.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/user/add_notification_account
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator's token

Request Parameters Example

{
"userID": "userID",
"nickName":"notification1",
"faceURL":"url"
}
Field NameOptionalTypeDescription
userIDOptionstringSystem notification account ID
nickNameRequiredstringName of the system notification account
faceURLRequiredstringAvatar of the system notification account

Successful Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"userID": "userID",
"faceURL": "url",
"nickName": "notification1"
}
}

Explanation of Parameters in the Successful Response

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if no error
errDlterrDltDetailed error information, empty if no error
dataobjectSystem notification of account information
userIDstringSystem notification account ID
faceURLstringSystem notification account avatar
nickNamestringSystem notification account name

Failed Response Example

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

Explanation of Parameters in the Failed Response

Parameter NameTypeDescription
errCodeintError code, refer to the global error code documentation for details
errMsgstringBrief error message
errDlterrDltDetailed error information