Chat - Create Chat Thread

サービス:: Communication

API バージョン:: 2024-03-07

チャットスレッドを作成します。

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

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	ACS (Azure Communication Services) ユーザーアクセストークン。
repeatability-request-id		string	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability -Request-Id で要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-Id の値は、クライアントによって生成され、常にグローバルに一意の要求の識別子を表す不透明な文字列です。バージョン 4 (ランダム) UUID を使用することをお勧めします。

要求本文

名前	必須	型	説明
topic	True	string	チャットスレッドトピック。
participants		ChatParticipant[]	チャットスレッドに追加する参加者。

応答

名前	型	説明
201 Created	CreateChatThreadResult	スレッドが作成されると、`Location` ヘッダーには、新しく作成されたスレッドの URL が含まれます。
401 Unauthorized	CommunicationErrorResponse	不正。
403 Forbidden	CommunicationErrorResponse	禁じられた。
429 Too Many Requests	CommunicationErrorResponse	要求が多すぎます。
Other Status Codes	CommunicationErrorResponse	サービスは使用できません。

セキュリティ

Authorization

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

型: apiKey
/: header

例

Create chat thread

Create chat thread with repeatability request id header

Create chat thread

要求のサンプル

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads?api-version=2024-03-07

{
  "topic": "Lunch",
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
        }
      },
      "displayName": "Jane"
    },
    {
      "communicationIdentifier": {
        "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"
        }
      },
      "displayName": "Alex"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a"
        }
      },
      "displayName": "Bob"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b"
        }
      },
      "displayName": "Peter"
    }
  ]
}

応答のサンプル

状態コード:: 201

Location: https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2

{
  "chatThread": {
    "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
    "topic": "Lunch",
    "createdOn": "2020-06-06T05:55:41.6460000Z",
    "createdByCommunicationIdentifier": {
      "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
      "communicationUser": {
        "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
      }
    }
  },
  "invalidParticipants": [
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
      "code": "403",
      "message": "Permissions check failed"
    },
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
      "code": "404",
      "message": "Not found"
    }
  ]
}

状態コード:: 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."
  }
}

Create chat thread with repeatability request id header

要求のサンプル

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads?api-version=2024-03-07

{
  "topic": "Lunch",
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
        }
      },
      "displayName": "Jane"
    },
    {
      "communicationIdentifier": {
        "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"
        }
      },
      "displayName": "Alex"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a"
        }
      },
      "displayName": "Bob"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b"
        }
      },
      "displayName": "Peter"
    }
  ]
}

応答のサンプル

状態コード:: 201

Location: https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2

{
  "chatThread": {
    "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
    "topic": "Lunch",
    "createdOn": "2020-06-06T05:55:41.6460000Z",
    "createdByCommunicationIdentifier": {
      "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
      "communicationUser": {
        "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
      }
    }
  },
  "invalidParticipants": [
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
      "code": "403",
      "message": "Permissions check failed"
    },
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
      "code": "404",
      "message": "Not found"
    }
  ]
}

状態コード:: 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."
  }
}

定義

名前	説明
ChatParticipant	チャットスレッドの参加者。
ChatThreadProperties	チャットスレッド。
CreateChatThreadRequest	チャットスレッドを作成するための要求ペイロード。
CreateChatThreadResult	チャットスレッドの作成操作の結果。

ChatParticipant

Object

チャットスレッドの参加者。

名前	型	説明
communicationIdentifier	CommunicationIdentifierModel
displayName	string	チャット参加者の表示名。
shareHistoryTime	string (date-time)	チャット履歴が参加者と共有される時間。タイムスタンプは `yyyy-MM-ddTHH:mm:ssZ`RFC3339 形式です。

ChatThreadProperties

Object

チャットスレッド。

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

CreateChatThreadRequest

Object

チャットスレッドを作成するための要求ペイロード。

名前	型	説明
participants	ChatParticipant[]	チャットスレッドに追加する参加者。
topic	string	チャットスレッドトピック。

CreateChatThreadResult

Object

チャットスレッドの作成操作の結果。

名前	型	説明
chatThread	ChatThreadProperties	チャットスレッド。
invalidParticipants	CommunicationError[]	チャットスレッドに追加できなかった参加者。

次の方法で共有

Chat - Create Chat Thread

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

Create chat thread

要求のサンプル

応答のサンプル

Create chat thread with repeatability request id header

要求のサンプル

応答のサンプル

定義

ChatParticipant

ChatThreadProperties

CreateChatThreadRequest

CreateChatThreadResult