Chat Thread - Get Chat Thread Properties

Reference

Service:: Communication

API Version:: 2024-03-15-preview

Získá vlastnosti vlákna chatu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby ACS (Azure Communication Services).

Odpovědi

Name	Typ	Description
200 OK	ChatThreadProperties	Žádost byla úspěšná. Akce vrátí vlákno chatu.
401 Unauthorized	CommunicationErrorResponse	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Type: apiKey
In: header

Příklady

Get chat thread

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  }
}

Status code:: 401

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

Status code:: 403

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

Status code:: 429

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

Status code:: 503

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

Definice

Name	Description
ChatThreadProperties	Vlákno chatu.
NoneRetentionPolicy	Žádné zásady uchovávání vláken.
ThreadCreationDateRetentionPolicy	Zásady uchovávání vláken založené na datu vytvoření vlákna

ChatThreadProperties

Vlákno chatu.

Name	Typ	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Časové razítko, kdy se vlákno chatu vytvořilo. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Časové razítko, kdy bylo vlákno chatu odstraněno. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID vlákna chatu.
metadata	object	Kontextová metadata pro vlákno. Metadata se skládají z párů název/hodnota. Celková velikost všech dvojic metadat může být až 1 kB.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Zásady uchovávání dat pro automatické odstranění.
topic	string	Téma vlákna chatu.

NoneRetentionPolicy

Žádné zásady uchovávání vláken.

Name	Typ	Description
kind	string: none	Typ zásad uchovávání informací

ThreadCreationDateRetentionPolicy

Zásady uchovávání vláken založené na datu vytvoření vlákna

Name	Typ	Description
deleteThreadAfterDays	integer	Určuje, kolik dní po vytvoření vlákna bude vlákno odstraněno.
kind	string: threadCreationDate	Typ zásad uchovávání informací

Share via