Chat Thread - Get Chat Thread Properties

Usługa:

Communication

Wersja interfejsu API:

2025-03-15

Pobiera właściwości wątku czatu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług ACS (Azure Communication Services).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ChatThreadProperties	Żądanie powiodło się. Akcja zwraca wątek czatu.
401 Unauthorized	CommunicationErrorResponse	Nieautoryzowane.
403 Forbidden	CommunicationErrorResponse	Zakazany.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa jest niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usług ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Get chat thread

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

401

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

Kod stanu:

403

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

Kod stanu:

429

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

Kod stanu:

503

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

Definicje

Nazwa	Opis
ChatThreadProperties	Wątek czatu.
NoneRetentionPolicy	Brak zasad przechowywania wątków.
ThreadCreationDateRetentionPolicy	Zasady przechowywania wątków oparte na dacie utworzenia wątku.

ChatThreadProperties

Objekt

Wątek czatu.

Nazwa	Typ	Opis
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string (date-time)	Sygnatura czasowa utworzenia wątku czatu. Znacznik czasu jest w formacie RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string (date-time)	Sygnatura czasowa usunięcia wątku czatu. Znacznik czasu jest w formacie RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	Identyfikator wątku czatu.
metadata	object	Kontekstowe metadane wątku. Metadane składają się z par nazwa/wartość. Całkowity rozmiar wszystkich par metadanych może wynosić do 1 KB.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Zasady przechowywania danych do automatycznego usuwania.
topic	string	Temat wątku czatu.

NoneRetentionPolicy

Objekt

Brak zasad przechowywania wątków.

Nazwa	Typ	Opis
kind	string: none	Typ zasad przechowywania

ThreadCreationDateRetentionPolicy

Objekt

Zasady przechowywania wątków oparte na dacie utworzenia wątku.

Nazwa	Typ	Opis
deleteThreadAfterDays	integer (int32)	Wskazuje, ile dni po utworzeniu wątku wątku zostanie usunięty.
kind	string: threadCreationDate	Typ zasad przechowywania