Rooms - Create

服务:

Communication

API 版本:

2025-03-13

创建新聊天室。

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

URI 参数

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

请求头

名称	必需	类型	说明
Authorization	True	string	包含使用 HMAC-SHA256 方案生成的签名的身份验证字符串。
Repeatability-Request-ID		string (uuid)	如果指定，客户端将指示请求可重复;也就是说，客户端可以使用相同的可重复性-Request-ID 多次发出请求并返回适当的响应，而无需服务器多次执行请求。 Repeatability-Request-ID 的值是一个不透明的字符串，表示客户端生成、全局唯一的、请求的标识符。 建议使用版本 4（随机）UUID。
Repeatability-First-Sent		string (date-time-rfc1123)	如果指定了 Repeatability-Request-ID 标头，则还必须指定 Repeatability-First-Sent 标头。 该值应为首次创建请求的日期和时间，使用 IMF 修复日期形式的 HTTP 日期表示。

请求正文

名称	类型	说明
participants	<string,  ParticipantProperties>	（可选）受邀加入会议室的参与者。
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。 默认值为当前日期时间加上 180 天。

响应

名称	类型	说明
201 Created	RoomModel	请求成功。 该作返回一个新房间。
Other Status Codes	CommunicationErrorResponse	错误响应 标头 x-ms-error-code: string

安全性

Authorization

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

类型: apiKey
在: header

示例

Create a new meeting room.

示例请求

HTTP

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

{
  "validFrom": "2025-06-30T00:00:00Z",
  "validUntil": "2025-07-30T00:00:00Z",
  "pstnDialOutEnabled": true,
  "participants": {
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666": {
      "role": "Attendee"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777": {
      "role": "Presenter"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000888": {
      "role": "Collaborator"
    }
  }
}

示例响应

状态代码:

201

{
  "id": "99117812428622880",
  "createdAt": "2025-06-26T05:46:17.8159131+00:00",
  "validFrom": "2025-06-30T00:00:00+00:00",
  "validUntil": "2025-07-30T00:00:00+00:00",
  "pstnDialOutEnabled": true
}

定义

名称	说明
CreateRoomRequest	请求创建新聊天室的有效负载。
ParticipantProperties
Role	会议室参与者的角色。 默认值为 Attendee。
RoomModel	会议室。

CreateRoomRequest

Object

请求创建新聊天室的有效负载。

名称	类型	说明
participants	<string,  ParticipantProperties>	（可选）受邀加入会议室的参与者。
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。 默认值为当前日期时间加上 180 天。

ParticipantProperties

Object

名称	类型	说明
role	Role	会议室参与者的角色。 默认值为 Attendee。

Role

枚举

会议室参与者的角色。 默认值为 Attendee。

值	说明
Presenter
Attendee
Consumer
Collaborator

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。