获取聊天室地址 - 即时通信

请求参数

Path 参数

room_id

string

必需

需要获取地址的聊天室 ID，聊天室创建成功后，云信会返回聊天室 ID。

示例值:

1605537145

Query 参数

account_id

string

必需

进入聊天室的用户账号 ID。

示例值:

yx1

client_type

string

可选

进入聊天室的用户的客户端类型。
1（默认）：weblink（客户端为 Web 端时使用）；2：commonlink（客户端为非 Web 端时使用）；3：wechatlink（微信小程序使用）。

示例值:

2

client_ip

string

必需

进入聊天室的用户的客户端 IP。
云信服务器会根据用户 IP 的所在地区，返回合适的地址。

示例值:

183.131.4.57

ip_type

string

可选

支持的 IP 协议类型。0（默认）：IPv4；1：IPv6；2：全部支持。

示例值:

1

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145/actions/address?account_id=yx1&client_type=2&client_ip=183.131.4.57&ip_type=1' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

items

array[string]

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "items": [
      "59.111.241.213:9092"
    ]
  }
}