Share via

Rooms - Get

  • Reference
Service:
Communication
API Version:
2023-10-30-preview

Retrieves an existing room by id.

GET {endpoint}/rooms/{roomId}?api-version=2023-10-30-preview

URI Parameters

Name In Required Type Description
endpoint
 path True

string

url

The endpoint of the Azure Communication resource.
roomId
 path True

string

The id of the room requested.
api-version
 query True

string

Version of API to invoke.

Request Header

Name Required Type Description
Authorization True

string

An authentication string containing a signature generated using HMAC-SHA256 scheme.

Responses

Name Type Description
200 OK

RoomModel

Request successful. The action returns a room.
Other Status Codes

CommunicationErrorResponse

Error response

Headers

x-ms-error-code: string

Security

Authorization

An authentication string containing a signature generated using HMAC-SHA256 scheme.

Type: apiKey
In: header

Examples

Get meeting room.

Sample Request

GET https://contoso.communication.azure.com//rooms/99117812428622880?api-version=2023-10-30-preview

Sample Response

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

Definitions

RoomModel

The meeting room.

Name Type Description
createdAt

string

The timestamp when the room was created at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
id

string

Unique identifier of a room. This id is server generated.
pstnDialOutEnabled

boolean

Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.
validFrom

string

The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
validUntil

string

The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.