Invoerhints toevoegen aan berichten met de Bot Connector-API
Door een invoerhint voor een bericht op te geven, kunt u aangeven of uw bot gebruikersinvoer accepteert, verwacht of negeert nadat het bericht aan de client is bezorgd. Voor kanalen die dit veld ondersteunen, kunnen clients hiermee de status van besturingselementen voor gebruikersinvoer dienovereenkomstig instellen. Als de invoerhint van een bericht bijvoorbeeld aangeeft dat de bot gebruikersinvoer negeert, kan de client de microfoon sluiten en het invoervak uitschakelen om te voorkomen dat de gebruiker invoer levert.
Invoer accepteren
Als u wilt aangeven dat uw bot passief gereed is voor invoer, maar niet op een antwoord van de gebruiker wacht, stelt u de inputHint eigenschap in op acceptingInput binnen het object Activity dat uw bericht vertegenwoordigt. Op veel kanalen zorgt dit ervoor dat het invoervak van de client wordt ingeschakeld en de microfoon wordt gesloten, maar nog steeds toegankelijk is voor de gebruiker.
In het volgende voorbeeld ziet u een aanvraag waarmee een bericht wordt verzonden en wordt aangegeven dat de bot invoer accepteert. In deze voorbeeldaanvraag vertegenwoordigt Direct Line de basis-URI; de basis-URI voor aanvragen die uw botproblemen veroorzaken, kunnen afwijken. Zie API-verwijzing voor meer informatie over het instellen van de basis-URI.
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"
}
Invoer wordt verwacht
Als u wilt aangeven dat uw bot actief wacht op een reactie van de gebruiker, stelt u de inputHint eigenschap in op expectingInput in het object Activity dat uw bericht vertegenwoordigt. Op kanalen die dit ondersteunen, zorgt dit ervoor dat het invoervak van de client wordt ingeschakeld en de microfoon is geopend.
In het volgende voorbeeld ziet u een aanvraag waarmee een bericht wordt verzonden en wordt aangegeven dat de bot invoer verwacht. In deze voorbeeldaanvraag vertegenwoordigt Direct Line de basis-URI; de basis-URI voor aanvragen die uw botproblemen veroorzaken, kunnen afwijken. Zie API-verwijzing voor meer informatie over het instellen van de basis-URI.
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"
}
Invoer negeren
Als u wilt aangeven dat uw bot niet klaar is om invoer van de gebruiker te ontvangen, stelt u de inputHint eigenschap in op ignoringInput in het object Activity dat uw bericht vertegenwoordigt. Op kanalen die dit ondersteunen, zorgt dit ervoor dat het invoervak van de client wordt uitgeschakeld en de microfoon wordt gesloten.
In het volgende voorbeeld ziet u een aanvraag waarmee een bericht wordt verzonden en wordt aangegeven dat de bot invoer negeert. In deze voorbeeldaanvraag vertegenwoordigt Direct Line de basis-URI; de basis-URI voor aanvragen die uw botproblemen veroorzaken, kunnen afwijken. Zie API-verwijzing voor meer informatie over het instellen van de basis-URI.
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"
}