Freigeben über

Hinzufügen von Eingabehinweisen zu Nachrichten mit der Bot Connector-API

  • Artikel

Durch die Angabe eines Eingabehinweises für eine Nachricht können Sie angeben, ob Ihr Bot Benutzereingaben akzeptiert, erwartet oder ignoriert, nachdem die Nachricht an den Client gesendet wurde. Bei Kanälen, die dieses Feld unterstützen, können Clients dadurch den Zustand von Benutzereingabe-Steuerelementen entsprechend festlegen. Wenn beispielsweise der Eingabehinweis für eine Nachricht angibt, dass der Bot die Benutzereingabe ignoriert, kann der Client das Mikrofon schließen und das Eingabefeld deaktivieren, um die Eingabe durch den Benutzer zu verhindern.

Eingabe wird akzeptiert

Wenn Sie angeben möchten, dass Ihr Bot für die Eingabe passiv bereit ist, aber nicht auf eine Antwort des Benutzers wartet, legen Sie die Eigenschaft auf die inputHintAnnahmeinput innerhalb des Aktivitätsobjekts fest, das Ihre Nachricht darstellt. Bei vielen Kanälen wird dadurch das Eingabefeld des Clients aktiviert und das Mikrofon geschlossen, das aber weiterhin für den Benutzer verfügbar ist.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe akzeptiert. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.

POST https://smba.trafficmanager.net/teams/v3/conversations/abcd1234/activities/5d5cdc723
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "sender's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
   },
   "recipient": {
        "id": "1234abcd",
        "name": "recipient's name"
    },
    "text": "Here's a picture of the house I was telling you about.",
    "inputHint": "acceptingInput",
    "replyToId": "5d5cdc723"
}

Eingabe wird erwartet

Um anzugeben, dass Ihr Bot aktiv eine Antwort vom Benutzer erwartet, legen Sie im Aktivität-Objekt, das Ihre Nachricht darstellt, die Eigenschaft inputHint auf expectingInput fest. Bei Kanälen, die dies unterstützen, wird dadurch das Eingabefeld des Clients aktiviert und das Mikrofon geöffnet.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe erwartet. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.

POST https://smba.trafficmanager.net/teams/v3/conversations/abcd1234/activities/5d5cdc723
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "sender's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
   },
   "recipient": {
        "id": "1234abcd",
        "name": "recipient's name"
    },
    "text": "What is your favorite color?",
    "inputHint": "expectingInput",
    "replyToId": "5d5cdc723"
}

Eingabe wird ignoriert

Um anzugeben, dass Ihr Bot nicht bereit ist, Eingaben vom Benutzer zu empfangen, legen Sie die inputHint Eigenschaft auf " IgnorierenInput " innerhalb des Aktivitätsobjekts fest, das Ihre Nachricht darstellt. Bei Kanälen, die dies unterstützen, wird dadurch das Eingabefeld des Clients deaktiviert und das Mikrofon geschlossen.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe ignoriert. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.

POST https://smba.trafficmanager.net/teams/v3/conversations/abcd1234/activities/5d5cdc723
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "sender's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
   },
   "recipient": {
        "id": "1234abcd",
        "name": "recipient's name"
    },
    "text": "Please hold while I perform the calculation.",
    "inputHint": "ignoringInput",
    "replyToId": "5d5cdc723"
}

Zusätzliche Ressourcen