跳到主要内容

修改用户的在线状态订阅关系​

简要描述​

  • 修改（订阅或者取消订阅）指定用户的在线状态订阅关系。

请求方式​

  • post

请求 URL​

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

请求参数示例​

{
  "userID": "9168684795",
  "userIDs": ["7475779354", "6317136453", "8450535746"],
  "genre": 1
}
字段名选填类型说明
userID必填string指定用户 ID
userIDs必填array用户 ID 列表
genre必填int订阅或取消订阅，1 - 订阅； 2 - 取消订阅

成功返回示例​

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "statusList": [
      {
        "userID": "7475779354",
        "status": 0,
        "platformIDs": null
      },
      {
        "userID": "6317136453",
        "status": 0,
        "platformIDs": null
      },
      {
        "userID": "8450535746",
        "status": 1,
        "platformIDs": [2]
      }
    ]
  }
}

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

参数名类型说明
errCodeint错误码，0 表示成功
errMsgstring错误简要信息，为空
errDlterrDlt错误详细信息，为空
dataobject通用数据对象，具体结构见下方
statusListarray状态返回结果
statusList.userIDstring用户账号
statusList.statusint在线状态，0：offline，1：online
statusList.platformIDsarray用户登录时的终端类型列表，可能多端在线，取值为1-9

失败返回示例​

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

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

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