该接口用于从聊天室队列中取出指定的元素或取出队列第一个元素。

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/room_queues/{room_id}/actions/poll

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

请求头参数

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

路径参数

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

请求体参数

参数名称	类型	是否必选	说明
element_key	String	否	待取出的队列元素 key，最大长度为 128 位字符。若不填，则默认为队列的第一个元素 key。
- notification_config	Object	否	聊天室队列变更通知的相关配置信息。
notification_enabled	Boolean	否	是否需要发送变更通知，默认为 true，需要发送。
notification_extension	String	否	通知事件的扩展字段，最大长度为 2048 位字符。
high_priority	Integer	否	队列变更通知是否需要设置为高优先级消息（网易云信会优先保障投递此类消息）。 0（默认）：不需要（变更通知为普通消息）。 1：需要（变更通知为高优先级消息）。建议恰当使用该参数，以便在必要时，优先保障应用内的高优先级消息的投递。若全部设置为高优先级，则等于没有设置，单个聊天室最多支持每秒 10 条高优先级消息。
high_priority_policy	Integer	否	高优先级消息策略。针对高优先级消息，超过流控（单个聊天室最多支持每秒 10 条高优先级消息）后的处理策略。 0（默认）：自动降级为普通消息。 1：返回 416 错误码。
- route_config	Object	否	抄送相关配置项。配置前需要提前为应用开通消息抄送功能并配置抄送环境，具体请参考 开通和配置消息抄送。
route_enabled	Boolean	否	是否需要抄送至指定的应用服务器，默认为 true，需要抄送。
route_environment	String	否	需要抄送到的环境，对应您在 网易云信控制台 中配置的自定义抄送的环境名称。

请求体示例

JSON{
  "element_key": "key",
  "notification_config": {
    "notification_enabled": true,
    "notification_extension": "ext",
    "high_priority": 0,
    "high_priority_policy": 0
  },
  "route_config": {
    "route_enabled": true,
    "route_environment": "env"
  }
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
element_key	String	取出的元素 key。	是
element_value	String	取出的元素 value。	是
element_account_id	String	取出元素的所属者用户账号 ID。	否
element_transient	Boolean	该队列元素所属者用户离开聊天室时，该元素是否删除。	否

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "element_key": "key",
    "element_value": "value",
    "element_account_id": "user123",
    "element_transient": fasle
  }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113404	聊天室不存在	room_id not found
113403	聊天室功能未开通	function: chatroom not activated
117427	操作者必须为聊天室创建者	only owner has the permission
117404	聊天室队列不存在	queue does not exist
117301	队列元素不存在	queue element does not exist
500	服务端内部错误	internal server error
503	服务器繁忙	server busy