跳到主要内容

获取系统通知号​

简要描述​

  • 管理员可以获取所创建的系统通知号列表，包括 ID、头像和名称。

请求方式​

  • post

请求 URL​

  • {API_ADDRESS}/user/search_notification_account
header 名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪，建议使用时间戳，在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例​

{
  "keyword": "",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 10
  }
}
字段名选填类型说明
keyword选填string填写 userID 或 nickname，不填时默认返回对应分页的系统通知号
pagination必填object分页参数结构体
pagination.pageNumber必填int当前页码，从 1 开始
pagination.showNumber必填int当前页请求数量

成功返回示例​

{
  "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"
      }
    ]
  }
}

成功返回示例的参数说明​

参数名类型说明
errCodeint错误码，0 表示成功
errMsgstring错误简要信息，为空
errDlterrDlt错误详细信息，为空
dataobject通用数据对象，具体结构见下方
totalint系统通知号总数
notificationAccountsarray系统通知号列表
userIDstring系统通知号 ID
faceURLstring系统通知号头像
nickNamestring系统通知号名称

失败返回示例​

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

失败返回示例的参数说明​

参数名类型说明
errCodeint错误码，具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息