获取用户偏好设置

接口说明

请求URL：http[s]://{网关地址}/casp-portal/getPortalUserPreferenceSetting

请求方式： GET

请求内容类型： 无

响应内容类型： application/json

请求说明

请求头

字段名	参数名	必填	类型	描述
应用ID	appId	M	String(128)	接入网关的应用ID
Token	accessToken	M	String	接入网关的accessToken

查询参数

字段名	参数名	必填	类型	描述
用户账号	userAccount	M	String(20)	用户账号（学工号）
多语言	lang	o	String(50)	多语言(不传默认为中文，zh_CN，其他多语言如：en 等)
用户类型	objectScope	M	String(1)	用户类型 1:校内 2:校外 默认 1

响应说明

响应体

字段名	参数名	必填	类型	描述
返回码	errcode	M	String	0 成功，其他为不成功
返回码描述	errmsg	O	String	返回码描述
返回对象	data	O	Object	返回的UserPreferenceSetting对象

UserPreferenceSetting：

字段名	参数名	类型	描述
是否参与推荐算法	isParticipateInRecommend	int	是否参与推荐算法 1：是 0：否
是否提供数据进行分析	isProvideDataAnalysis	int	是否提供数据进行分析 1：是 0：否
用户消息订阅信息	userSubscription	List<SubscriptionVo>	用户消息订阅信息集合

SubscriptionVo(返回)

字段名	类型	描述
appId	String	应用id
appName	String	应用名称
subscriptionChannelTypes	List<SubscriptionChannelType>	订阅的类型通道集合

SubscriptionChannelType(返回)

字段名	类型	描述
channelType	String	通道类型
channelTypeName	String	通道类型名称
isSubscription	int(1)	是否订阅 1:是 0:否

响应示例

{
  "isParticipateInRecommend": 1,
  "isProvideDataAnalysis": 1,
  "userSubscription": [{
    "appId": "1016740884399370240",
    "appName": "xt002",
    "subscriptionChannelTypes": [{
      "channelType": "1",
      "channelTypeName": "收件箱",
      "isSubscription": 1
    }, {
      "channelType": "4",
      "channelTypeName": "短信",
      "isSubscription": 0
    }]
  }, {
    "appId": "994254088809746432",
    "appName": "93消息中心",
    "subscriptionChannelTypes": [{
      "channelType": "1",
      "channelTypeName": "收件箱",
      "isSubscription": 1
    }, {
      "channelType": "2",
      "channelTypeName": "今日校园",
      "isSubscription": 0
    }, {
      "channelType": "3",
      "channelTypeName": "邮箱",
      "isSubscription": 0
    }]
  }, {
    "appId": "1125816203781345280",
    "appName": "shx测试",
    "subscriptionChannelTypes": [{
      "channelType": "1",
      "channelTypeName": "收件箱",
      "isSubscription": 1
    }, {
      "channelType": "4",
      "channelTypeName": "短信",
      "isSubscription": 1
    }, {
      "channelType": "5",
      "channelTypeName": "企业微信",
      "isSubscription": 1
    }, {
      "channelType": "8",
      "channelTypeName": "WeLink",
      "isSubscription": 1
    }]
  }]
}

错误码

错误码	描述
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID,APP_SECRET);
// 创建请求对象
PortalUserPreferenceSettingtRequest request = new PortalUserPreferenceSettingtRequest("zhangsan","1");
PortalUserPreferenceSettingResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
//.....
}