Freigeben über

Rooms - List

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

Ruft alle erstellten Räume ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

url

Der Endpunkt der Azure Communication-Ressource.
api-version
 query True

string

Version der aufzurufenden API.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Eine Authentifizierungszeichenfolge mit einer Signatur, die mit dem HMAC-SHA256-Schema generiert wurde.

Antworten

Name Typ Beschreibung
200 OK

RoomsCollection

Anforderung erfolgreich. Die Aktion gibt eine Sammlung von Räumen zurück.
Other Status Codes

CommunicationErrorResponse

Fehlerantwort

Headers

x-ms-error-code: string

Sicherheit

Authorization

Eine Authentifizierungszeichenfolge mit einer Signatur, die mit dem HMAC-SHA256-Schema generiert wurde.

Type: apiKey
In: header

Beispiele

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"
}

Definitionen

Name Beschreibung
RoomModel

Der Besprechungsraum.
RoomsCollection

Eine Sammlung von Räumen.

RoomModel

Der Besprechungsraum.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel, zu dem der Raum auf dem Server erstellt wurde. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id

string

Eindeutiger Bezeichner eines Raums. Diese ID wird vom Server generiert.
pstnDialOutEnabled

boolean

Legen Sie dieses Flag auf true fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Kennzeichen ist standardmäßig auf „false“ festgelegt.
validFrom

string

Der Zeitstempel ab dem Zeitpunkt, an dem der Raum für den Beitritt geöffnet ist. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
validUntil

string

Der Zeitstempel, ab dem der Raum nicht mehr verknüpft werden kann. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.

RoomsCollection

Eine Sammlung von Räumen.

Name Typ Beschreibung
nextLink

string

Wenn mehr Räume abgerufen werden können, wird der nächste Link aufgefüllt.
value

RoomModel[]

Eine Sammlung von Räumen