Chat Thread - Get Chat Thread Properties

서비스:

Communication

API 버전:

2024-03-07

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

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

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) 사용자 액세스 토큰입니다.

형식: apiKey
In(다음 안에): header

예제

Get chat thread

샘플 요청

HTTP

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

샘플 응답

상태 코드:

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

상태 코드:

401

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

상태 코드:

403

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

상태 코드:

429

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

상태 코드:

503

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

정의

ChatThreadProperties

채팅 스레드.

Name	형식	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	채팅 스레드를 만든 타임스탬프입니다. 타임스탬프의 형식은 yyyy-MM-ddTHH:mm:ssZRFC3339.
deletedOn	string	채팅 스레드가 삭제된 타임스탬프입니다. 타임스탬프의 형식은 yyyy-MM-ddTHH:mm:ssZRFC3339.
id	string	채팅 스레드 ID입니다.
topic	string	채팅 스레드 토픽입니다.