Chat Thread - Get Chat Thread Properties

サービス:

Communication

API バージョン:

2024-03-07

チャット スレッドのプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
chatThreadId	path	True	string	スレッドの ID。
endpoint	path	True	string	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	ACS (Azure Communication Services) ユーザー アクセス トークン。

応答

名前	型	説明
200 OK	ChatThreadProperties	要求が成功しました。 アクションはチャット スレッドを返します。
401 Unauthorized	CommunicationErrorResponse	不正。
403 Forbidden	CommunicationErrorResponse	禁じられた。
429 Too Many Requests	CommunicationErrorResponse	要求が多すぎます。
Other Status Codes	CommunicationErrorResponse	サービスは使用できません。

セキュリティ

Authorization

ACS (Azure Communication Services) ユーザー アクセス トークン。

型: apiKey
/: 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

チャット スレッド。

名前	型	説明
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	チャット スレッドが作成されたときのタイムスタンプ。 タイムスタンプは yyyy-MM-ddTHH:mm:ssZRFC3339 形式です。
deletedOn	string	チャット スレッドが削除されたときのタイムスタンプ。 タイムスタンプは yyyy-MM-ddTHH:mm:ssZRFC3339 形式です。
id	string	チャット スレッド ID。
topic	string	チャット スレッドのトピック。