Cette page a été traduite par l'API Cloud Translation.

Authentifier l'utilisateur

Les agents ont généralement peu d'informations sur les utilisateurs avec lesquels ils communiquent, à l'exception des informations fournies par les utilisateurs au cours d'une conversation. Toutefois, les agents peuvent authentifier les utilisateurs avec OAuth pour confirmer leur identité, personnaliser les conversations et effectuer des actions pour le compte des utilisateurs.

Dans ce flux de conversation, l'utilisateur choisit d'ajouter des crédits à son compte, et l'agent l'invite à se connecter pour valider son identité, récupérer des informations connues sur l'utilisateur et passer une commande pour les crédits.

L'utilisateur commence la conversation avec l'agent.

Une fois que l'utilisateur commence à saisir une réponse, il envoie un événement de saisie à l'agent.

{
  "agent": "brands/1111/agents/2222",
  "conversationId": "3333",
  "customAgentId": "oauth",
  "requestId": "1234567890",
  "userStatus": {
    "isTyping": "true",
    "createTime": "2020-10-02T15:01:23.045123456Z",
  },
  "sendTime": "2020-10-02T15:01:24.045123456Z",
}

L'utilisateur envoie "Bonjour" et je souhaite ajouter 5 crédits à mon compte.

{
  "agent": "brands/1111/agents/2222",
  "conversationId": "3333",
  "customAgentId": "oauth",
  "requestId": "123123123",
  "message": {
    "messageId": "4444",
    "name": "conversations/12345/messages/67890",
    "text": "Hi, I'd like to add 5 credits to my account",
    "createTime": "2020-10-02T15:05:23.045123456Z",
  },
  "context": {
    "entryPoint": "PLACESHEET",
    "userInfo": {
      "displayName": "Michael",
      "userDeviceLocale": "en",
    },
    "resolvedLocale": "en",
  }
  "sendTime": "2020-10-02T15:05:24.045123456Z",
}

L'agent envoie "Je peux vous aider. Connectez-vous à votre compte pour continuer. Une suggestion d'authentification s'affiche.

clientId et scopes sont définis par le fournisseur OAuth. L'agent génère la valeur codeChallenge conformément aux exigences du fournisseur OAuth.

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': 'I can help you with that. Sign into your account to continue.',
  'suggestions': [
    {
      'AuthenticationRequest': {
        'clientId': 'oauth_client_id_1234567890',
        'codeChallenge': 'code_challenge',
        'scopes': [
          'account',
          'billing',
        ],
      },
    },
  ],
  'representative': {
    'avatarImage': 'https://oauth.agent/bot-avatar.jpg',
    'displayName': 'OAuth Agent',
    'representativeType': 'BOT'
  }
}"

L'utilisateur reçoit le message, appuie sur la suggestion de requête d'authentification et se connecte à son compte.

L'agent reçoit un message avec le code d'autorisation OAuth dans le champ authenticationResponse.code.

{
  "agent": "brands/1111/agents/2222",
  "conversationId": "3333",
  "customAgentId": "oauth",
  "requestId": "1234567895",
  "authenticationResponse": {
    "code": "fkhoe541658sfk684d135j186mngkjdrt5425415a2s1dfa68s4edf",
    },
  }
  "sendTime": "2020-10-02T15:01:24.045123456Z",
}

L'agent communique avec le fournisseur OAuth en échangeant le code d'autorisation contre un jeton d'accès et en récupérant les informations du compte de l'utilisateur.

L'agent envoie "Merci de vous être connecté". Vous disposez actuellement de 2 crédits. Pour confirmer, vous souhaitez que nous ajoutions cinq crédits à votre compte et que nous facturions votre mode de paiement par défaut comme message de réponse contenant "Oui" et "Non".

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': '7777',
  'text': 'Thanks for signing in. You currently have 2 credits. To confirm, you'd like to me to add 5 credits to your account and bill your default payment method?',
  'suggestions': [
    {
      'reply': {
        'text': 'Yes',
        'postbackData': 'process-transaction',
      },
    },
    {
      'reply': {
        'text': 'No',
        'postbackData': 'cancel-transaction',
      },
    },
  ],
  'representative': {
    'avatarImage': 'https://oauth.agent/bot-avatar.jpg',
    'displayName': 'OAuth Agent',
    'representativeType': 'BOT'
  }
}"

L'utilisateur appuie sur "Oui".

{
  "agent": "brands/1111/agents/2222",
  "conversationId": "3333",
  "customAgentId": "oauth",
  "requestId": "1234567898",
  "suggestionResponse": {
    "message": "conversations/333/messages/8888",
    "postbackData": "process-transaction",
    "createTime": "2020-10-02T15:01:26.045123456Z",
    "text": "Yes",
    "suggestionType": "REPLY",
  }
  "sendTime": "2020-10-02T15:01:27.045123456Z",
}

L'agent traite la transaction à l'aide du jeton d'accès OAuth, puis envoie le message "Excellent. Je viens d'ajouter cinq crédits à votre compte. Y a-t-il autre chose que je puisse faire pour vous aider ?

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': '9999',
  'text': 'Great. I just added 5 credits to your account. Is there anything else I can help you with?',
  'representative': {
    'avatarImage': 'https://oauth.agent/bot-avatar.jpg',
    'displayName': 'OAuth Agent',
    'representativeType': 'BOT'
  }
}"

L'utilisateur envoie "Non, merci".

{
  "agent": "brands/1111/agents/2222",
  "conversationId": "3333",
  "customAgentId": "oauth",
  "requestId": "123123133",
  "message": {
    "messageId": "4444",
    "name": "conversations/12345/messages/101010",
    "text": "No, thanks",
    "createTime": "2020-10-02T15:05:23.045123456Z",
  },
  "context": {
    "entryPoint": "PLACESHEET",
    "userInfo": {
      "displayName": "Michael",
      "userDeviceLocale": "en",
    },
    "resolvedLocale": "en",
  }
  "sendTime": "2020-10-02T15:05:28.045123456Z",
}

L'agent envoie "Merci de nous avoir contactés. Bonne journée !"

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': '11111111',
  'text': 'Thanks for contacting us. Have a great day!',
  'representative': {
    'avatarImage': 'https://oauth.agent/bot-avatar.jpg',
    'displayName': 'OAuth Agent',
    'representativeType': 'BOT'
  }
}"