共用方式為

Chat Thread - Get Chat Thread Properties

  • 參考
服務:
Communication
API 版本:
2024-03-07

取得聊天對話的屬性。

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

URI 參數

名稱 位於 必要 類型 Description
chatThreadId
 path True

string

線程的標識碼。
endpoint
 path True

string

Azure 通訊資源的端點。
api-version
 query True

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

ACS （Azure 通訊服務） 使用者存取令牌。

回應

名稱 類型 Description
200 OK

ChatThreadProperties

要求成功。 動作會傳回聊天對話。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

ACS （Azure 通訊服務） 使用者存取令牌。

類型: apiKey
位於: header

範例

Get chat thread

範例要求

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

聊天對話。

名稱 類型 Description
createdByCommunicationIdentifier

CommunicationIdentifierModel

createdOn

string

建立聊天對話時的時間戳。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。
deletedOn

string

刪除聊天對話時的時間戳。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。
id

string

聊天對話標識碼。
topic

string

聊天對話主題。