Chat Thread - Get Chat Thread Properties

Referens

Tjänst:: Communication

API-version:: 2024-03-15-preview

Hämtar en chatttråds egenskaper.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatThreadId	path	True	string	ID för tråden.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Svar

Name	Typ	Description
200 OK	ChatThreadProperties	Begäran lyckades. Åtgärden returnerar en chatttråd.
401 Unauthorized	CommunicationErrorResponse	Behörighet saknas.
403 Forbidden	CommunicationErrorResponse	Förbjudet.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Get chat thread

Exempelbegäran

HTTP

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

Exempelsvar

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

Statuskod:: 401

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

Statuskod:: 403

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

Statuskod:: 429

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

Statuskod:: 503

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

Definitioner

Name	Description
ChatThreadProperties	Chatttråd.
NoneRetentionPolicy	Ingen princip för trådkvarhållning.
ThreadCreationDateRetentionPolicy	Princip för trådkvarhållning baserat på datum då tråden skapades.

ChatThreadProperties

Chatttråd.

Name	Typ	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Tidsstämpeln när chatttråden skapades. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Tidsstämpeln när chatttråden togs bort. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Chatttråds-ID.
metadata	object	Kontextuella metadata för tråden. Metadata består av namn/värde-par. Den totala storleken på alla metadatapar kan vara upp till 1 KB i storlek.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Datakvarhållningsprincip för automatisk borttagning.
topic	string	Chatttrådsämne.

NoneRetentionPolicy

Ingen princip för trådkvarhållning.

Name	Typ	Description
kind	string: none	Typ av kvarhållningsprincip

ThreadCreationDateRetentionPolicy

Princip för trådkvarhållning baserat på datum då tråden skapades.

Name	Typ	Description
deleteThreadAfterDays	integer	Anger hur många dagar efter att tråden har skapats som tråden kommer att tas bort.
kind	string: threadCreationDate	Typ av kvarhållningsprincip

Dela via