Hello World

メッセージとイベントの送受信は通信のコア側面 エージェントとユーザーの間の やり取りですエージェントがユーザーにメッセージ、イベント、リクエストを送信する ユーザーが作成したメッセージとイベントを受信する JSON 形式で入力できます

サンプルデータを使用して会話のフローの例を以下に示します。 メッセージ、イベント、リクエストは、有用で有意義なインタラクションを生み出します。

この例では、ユーザーが会話を開始し、「Hello, I'm World!」と表示されている場合、エージェントは「Hello, World」と応答します。

  1. ユーザーがエージェントとの会話を開始します。
  2. ユーザーが回答の入力を開始すると、メッセージに入力イベントが送信されます。 できます。

    {
      "agent": "brands/1111/agents/2222",
      "conversationId": "3333",
      "customAgentId": "hello-world-bot",
      "requestId": "1234567890",
      "userStatus": {
        "isTyping": "true",
        "createTime": "2020-10-02T15:01:23.045123456Z",
      },
      "sendTime": "2020-10-02T15:01:24.045123456Z",
    }
    
  3. ユーザーが「Hello, I'm World!」を送信したとき受け取ります

    {
      "agent": "brands/1111/agents/2222",
      "conversationId": "3333",
      "customAgentId": "hello-world-bot",
      "requestId": "123123123",
      "message": {
        "messageId": "4444",
        "name": "conversations/12345/messages/67890",
        "text": "Hello! I'm World!",
        "createTime": "2020-10-02T15:05:23.045123456Z",
      },
      "context": {
        "entryPoint": "PLACESHEET",
        "userInfo": {
          "displayName": "Michael",
          "userDeviceLocale": "en",
        },
        "resolvedLocale": "en",
      }
      "sendTime": "2020-10-02T15:05:24.045123456Z",
    }
    
  4. エージェントが「Hello, World」を送信します。受け取ります

    curl -X POST "https://businessmessages.googleapis.com/v1/conversations/3333/messages" \
    -H "Content-Type: application/json" \
    -H "`oauth2l header --json path/to/service/account/key.json businessmessages`" \
    -d "{
        'messageId': '5555',
        'text': 'Hello, World',
        'representative': {
          'avatarImage': 'https://hello.world/avatar.jpg',
          'displayName': 'Hello World Agent',
          'representativeType': 'BOT'
      }
    }"
    
  5. メールが配信されると、ユーザーのデバイスから配信確認メッセージが届きます。

    {
      "agent": "brands/1111/agents/2222",
      "conversationId": "3333",
      "customAgentId": "hello-world-bot",
      "receipts" : {
        "receipts": [
          {
            "message": "conversations/3333/messages/5555",
            "receiptType": "DELIVERED",
          }
        ],
        "createTime": "2020-10-02T16:01:23.045123456Z",
      },
      "sendTime": "2020-10-02T16:01:24.045123456Z",
    }