Chat Thread - Get Chat Thread Properties

Dienst:

Communication

API-Version:

2024-03-07

Ruft die Eigenschaften eines Chatthreads ab.

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

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 API, die aufgerufen werden soll.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	ChatThreadProperties	Anforderung erfolgreich. Die Aktion gibt einen Chatthread zurück.
401 Unauthorized	CommunicationErrorResponse	Unbefugt.
403 Forbidden	CommunicationErrorResponse	Verboten.
429 Too Many Requests	CommunicationErrorResponse	Zu viele Anforderungen.
Other Status Codes	CommunicationErrorResponse	Der Dienst ist nicht verfügbar.

Sicherheit

Authorization

Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

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-07

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

ChatThreadProperties

Chatthread.

Name	Typ	Beschreibung
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Der Zeitstempel, zu dem der Chatthread erstellt wurde. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string	Der Zeitstempel, zu dem der Chatthread gelöscht wurde. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id	string	Chatthread-ID.
topic	string	Thema "Chatthread".