다음을 통해 공유

Chat Thread - Get Chat Thread Properties

  • 참조
Service:
Communication
API Version:
2024-03-15-preview

채팅 스레드의 속성을 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
chatThreadId
 path True

string

스레드의 ID입니다.
endpoint
 path True

string

Azure Communication 리소스의 엔드포인트입니다.
api-version
 query True

string

호출할 API의 버전입니다.

요청 헤더

Name 필수 형식 Description
Authorization True

string

ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

응답

Name 형식 Description
200 OK

ChatThreadProperties

요청이 성공했습니다. 작업은 채팅 스레드를 반환합니다.
401 Unauthorized

CommunicationErrorResponse

권한이 없습니다.
403 Forbidden

CommunicationErrorResponse

사용할 수 없습니다.
429 Too Many Requests

CommunicationErrorResponse

요청이 너무 많습니다.
Other Status Codes

CommunicationErrorResponse

서비스를 사용할 수 없습니다.

보안

Authorization

ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

Type: apiKey
In: header

예제

Get chat thread

Sample Request

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

정의

Name Description
ChatThreadProperties

채팅 스레드.
NoneRetentionPolicy

스레드 보존 정책이 없습니다.
ThreadCreationDateRetentionPolicy

스레드 생성 날짜를 기반으로 하는 스레드 보존 정책입니다.

ChatThreadProperties

채팅 스레드.

Name 형식 Description
createdByCommunicationIdentifier

CommunicationIdentifierModel

createdOn

string

채팅 스레드를 만든 타임스탬프입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
deletedOn

string

채팅 스레드가 삭제된 타임스탬프입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
id

string

채팅 스레드 ID입니다.
metadata

object

스레드에 대한 컨텍스트 메타데이터입니다. 메타데이터는 이름/값 쌍으로 구성됩니다. 모든 메타데이터 쌍의 총 크기는 최대 1KB일 수 있습니다.
retentionPolicy ChatRetentionPolicy:

자동 삭제를 위한 데이터 보존 정책입니다.
topic

string

채팅 스레드 토픽.

NoneRetentionPolicy

스레드 보존 정책이 없습니다.

Name 형식 Description
kind string:

none

보존 정책 유형

ThreadCreationDateRetentionPolicy

스레드 생성 날짜를 기반으로 하는 스레드 보존 정책입니다.

Name 형식 Description
deleteThreadAfterDays

integer

스레드를 만든 후 스레드가 삭제될 일 수를 나타냅니다.
kind string:

threadCreationDate

보존 정책 유형