Rooms - Update

服务:

Communication

API 版本:

2025-03-13

使用给定的更改更新会议室。

PATCH {endpoint}/rooms/{roomId}?api-version=2025-03-13

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (url)	Azure 通信资源的终结点。
roomId	path	True	string	请求的聊天室的 ID。
api-version	query	True	string	要调用的 API 版本。

请求头

Media Types: "application/merge-patch+json"

名称	必需	类型	说明
Authorization	True	string	包含使用 HMAC-SHA256 方案生成的签名的身份验证字符串。

请求正文

Media Types: "application/merge-patch+json"

名称	类型	说明
pstnDialOutEnabled	boolean	（可选）如果在呼叫时在特定房间中启用 PSTN 号码，请将此标志设置为 true。 默认情况下，此标志设置为 false。
validFrom	string (date-time)	（可选）打开聊天室以加入的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。
validUntil	string (date-time)	（可选）无法再加入聊天室时的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。

响应

名称	类型	说明
200 OK	RoomModel	请求成功。 该作返回更新后的聊天室。
Other Status Codes	CommunicationErrorResponse	错误响应 标头 x-ms-error-code: string

安全性

Authorization

包含使用 HMAC-SHA256 方案生成的签名的身份验证字符串。

类型: apiKey
在: header

示例

Update meeting room's properties.

示例请求

HTTP

PATCH https://contoso.communication.azure.com//rooms/99199690362660524?api-version=2025-03-13

{
  "validFrom": "2023-06-30T00:00:00Z",
  "validUntil": "2023-07-30T00:00:00Z",
  "pstnDialOutEnabled": true
}

示例响应

状态代码:

200

{
  "id": "99199690362660524",
  "createdAt": "2025-06-26T01:37:00.659722+00:00",
  "validFrom": "2025-06-30T00:00:00+00:00",
  "validUntil": "2025-07-30T00:00:00+00:00",
  "pstnDialOutEnabled": true
}

定义

名称	说明
RoomModel	会议室。
UpdateRoomRequest	请求更新会议室的有效负载。

RoomModel

Object

会议室。

名称	类型	说明
createdAt	string (date-time)	在服务器上创建会议室时的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。
id	string	房间的唯一标识符。 此 ID 是生成的服务器。
pstnDialOutEnabled	boolean	如果在呼叫时在特定房间中启用 PSTN 号码，请将此标志设置为 true。 默认情况下，此标志设置为 false。
validFrom	string (date-time)	打开聊天室以加入的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。
validUntil	string (date-time)	无法再加入聊天室时的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。

UpdateRoomRequest

Object

请求更新会议室的有效负载。

名称	类型	说明
pstnDialOutEnabled	boolean	（可选）如果在呼叫时在特定房间中启用 PSTN 号码，请将此标志设置为 true。 默认情况下，此标志设置为 false。
validFrom	string (date-time)	（可选）打开聊天室以加入的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。
validUntil	string (date-time)	（可选）无法再加入聊天室时的时间戳。 时间戳采用RFC3339格式：yyyy-MM-ddTHH:mm:ssZ。