Chat Thread - Get Chat Thread Properties
チャット スレッドのプロパティを取得します。
GET {endpoint}/chat/threads/{chatThreadId}?api-version=2024-03-15-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
chat
|
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 |
要求が成功しました。 アクションはチャット スレッドを返します。 |
|
401 Unauthorized |
Communication |
権限がありません。 |
403 Forbidden |
Communication |
Forbidden. |
429 Too Many Requests |
Communication |
要求が多すぎます。 |
Other Status Codes |
Communication |
Service unavailable. (サービス利用不可。) |
セキュリティ
Authorization
ACS (Azure Communication Services) ユーザー アクセス トークン。
型:
apiKey
/:
header
例
Get chat thread
要求のサンプル
GET https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-15-preview
応答のサンプル
{
"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"
}
}
}
{
"error": {
"code": "Unauthorized",
"message": "Request is not authorized."
}
}
{
"error": {
"code": "Forbidden",
"message": "User is not allowed to perform specified action."
}
}
{
"error": {
"code": "TooManyRequests",
"message": "Rate limit exceeded."
}
}
{
"error": {
"code": "ServiceUnavailable",
"message": "The server is currently unable to handle the request."
}
}
定義
名前 | 説明 |
---|---|
Chat |
チャット スレッド。 |
None |
スレッド保持ポリシーはありません。 |
Thread |
スレッドの作成日に基づくスレッド保持ポリシー。 |
ChatThreadProperties
チャット スレッド。
名前 | 型 | 説明 |
---|---|---|
createdByCommunicationIdentifier |
Communication |
|
createdOn |
string |
チャット スレッドが作成されたときのタイムスタンプ。 タイムスタンプは RFC3339 形式です。 |
deletedOn |
string |
チャット スレッドが削除されたときのタイムスタンプ。 タイムスタンプは RFC3339 形式です。 |
id |
string |
チャット スレッド ID。 |
metadata |
object |
スレッドのコンテキスト メタデータ。 メタデータは、名前と値のペアで構成されます。 すべてのメタデータ ペアの合計サイズは、最大 1 KB です。 |
retentionPolicy | ChatRetentionPolicy: |
自動削除のデータ保持ポリシー。 |
topic |
string |
チャット スレッドのトピック。 |
NoneRetentionPolicy
スレッド保持ポリシーはありません。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
none |
アイテム保持ポリシーの種類 |
ThreadCreationDateRetentionPolicy
スレッドの作成日に基づくスレッド保持ポリシー。
名前 | 型 | 説明 |
---|---|---|
deleteThreadAfterDays |
integer |
スレッドの作成から何日後にスレッドが削除されるかを示します。 |
kind |
string:
thread |
アイテム保持ポリシーの種類 |