云信服务端提供 API，支持通过传入邀请码加入某个服务器。

功能介绍

收到邀请码的人，可通过邀请码直接加入邀请码生成者指定的服务器。 加入后，加入者和邀请码生成者如果在线，都会收到“通过邀请码加入服务器” （SERVER_MEMBER_JOIN_BY_INVITE_CODE(33)）的系统通知。

如果您的应用需要其他服务器成员也能够接收该系统通知，请通过云信官网提供的联系方式咨询商务经理开通。开通后，其他服务器成员接收该系统通知的条件，参见服务器相关事件通知。

使用限制

服务器存在如下与其成员数量相关的限制：

• 单个用户的服务器的数量上限（包括自己创建的和加入的）默认为 100 个。
• 单个服务器可容人数上限默认为 500000。

可在云信控制台配置上述上限

在云信控制台选择应用，进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 即可配置。

URL

httpPOST https://api.netease.im/nimserver/qchat/joinServerByInviteCode.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
inviteCode	String	是	邀请码
msg	String	是	申请加入的附言，最大长度 150 字符

示例

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**03mgq3" -H "Nonce: 4tggge**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=123&accid=zhasa&inviteCode=ASASA12&msg=12121' 'https://api.netease.im/nimserver/qchat/joinServerByInviteCode.action'

返回示例

HTTP 响应：JSON

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200
}

状态码

该接口在 HTTPS Body 中返回请求的状态码，以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。

状态码	说明	处理建议
200	请求成功	-
403	非法操作或没有权限	检查是否已开通圈组功能
404	对象不存在	检查是否存在必传参数为空的问题 检查传入的服务器 ID、邀请码或 IM 账号是否存在
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低调用频率
431	HTTP 重复请求	-