获取圈组连接地址
更新时间: 2024/07/17 17:57:35
您可调用 IM 服务端 API 获取应用客户端与圈组服务端的连接地址。用户登录圈组时,必须传入该连接地址。
- 圈组相关基本概念的介绍,请参见什么是圈组。
- 用户也可调用 SDK API 获取应用客户端与圈组服务端的连接地址,具体见各端的圈组登录文档。
调用前提
调用圈组相关 API 前,请确保已开通圈组功能。
若未开通,可在云信控制台选择应用,进入IM 即时通讯 > 功能配置 > 圈组配置页进行开通。
URL
httpPOST https://api.netease.im/nimserver/qchat/requestAddr.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
accid |
String | 是 | 云信 IM 账号,通过调用user/create.action 创建,也可通过云信控制台创建测试账号获取测试或体验用的临时账号 |
type |
String | 是 | 0 表示非 Web 端,1 表示 web 端 |
clientIp |
String | 是 | 客户端 IP 地址 |
返回参数
参数 | 说明 |
---|---|
code |
请求的状态码 |
data |
圈组服务端的连接地址,示例:["59.11..:8080", "59.11..:8080"] |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw080*****" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc555*****" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&type=1&clientIp=59.111.*.*' 'https://api.netease.im/nimserver/qchat/requestAddr.action'
返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"data":["59.11.*.*:8080", "59.11.*.*:8080"]
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 | 检查是否已开通圈组功能 |
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?