Direct Line API 1.1 で会話を開始する

[アーティクル]
03/08/2023

重要

この記事では、Direct Line API 1.1 を使用して会話を開始する方法について説明します。クライアントアプリケーションとボットの間に新しい接続を作成する場合は、代わりに Direct Line API 3.0 を使用してください。

Direct Line の会話はクライアントによって明示的に開かれ、ボットとクライアントが参加し、有効な資格情報を持っている限り続きます。会話が開いている間は、ボットとクライアントの両方がメッセージを送信できます。複数のクライアントが特定の会話に接続でき、各クライアントは、複数のユーザーの代理として参加できます。

新しい会話を開く

ボットとの新しい会話を開くには、次の要求を発行します。

POST https://directline.botframework.com/api/conversations
Authorization: Bearer SECRET_OR_TOKEN

以下のスニペットは、会話の開始要求と応答の例を示しています。

Request

POST https://directline.botframework.com/api/conversations
Authorization: Bearer RCurR_XV9ZA.cwA.BKA.iaJrC8xpy8qbOF5xnR2vtCX7CZj0LdjAPGfiCpg4Fv0y8qbOF5xPGfiCpg4Fv0y8qqbOF5x8qbOF5xn

Response

要求が成功した場合、応答には、その会話の ID、トークン、そのトークンの有効期限が切れるまでの秒数を示す値が含まれます。

HTTP/1.1 200 OK
[other headers]

{
  "conversationId": "abc123",
  "token": "RCurR_XV9ZA.cwA.BKA.iaJrC8xpy8qbOF5xnR2vtCX7CZj0LdjAPGfiCpg4Fv0y8qbOF5xPGfiCpg4Fv0y8qqbOF5x8qbOF5xn",
  "expires_in": 1800
}

会話の開始とトークンの生成の比較

会話の開始操作 (POST /api/conversations) とトークンの生成操作 (POST /api/tokens/conversation) は、どちらの操作も、1 つの会話にアクセスするために使用できる token を返すという点で類似しています。ただし、会話の開始操作は、会話の開始およびボットとの接触も行いますが、トークンの生成操作はそのどちらも行いません。

会話をすぐに開始するつもりの場合は、会話の開始操作を使用してください。トークンをクライアントに配布し、クライアントからの会話の開始を求める場合は、トークンの生成操作を使用してください。