Chat Thread - Get Chat Thread Properties

Reference

Service:: Communication

API Version:: 2024-03-15-preview

Gets a chat thread's properties.

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

URI Parameters

Name	In	Required	Type	Description
chatThreadId	path	True	string	Id of the thread.
endpoint	path	True	string	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An ACS (Azure Communication Services) user access token.

Responses

Name	Type	Description
200 OK	ChatThreadProperties	Request successful. The action returns a chat thread.
401 Unauthorized	CommunicationErrorResponse	Unauthorized.
403 Forbidden	CommunicationErrorResponse	Forbidden.
429 Too Many Requests	CommunicationErrorResponse	Too many requests.
Other Status Codes	CommunicationErrorResponse	Service unavailable.

Security

Authorization

An ACS (Azure Communication Services) user access token.

Type: apiKey
In: header

Examples

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

Definitions

Name	Description
ChatThreadProperties	Chat thread.
NoneRetentionPolicy	No thread retention policy.
ThreadCreationDateRetentionPolicy	Thread retention policy based on thread creation date.

ChatThreadProperties

Chat thread.

Name	Type	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Chat thread id.
metadata	object	Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Data retention policy for auto deletion.
topic	string	Chat thread topic.

NoneRetentionPolicy

No thread retention policy.

Name	Type	Description
kind	string: none	Retention Policy Type

ThreadCreationDateRetentionPolicy

Thread retention policy based on thread creation date.

Name	Type	Description
deleteThreadAfterDays	integer	Indicates how many days after the thread creation the thread will be deleted.
kind	string: threadCreationDate	Retention Policy Type

Share via