生成邀请码
更新时间: 2024/07/17 17:57:35
云信服务端提供 API 支持生成某个服务器的邀请码。
功能介绍
服务器内拥有“邀请他人加入服务器的权限”的成员,可生成邀请码,并通过第三方应用(如微信)分享给某人。收到邀请码的人可通过邀请码加入服务器。
URL
httpPOST https://api.netease.im/nimserver/qchat/generateInviteCode.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 |
ttl | Long | 否 | 邀请码的有效期,单位:毫秒,默认 30 天 |
返回参数
参数 |
类型 |
说明 |
---|---|---|
code | int | 状态码 |
serverId | Long | 邀请码对应的服务器的 ID |
inviteCode | String | 邀请码 |
expireTime | Long | 邀请码的到期时间戳 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk**1kglw0803mgq3" -H "Nonce: 4tggger**23t" -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/generateInviteCode.action'
返回示例
HTTP 响应:JSON
json"Content-Type": "application/json; charset=utf-8"
{
"code": 200,
"serverId": 123,
"inviteCode": "AHSASH112",
"expireTime": 121211
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 |
|
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?