查询个人的申请和邀请记录
更新时间: 2024/07/17 17:57:35
云信服务端查询个人的申请邀请记录,需要拥有申请邀请历史查看权限。
URL
httpPOST https://api.netease.im/nimserver/qchat/queryInviteApplyHistoryByUser.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
accid | String | 是 | 查询者的 IM 账号 |
fromTime | Long | 否 | 开始时间戳,单位:毫秒,默认 0 |
toTime | Long | 否 | 结束时间戳,单位:毫秒,默认当前时间 |
excludeRecordId | Long | 否 | 排除的记录 ID |
limit | int | 否 | 本次查询的数量上限,最大数量 100 |
reverse | int | 否 | 是否逆序,0 或 1,默认 0,表示从现在往过去查询 |
返回参数
参数 |
类型 |
说明 |
---|---|---|
serverId | Long | 服务器 ID |
accid | Long | 用户的 IM 账号 |
type | int | 申请邀请记录的类型:
|
status | int | 申请或邀请的状态:
|
requestId | Long | 申请或邀请的 ID |
createTime | Long | 申请或邀请的创建时间 |
updateTime | Long | 申请或邀请的更新时间 |
expireTime | Long | 申请或邀请的过期时间 |
data | Long | 可转成 JSON 格式,根据申请邀请记录类型(type)的不同,返回不同的 data 信息,具体请参考下文的data 详细信息 |
recordId | Long | 记录的 ID |
data 详细信息
- type=1,表示申请记录,data 中包含如下内容:
{"applyMsg": "xxx", //申请附言
"updateAccid": "acc01", //执行同意或拒绝操作的用户账号
"updateMsg": "yyy" //同意或拒绝操作的附言
}
- type=3,表示邀请 ACK 记录,可能同意,也可能拒绝,data 中包含如下内容:
{"inviteMsg": "xxx", //邀请附言
"updateMsg": "yyy" //同意或拒绝操作的附言
}
- type=5,表示通过邀请码加入服务器的记录,data 中包含如下内容:
{"updateMsg": "xxx", //加入服务器的附言
"inviteCode": "AS102SA12" //邀请码
}
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk4**kglw0803mgq3" -H "Nonce: 4tggge**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=123&accid=zhasa' 'https://api.netease.im/nimserver/qchat/queryInviteApplyHistoryByUser.action'
返回示例
HTTP 响应:JSON
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"data":
[
{
"serverId": 123,
"accid": "sasa",
"type": 1,
"status": 0,
"requestId": 122,
"recordId": 123,
"createTime": 2121,
"updateTime": 1212,
"expireTime": 2121, //申请/邀请到期时间
"data": {"applyMsg": "xxx", "updateAccid": "acc01", "updateMsg": "yyy"}
}
]
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?