更改用户联系人的关系。该操作只可作用于用户实例联系人,可以进行发起添加好友请求、接受好友请求、拒绝好友请求、撤销好友请求、拉黑用户、取消拉黑。
Request
HTTP request
POST https://www.featapi.com/api/party/contact-list/update_relation/
Authorization
该请求需要授权以下scopes访问权限:
Scopes |
---|
party_contact |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a Party.ContactList resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
必填 | |||
action | string | 当前用户要执行的更新操作,详情请查看下文 | |
friend | integer | 目标用户 ID |
action 字段操作和联系人状态变化如下,联系人状态详情:
- “apply“,对目标陌生人用户发起添加好友请求,对方会收到对应的消息。此时,发送者状态变成100(creating),目标用户状态变成200(applying)。
- “recall“,撤回对目标用户发起的好友请求,此时,双方状态变为0(stranger)。如果发送者在24小时内连续撤回操作两次,则他的状态变成400(recalled),发送者在该状态下无法再撤回好友请求,状态维持24小时。
- “accept“,接受目标用户的添加好友请求,之后双方的联系人状态变成300(created)。
- “reject“, 拒绝目标用户向你发送的好友请求,之后目标用户的联系人状态变成500(rejected),你的状态变成0(stranger)。变成500(rejected)状态的用户在一个月内无法再向你申请好友请求。
- “black“, 拉黑目标用户,之后当前用户的联系人状态为600(black),被拉黑的目标用户状态无变化。
- “unblack“,取消拉黑目标用户,当前用户的联系人状态恢复为拉黑前的状态,目标用户状态无变化。比如拉黑之前,你和目标用户互为好友状态是300(created),执行取消拉黑操作后,你和目标用户的联系人状态依然是300(created)。
特例:
- “apply“,如果双方用户同时互相发起添加好友请求,双方自动成为好友,联系人状态300。
- “black“,如果你拉黑目标用户时,目标用户正在向你申请好友,则系统自动为你执行“reject”拒绝操作。
- “black“,如果你拉黑目标用户时,你正在向目标用户申请好友,则系统自动为你执行“recall”撤回操作。
Response
如果请求成功,该API返回目标用户的联系人信息在响应体信息。
200 Update contact relation successfully
{
"data": {
"id": 274,
"group": null,
"friend": 7815803339127,
"friend_fullname": "黎 明",
"friend_first_name": "明",
"friend_last_name": "黎",
"unread_count": 0,
"status": 300,
"contact_time": "2020-04-03T01:25:00.856867Z",
"expertise": "中式英语",
"timezone": "Asia/Shanghai",
"timezone_utc_offset": null,
"location": "CHN",
"avatar": "/media/7815803339127/avatar/blob_5BrnPkO"
}
}
400 非法操作
PARTY_REQUEST_DENIED —— 提交不合法的action值或目标用户是不合法的操作目标
{
"error": true,
"message": "Invalid request. Status is 300",
"data": {},
"code": "PARTY_REQUEST_DENIED"
}
404 Not found
示例返回数据可参考 API Common – Resource Not Found