申请加入服务器
更新时间: 2024/07/17 17:57:34
云信服务端支持用户调用 API 主动加入服务器。
功能介绍
用户可以主动申请加入某个服务器,发起申请后,服务器内拥有“处理加入服务器申请的权限”的成员(以下简称为“审批方”),将收到一条“申请加入服务器”(SERVER_MEMBER_APPLY(3)
)的系统通知。审批方可调用 SDK API 或者 服务端 API 接受申请或拒绝申请。
服务器内最多只有 100 位(随机 100 位)为拥有“处理加入服务器申请的权限”的成员能收到“申请加入服务器”的系统通知。
使用限制
服务器存在如下与其成员数量相关的限制:
- 单个用户的服务器的数量上限(包括自己创建的和加入的)默认为 100 个。
- 单个服务器可容人数上限默认为 500000。
- 可在云信控制台配置上述上限。 在云信控制台选择应用,进入IM 即时通讯 > 功能配置 > 圈组 > 子功能配置 即可配置。
URL
httpPOST https://api.netease.im/nimserver/qchat/applyServer.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
accid | String | 是 | 申请方的 IM 帐号 |
serverId | Long | 是 | 服务器 ID |
msg | String | 是 | 发出申请的消息内容,最大长度 150 字符 |
ttl | Long | 否 | 申请的有效期,单位:毫秒,默认 30 天 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | int | 状态码 |
requestId | Long | 申请 ID |
expireTime | Long | 申请到期时间戳。如果服务器的申请模式被设置为“不需要同意直接加入”(即applyMode=0 ,创建和修改服务器时可配置),则返回 0 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk4**glw0803mgq3" -H "Nonce: 4tgg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid=zhangsan&msg=apply' 'https://api.netease.im/nimserver/qchat/applyServer.action'
返回示例
HTTP 响应:JSON
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"requestId": 123,
"expireTime": 111
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 | 检查是否已开通圈组功能 |
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?