本文介绍如何通过网易云信服务端 API 在指定聊天室中初始化一个队列。

功能说明

网易云信 IM 支持聊天室队列服务，可以对聊天室队列进行管理。

聊天室队列指聊天室（房间）中由多个元素（key-value 键值对）构成的队列，主要应用于直播间中的连麦场景和礼物队列展示等场景。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求信息

请求 URL

POST https://{endpoint}/im/v2/room_queues/{room_id}

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

路径参数

参数名称	类型	是否必选	说明
room_id	Long	是	聊天室 ID。聊天室创建成功后，网易云信会返回聊天室 ID。

请求体参数

参数名称	类型	是否必选	说明
queue_size_limit	Integer	否	聊天室队列的长度限度，即队列中的元素容量。取值范围为 0 ~ 1000，默认为 100 个元素。
- route_config	Object	否	抄送相关配置项。配置前需要提前为应用开通消息抄送功能并配置抄送环境，具体请参考 开通和配置消息抄送。
route_enabled	Boolean	否	是否需要抄送至指定的应用服务器，默认为 true，需要抄送。
route_environment	String	否	需要抄送到的环境，对应您在 网易云信控制台 中配置的自定义抄送的环境名称。

请求体示例

JSON{
    "queue_size_limit": 100,
    "route_config": {
        "route_enabled": true,
        "route_environment": "env"
    }
}

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {}
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113404	聊天室不存在	room_id not found
113403	聊天室功能未开通	function: chatroom not activated
500	服务端内部错误	internal server error
503	服务器繁忙	server busy