Admin Retrieving Created System Notification Accounts
Brief Description
- Administrators can retrieve a list of created system notification accounts, including their ID, avatar, and name.
Request Method
post
Request URL
{API_ADDRESS}/user/search_notification_account
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Administrator's token |
Request Parameters Example
{
"keyword": "",
"pagination": {
"pageNumber": 1,
"showNumber": 10
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
keyword | Option | string | Fill in userID or nickname, if you don't fill in, the system notification number of the corresponding page will be returned by default |
pagination | Required | object | Structure for pagination parameters |
pagination.pageNumber | Required | int | Current page number, starting from 1 |
pagination.showNumber | Required | int | Number of requests per page |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"total": 5,
"notificationAccounts": [
{
"userID": "1974356875",
"faceURL": "url",
"nickName": "notification1111111"
},
{
"userID": "8719627904",
"faceURL": "",
"nickName": "notification1"
},
{
"userID": "4208409642",
"faceURL": "",
"nickName": "notification1"
},
{
"userID": "2776836221",
"faceURL": "",
"nickName": "notification1"
}
]
}
}
Explanation of Parameters in the Successful Response
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error information, empty if no error |
data | object | General data object, see below for structure |
total | int | Total number of system notification accounts |
notificationAccounts | array | List of system notification accounts |
userID | string | System notification account ID |
faceURL | string | System notification account avatar |
nickName | string | System notification account name |
Failed Response Example
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "1001 ArgsError"
}
Explanation of Parameters in the Failed Response
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, see the global error code document for details |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error information |