Chat Thread - Get Chat Thread Properties

Service:

Communication

API-versie:

2024-03-07

Hiermee haalt u de eigenschappen van een chatthread op.

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

URI-parameters

Name	In	Vereist	Type	Description
chatThreadId	path	True	string	Id van de thread.
endpoint	path	True	string	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een ACS-gebruikerstoegangstoken (Azure Communication Services).

Antwoorden

Name	Type	Description
200 OK	ChatThreadProperties	Aanvraag is voltooid. De actie retourneert een chat-thread.
401 Unauthorized	CommunicationErrorResponse	Ongeoorloofd.
403 Forbidden	CommunicationErrorResponse	Verboden.
429 Too Many Requests	CommunicationErrorResponse	Te veel aanvragen.
Other Status Codes	CommunicationErrorResponse	De service is niet beschikbaar.

Beveiliging

Authorization

Een ACS-gebruikerstoegangstoken (Azure Communication Services).

Type: apiKey
In: header

Voorbeelden

Get chat thread

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

ChatThreadProperties

Object

Chatthread.

Name	Type	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string (date-time)	De tijdstempel waarop de chat-thread is gemaakt. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string (date-time)	De tijdstempel toen de chatthread werd verwijderd. De tijdstempel heeft RFC3339 indeling: yyyy-MM-ddTHH:mm:ssZ.
id	string	Chatthread-id.
topic	string	Chatthread-onderwerp.