Skip to main content

Get System Account

Brief Description

  • Get the list of created system accounts (notification accounts, bots), including ID, avatar, and name.

Request Method

  • post

Request URL

  • {API_ADDRESS}/user/search_notification_account
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"keyword": "",
"pagination": {
"pageNumber": 1,
"showNumber": 10
}
}
Field NameOptionalTypeDescription
keywordOptionalstringFill in userID or nickname, default to return system account for corresponding pagination when empty
paginationRequiredobjectPagination parameter structure
pagination.pageNumberRequiredintCurrent page number, starting from 1
pagination.showNumberRequiredintNumber of requests on the current page

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 5,
"notificationAccounts": [
{
"userID": "1974356875",
"faceURL": "url",
"nickName": "notification1111111",
"appMangerLevel": 3
},
{
"userID": "8719627904",
"faceURL": "",
"nickName": "notification1",
"appMangerLevel": 3
},
{
"userID": "4208409642",
"faceURL": "",
"nickName": "notification1",
"appMangerLevel": 3
},
{
"userID": "2776836221",
"faceURL": "",
"nickName": "robot",
"appMangerLevel": 4
}
]
}
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below
totalintTotal number of system accounts
notificationAccountsarraySystem account list
userIDstringSystem account ID
faceURLstringSystem account avatar
nickNamestringSystem account nickname
appMangerLevelint3 or 4

Failure Return Example

{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "1001 ArgsError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message