Chat Thread - Get Chat Thread Properties

Referenz

Dienst:: Communication

API-Version:: 2024-03-15-preview

Ruft die Eigenschaften eines Chatthreads ab.

GET {endpoint}/chat/threads/{chatThreadId}?api-version=2024-03-15-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	Id des Threads.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufgerufenen API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS-Benutzerzugriffstoken (Azure Communication Services).

Antworten

Name	Typ	Beschreibung
200 OK	ChatThreadProperties	Anforderung erfolgreich. Die Aktion gibt einen Chatthread zurück.
401 Unauthorized	CommunicationErrorResponse	Nicht autorisiert.
403 Forbidden	CommunicationErrorResponse	Unzulässig.
429 Too Many Requests	CommunicationErrorResponse	Too many requests. (Zu viele Anforderungen.)
Other Status Codes	CommunicationErrorResponse	Service unavailable. (Dienst nicht verfügbar.)

Sicherheit

Authorization

Ein ACS-Benutzerzugriffstoken (Azure Communication Services).

Typ: apiKey
In: header

Beispiele

Get chat thread

Beispielanforderung

HTTP

GET https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-15-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
  "topic": "Lunch",
  "createdOn": "2020-06-06T05:55:41.6460000Z",
  "createdByCommunicationIdentifier": {
    "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
    "communicationUser": {
      "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    }
  }
}

Statuscode:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Statuscode:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Statuscode:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Statuscode:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definitionen

Name	Beschreibung
ChatThreadProperties	Chatthread
NoneRetentionPolicy	Keine Threadaufbewahrungsrichtlinie.
ThreadCreationDateRetentionPolicy	Threadaufbewahrungsrichtlinie basierend auf dem Threaderstellungsdatum.

ChatThreadProperties

Chatthread

Name	Typ	Beschreibung
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Der Zeitstempel, bei dem der Chatthread erstellt wurde. Der Zeitstempel hat RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Der Zeitstempel, zu dem der Chatthread gelöscht wurde. Der Zeitstempel hat RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Chatthread-ID.
metadata	object	Kontextmetadaten für den Thread. Die Metadaten bestehen aus Name-Wert-Paaren. Die Gesamtgröße aller Metadatenpaare kann bis zu 1 KB groß sein.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Datenaufbewahrungsrichtlinie für das automatische Löschen.
topic	string	Chatthreadthema.

NoneRetentionPolicy

Keine Threadaufbewahrungsrichtlinie.

Name	Typ	Beschreibung
kind	string: none	Aufbewahrungsrichtlinientyp

ThreadCreationDateRetentionPolicy

Threadaufbewahrungsrichtlinie basierend auf dem Threaderstellungsdatum.

Name	Typ	Beschreibung
deleteThreadAfterDays	integer	Gibt an, wie viele Tage nach der Threaderstellung der Thread gelöscht wird.
kind	string: threadCreationDate	Aufbewahrungsrichtlinientyp

Freigeben über