Hinzufügen von Eingabehinweisen zu Nachrichten mit der Bot Connector-APIAdd input hints to messages with the Bot Connector API

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.By specifying an input hint for a message, you can indicate whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. Bei Kanälen, die dieses Feld unterstützen, können Clients dadurch den Zustand von Benutzereingabe-Steuerelementen entsprechend festlegen.For channels that support this field, this enables clients to set the state of user input controls accordingly. 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.For example, if a message's input hint indicates that the bot is ignoring user input, the client may close the microphone and disable the input box to prevent the user from providing input.

Eingabe wird akzeptiertAccepting input

Um anzugeben, dass Ihr Bot passiv für eine Eingabe bereit ist, aber keine Antwort vom Benutzer erwartet, legen Sie im Aktivität-Objekt, das Ihre Nachricht darstellt, die Eigenschaft inputHint auf acceptingInput fest.To indicate that your bot is passively ready for input but is not awaiting a response from the user, set the inputHint property to acceptingInput within the Activity object that represents your message. 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.On many channels, this will cause the client's input box to be enabled and microphone to be closed, but still accessible to the user.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe akzeptiert.The following example shows a request that sends a message and specifies that the bot is accepting input. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein.In this example request, Direct Line represents the base URI; the base URI for requests that your bot issues may be different. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.For details about setting the base URI, see API Reference.

POST https://smba.trafficmanager.net/apis/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 erwartetExpecting input

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.To indicate that your bot is actively awaiting a response from the user, set the inputHint property to expectingInput within the Activity object that represents your message. Bei Kanälen, die dies unterstützen, wird dadurch das Eingabefeld des Clients aktiviert und das Mikrofon geöffnet.On channels that support it, this will cause the client's input box to be enabled and microphone to be open.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe erwartet.The following example shows a request that sends a message and specifies that the bot is expecting input. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein.In this example request, Direct Line represents the base URI; the base URI for requests that your bot issues may be different. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.For details about setting the base URI, see API Reference.

POST https://smba.trafficmanager.net/apis/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 ignoriertIgnoring input

Um anzugeben, dass Ihr Bot nicht für den Empfang einer Eingabe vom Benutzer bereit ist, legen Sie im Aktivität-Objekt, das Ihre Nachricht darstellt, die Eigenschaft inputHint auf ignoringInput fest.To indicate that your bot is not ready to receive input from the user, set the inputHint property to ignoringInput within the Activity object that represents your message. Bei Kanälen, die dies unterstützen, wird dadurch das Eingabefeld des Clients deaktiviert und das Mikrofon geschlossen.On channels that support it, this will cause the client's input box to be disabled and microphone to be closed.

Das folgende Beispiel zeigt eine Anforderung, die eine Nachricht sendet, und gibt an, dass der Bot eine Eingabe ignoriert.The following example shows a request that sends a message and specifies that the bot is ignoring input. In dieser Beispielanforderung stellt Direct Line den Basis-URI dar. Der Basis-URI für Anforderungen, die Ihr Bot ausgibt, kann ein anderer sein.In this example request, Direct Line represents the base URI; the base URI for requests that your bot issues may be different. Weitere Informationen zum Festlegen des Basis-URI finden Sie in der API-Referenz.For details about setting the base URI, see API Reference.

POST https://smba.trafficmanager.net/apis/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 RessourcenAdditional resources