Lägga till indatatips i meddelanden med Bot Connector-API:et
Genom att ange ett indatatips för ett meddelande kan du ange om roboten accepterar, förväntar sig eller ignorerar användarindata när meddelandet har levererats till klienten. För kanaler som stöder det här fältet gör detta att klienterna kan ange tillståndet för användarindatakontroller i enlighet med detta. Om till exempel ett meddelandes indatatips anger att roboten ignorerar användarindata kan klienten stänga mikrofonen och inaktivera indatarutan för att förhindra att användaren anger indata.
Acceptera indata
Om du vill ange att roboten inputHint är passivt redo för indata men inte väntar på något svar från användaren anger du egenskapen till acceptInput i aktivitetsobjektet som representerar ditt meddelande. På många kanaler gör detta att klientens indataruta aktiveras och mikrofonen stängs, men fortfarande är tillgänglig för användaren.
I följande exempel visas en begäran som skickar ett meddelande och anger att roboten accepterar indata. I den här exempelbegäran representerar Direct Line bas-URI:n. Bas-URI:n för begäranden om problem med din robot kan vara annorlunda. Mer information om hur du anger bas-URI finns i API-referens.
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"
}
Indata förväntas
Om du vill ange att roboten aktivt väntar på ett svar från användaren anger du inputHint egenskapen till expectInput i aktivitetsobjektet som representerar ditt meddelande. På kanaler som stöder det gör detta att klientens indataruta är aktiverad och att mikrofonen är öppen.
I följande exempel visas en begäran som skickar ett meddelande och anger att roboten förväntar sig indata. I den här exempelbegäran representerar Direct Line bas-URI:n. Bas-URI:n för begäranden om problem med din robot kan vara annorlunda. Mer information om hur du anger bas-URI finns i API-referens.
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"
}
Ignorerar indata
Ange att roboten inte är redo att ta emot indata från användaren genom att ange inputHint egenskapen till ignoringInput i aktivitetsobjektet som representerar ditt meddelande. På kanaler som stöder det gör detta att klientens inmatningsruta inaktiveras och mikrofonen stängs.
I följande exempel visas en begäran som skickar ett meddelande och anger att roboten ignorerar indata. I den här exempelbegäran representerar Direct Line bas-URI:n. Bas-URI:n för begäranden om problem med din robot kan vara annorlunda. Mer information om hur du anger bas-URI finns i API-referens.
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"
}