Share via

Rooms - List

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

Retrieves all created rooms.

GET {endpoint}/rooms?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.
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

RoomsCollection

Request successful. The action returns a collection of rooms.
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

List all rooms.

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "999058871389949120",
      "createdAt": "2023-06-06T05:55:41Z",
      "validFrom": "2023-06-07T07:55:41Z",
      "validUntil": "2023-06-08T15:55:41Z",
      "pstnDialOutEnabled": true
    },
    {
      "id": "99199690362660524",
      "createdAt": "2023-06-06T05:55:41Z",
      "validFrom": "2023-06-07T07:55:41Z",
      "validUntil": "2023-06-08T15:55:41Z",
      "pstnDialOutEnabled": false
    }
  ],
  "nextLink": "string"
}

Definitions

Name Description
RoomModel

The meeting room.
RoomsCollection

A collection of rooms.

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.

RoomsCollection

A collection of rooms.

Name Type Description
nextLink

string

If there are more rooms that can be retrieved, the next link will be populated.
value

RoomModel[]

A collection of rooms