获取用户的好友

获取用户的好友Client-side

get/users/me/relationships

获取添加为已认证用户的好友的用户列表。

SecurityBearer or APIKey

Request

query Parameters

type required	string 好友类型。可以是： `friends`，获取添加到好友列表的用户列表 `friend_requested`，获取收到了好友请求的用户列表 `friend_requested_by`，获取发来好友请求的用户 `blocked`，获取已添加到好友列表但被阻止的用户列表 `blocked_by`，获取阻止了此用户的用户列表 Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by required	string 对用户进行排序的条件。可以是： `by_nickname`，按照昵称的字母顺序对列表进行排序 `by_updated`，按照用户最近将某人添加到好友列表或阻止他们的日期对列表进行排序 Enum: "by_nickname" "by_updated"
sort_order required	string 对用户列表进行排序的条件。可以是： `asc`，即升序应用`sort_by`值 `desc`，即降序应用`sort_by`值 Enum: "asc" "desc"
after	string 用于API分页的参数。
limit	integer [ 1 .. 50 ] Default: 20 一次返回的最大用户数。

Responses

200

确定

400

错误的请求

401

被禁止

403

被禁止

404

未找到

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/users/me/relationships?after=SOME_STRING_VALUE&limit=20&type=SOME_STRING_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer BEARER_TOKEN'

Response samples

application/json

{"next_after": "string",
"next_url": "string",
"relationships": [{"next_after": "bmFtZS0ydXNlci0y",
"next_url": "https://login.xsolla.com/api/users/by_access_key/access-key-1/relationships?type=friend_requests&sort_by=by_name&limit=2&after=bmFtZS0ydXNlci0y",
"relationships": [{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499214.3501,
"user": {"id": "user-3",
"name": "name-3",
"nickname": "nick-2",
"picture": "",
"tag": "423432"
}
},
{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499213.4718,
"user": {"id": "user-2",
"name": "name-2",
"nickname": "nick-2",
"picture": "",
"tag": "3100"
}
}
]
}
]
}