API-referens för Bot Framework Anslut eller-tjänsten

Artikel
10/27/2023

Kommentar

REST-API:et motsvarar inte SDK:n. REST-API:et tillhandahålls för att tillåta standard-REST-kommunikation, men den föredragna metoden för att interagera med Bot Framework är SDK:n.

I Bot Framework gör bot Anslut or-tjänsten att roboten kan utbyta meddelanden med användare på kanaler som är konfigurerade i Bot Framework-portalen. Tjänsten använder branschstandard-REST och JSON via HTTPS.

Bas-URI

När en användare skickar ett meddelande till roboten innehåller den inkommande begäran ett aktivitetsobjekt med en serviceUrl egenskap som anger den slutpunkt som roboten ska skicka sitt svar till. Om du vill komma åt bot-Anslut eller-tjänsten använder du serviceUrl värdet som bas-URI för API-begäranden.

När du inte redan har en tjänst-URL för kanalen använder https://smba.trafficmanager.net/teams/ du som tjänst-URL. Mer information finns i skapa en konversation och ett proaktivt meddelande i Teams.

Anta till exempel att roboten tar emot följande aktivitet när användaren skickar ett meddelande till roboten.

{
    "type": "message",
    "id": "bf3cc9a2f5de...",
    "timestamp": "2016-10-19T20:17:52.2891902Z",
    "serviceUrl": "https://smba.trafficmanager.net/teams/",
    "channelId": "channel's name/id",
    "from": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
    "recipient": {
        "id": "12345678",
        "name": "bot's name"
    },
    "text": "Haircut on Saturday"
}

Egenskapen serviceUrl i användarens meddelande anger att roboten ska skicka sitt svar till slutpunkten https://smba.trafficmanager.net/teams/. Tjänst-URL:en är bas-URI:n för efterföljande begäranden som roboten utfärdar i samband med den här konversationen. Om roboten behöver skicka ett proaktivt meddelande till användaren måste du spara värdet för serviceUrl.

I följande exempel visas begäran om att roboten ska svara på användarens meddelande.

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

{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "bot's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
    },
   "recipient": {
        "id": "1234abcd",
        "name": "user's name"
    },
    "text": "I have several times available on Saturday!",
    "replyToId": "bf3cc9a2f5de..."
}

Sidhuvuden

Begärandehuvuden

Förutom standardrubrikerna för HTTP-begäran måste varje API-begäran som du utfärdar innehålla ett Authorization huvud som anger en åtkomsttoken för att autentisera din robot. Authorization Ange rubriken med det här formatet:

Authorization: Bearer ACCESS_TOKEN

Mer information om hur du hämtar en åtkomsttoken för din robot finns i Autentisera begäranden från roboten till robotens Anslut eller-tjänst.

Svarsrubriker

Förutom standardrubrikerna för HTTP-svar innehåller varje svar ett X-Correlating-OperationId huvud. Värdet för det här huvudet är ett ID som motsvarar Bot Framework-loggposten, som innehåller information om begäran. När du får ett felsvar bör du samla in värdet för det här huvudet. Om du inte kan lösa problemet oberoende av varandra kan du inkludera det här värdet i den information som du anger för supportteamet när du rapporterar problemet.

HTTP-statuskoder

HTTP-statuskoden som returneras med varje svar anger resultatet av motsvarande begäran.

Kommentar

I följande tabell beskrivs de vanligaste HTTP-statuskoderna. Vissa fel genereras av kanalen. Om du vill ha mer information kan du behöva läsa kanalens utvecklardokumentation.

HTTP-statuskod	Innebörd
200	Begäran lyckades.
201	Begäran lyckades.
202	Begäran godkändes för bearbetning.
204	Begäran lyckades men inget innehåll returnerades.
400	Begäran var felaktigt eller på annat sätt felaktig.
401	Roboten är ännu inte autentiserad.
403	Roboten har inte behörighet att utföra den begärda åtgärden.
404	Den begärda resursen hittades inte.
405	Kanalen stöder inte den begärda åtgärden.
500	Ett internt serverfel uppstod.
503	Tjänsten är inte tillgänglig för tillfället.

Fel

Alla svar som anger en HTTP-statuskod i intervallet 4xx eller 5xx innehåller ett ErrorResponse-objekt i brödtexten i svaret som innehåller information om felet. Om du får ett felsvar i 4xx-intervallet kontrollerar du ErrorResponse-objektet för att identifiera orsaken till felet och lösa problemet innan du skickar begäran igen.

Konversationsåtgärder

Använd dessa åtgärder för att skapa konversationer, skicka meddelanden (aktiviteter) och hantera innehållet i konversationer.

Viktigt!

Alla kanaler stöder inte alla slutpunkter. Alla kanaler bör dock ha stöd för svar på aktivitetsslutpunkten .

Till exempel stöder endast Direct Line och Webbchatt slutpunkten hämta konversationer.

Operation	Beskrivning
Skapa konversation	Skapar en ny konversation.
Ta bort aktivitet	Tar bort en befintlig aktivitet.
Ta bort konversationsmedlem	Tar bort en medlem från en konversation.
Hämta aktivitetsmedlemmar	Hämtar medlemmarna i den angivna aktiviteten i den angivna konversationen.
Hämta konversationsmedlem	Hämtar information om en medlem i en konversation.
Hämta konversationsmedlemmar	Hämtar medlemmarna i den angivna konversationen.
Hämta konversationssidiga medlemmar	Hämtar medlemmarna i den angivna konversationen en sida i taget.
Hämta konversationer	Hämtar en lista över konversationer som roboten har deltagit i.
Svara på aktivitet	Skickar en aktivitet (meddelande) till den angivna konversationen som ett svar på den angivna aktiviteten.
Skicka konversationshistorik	Laddar upp en avskrift av tidigare aktiviteter till konversationen.
Skicka till konversation	Skickar en aktivitet (meddelande) till slutet av den angivna konversationen.
Uppdatera aktivitet	Uppdateringar en befintlig aktivitet.
Ladda upp bifogad fil till kanalen	Laddar upp en bifogad fil direkt till en kanals bloblagring.

Skapa konversation

Skapar en ny konversation.

POST /v3/conversations

Innehåll	Description
Begärandetext	Ett ConversationParameters-objekt
Returer	Ett ConversationResourceResponse-objekt

Ta bort aktivitet

Med vissa kanaler kan du ta bort en befintlig aktivitet. Om åtgärden lyckas tas den angivna aktiviteten bort från den angivna konversationen.

DELETE /v3/conversations/{conversationId}/activities/{activityId}

Innehåll	Description
Begärandetext	saknas
Returer	En HTTP-statuskod som anger resultatet av åtgärden. Inget anges i svarets brödtext.

Ta bort konversationsmedlem

Tar bort en medlem från en konversation. Om medlemmen var den sista medlemmen i konversationen tas konversationen också bort.

DELETE /v3/conversations/{conversationId}/members/{memberId}

Innehåll	Description
Begärandetext	saknas
Returer	En HTTP-statuskod som anger resultatet av åtgärden. Inget anges i svarets brödtext.

Hämta aktivitetsmedlemmar

Hämtar medlemmarna i den angivna aktiviteten i den angivna konversationen.

GET /v3/conversations/{conversationId}/activities/{activityId}/members

Innehåll	Description
Begärandetext	saknas
Returer	En matris med ChannelAccount-objekt

Hämta konversationer

Hämtar en lista över konversationer som roboten har deltagit i.

GET /v3/conversations?continuationToken={continuationToken}

Innehåll	Description
Begärandetext	saknas
Returer	Ett ConversationsResult-objekt

Hämta konversationsmedlem

Hämtar information om en specifik medlem i en specifik konversation.

GET /v3/conversations/{conversationId}/members/{memberId}

Innehåll	Description
Begärandetext	saknas
Returer	Ett ChannelAccount-objekt för medlemmen.

Hämta konversationsmedlemmar

Hämtar medlemmarna i den angivna konversationen.

GET /v3/conversations/{conversationId}/members

Innehåll	Description
Begärandetext	saknas
Returer	En matris med ChannelAccount-objekt för konversationens medlemmar.

Hämta konversationssidiga medlemmar

Hämtar medlemmarna i den angivna konversationen en sida i taget.

GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}

Innehåll	Description
Begärandetext	saknas
Returer	Ett PagedMembersResult-objekt

Svara på aktivitet

Skickar en aktivitet (meddelande) till den angivna konversationen som ett svar på den angivna aktiviteten. Aktiviteten läggs till som ett svar på en annan aktivitet, om kanalen stöder den. Om kanalen inte stöder kapslade svar fungerar den här åtgärden som Skicka till konversation.

POST /v3/conversations/{conversationId}/activities/{activityId}

Innehåll	Description
Begärandetext	Ett aktivitetsobjekt
Returer	Ett ResourceResponse-objekt

Skicka konversationshistorik

Laddar upp en avskrift av tidigare aktiviteter till konversationen så att klienten kan återge dem.

POST /v3/conversations/{conversationId}/activities/history

Innehåll	Description
Begärandetext	Ett avskriftsobjekt .
Returer	Ett ResourceResponse-objekt .

Skicka till konversation

Skickar en aktivitet (meddelande) till den angivna konversationen. Aktiviteten läggs till i slutet av konversationen enligt tidsstämpeln eller semantiken för kanalen. Om du vill svara på ett visst meddelande i konversationen använder du Svara på aktivitet i stället.

POST /v3/conversations/{conversationId}/activities

Innehåll	Description
Begärandetext	Ett aktivitetsobjekt
Returer	Ett ResourceResponse-objekt

Uppdatera aktivitet

I vissa kanaler kan du redigera en befintlig aktivitet så att den återspeglar det nya tillståndet för en robotkonversation. Du kan till exempel ta bort knappar från ett meddelande i konversationen när användaren har klickat på någon av knapparna. Om åtgärden lyckas uppdateras den angivna aktiviteten i den angivna konversationen.

PUT /v3/conversations/{conversationId}/activities/{activityId}

Innehåll	Description
Begärandetext	Ett aktivitetsobjekt
Returer	Ett ResourceResponse-objekt

Ladda upp bifogad fil till kanalen

Laddar upp en bifogad fil för den angivna konversationen direkt till en kanals bloblagring. På så sätt kan du lagra data i ett kompatibelt lager.

POST /v3/conversations/{conversationId}/attachments

Innehåll	Description
Begärandetext	Ett AttachmentData-objekt .
Returer	Ett ResourceResponse-objekt . Egenskapen id anger det bifogade fil-ID som kan användas med åtgärden Hämta information om bifogade filer och åtgärden Hämta bifogad fil .

Åtgärder för bifogade filer

Använd dessa åtgärder för att hämta information om en bifogad fil samt binära data för själva filen.

Operation	Beskrivning
Hämta information om bifogade filer	Hämtar information om den angivna bifogade filen, inklusive filnamn, filtyp och tillgängliga vyer (till exempel original eller miniatyrbild).
Hämta bifogad fil	Hämtar den angivna vyn för den angivna bifogade filen som binärt innehåll.

Hämta information om bifogade filer

Hämtar information om den angivna bifogade filen, inklusive filnamn, typ och tillgängliga vyer (till exempel original eller miniatyrbild).

GET /v3/attachments/{attachmentId}

Innehåll	Description
Begärandetext	saknas
Returer	Ett AttachmentInfo-objekt

Hämta bifogad fil

Hämtar den angivna vyn för den angivna bifogade filen som binärt innehåll.

GET /v3/attachments/{attachmentId}/views/{viewId}

Innehåll	Description
Begärandetext	saknas
Returer	Binärt innehåll som representerar den angivna vyn för den angivna bifogade filen

Tillståndsåtgärder (inaktuella)

Microsoft Bot Framework State-tjänsten har dragits tillbaka från och med den 30 mars 2018. Tidigare hade robotar som byggdes på Azure AI Bot Service eller Bot Builder SDK en standardanslutning till den här tjänsten som microsoft använder för att lagra robottillståndsdata. Robotar måste uppdateras för att använda sin egen tillståndslagring.

Operation	Beskrivning
`Set User Data`	Lagrar tillståndsdata för en specifik användare på en kanal.
`Set Conversation Data`	Lagrar tillståndsdata för en specifik konversation på en kanal.
`Set Private Conversation Data`	Lagrar tillståndsdata för en specifik användare i kontexten för en specifik konversation på en kanal.
`Get User Data`	Hämtar tillståndsdata som tidigare har lagrats för en specifik användare i alla konversationer på en kanal.
`Get Conversation Data`	Hämtar tillståndsdata som tidigare har lagrats för en specifik konversation på en kanal.
`Get Private Conversation Data`	Hämtar tillståndsdata som tidigare har lagrats för en specifik användare i kontexten för en specifik konversation på en kanal.
`Delete State For User`	Tar bort tillståndsdata som tidigare har lagrats för en användare.

Schema

Bot Framework-schemat definierar de objekt och deras egenskaper som roboten kan använda för att kommunicera med en användare.

Objekt	Description
Aktivitetsobjekt	Definierar ett meddelande som utbyts mellan robot och användare.
Animeringskortobjekt	Definierar ett kort som kan spela upp animerade GIF-filer eller korta videor.
Objekt för bifogad fil	Definierar ytterligare information som ska inkluderas i meddelandet. En bifogad fil kan vara en mediefil (till exempel ljud, video, bild, fil) eller ett rtF-kort.
AttachmentData-objekt	Beskriver en bifogad fildata.
AttachmentInfo-objekt	Beskriver en bifogad fil.
AttachmentView-objekt	Definierar ett objekt som representerar en tillgänglig vy för en bifogad fil.
AudioCard-objekt	Definierar ett kort som kan spela upp en ljudfil.
CardAction-objekt	Definierar en åtgärd som ska utföras.
CardImage-objekt	Definierar en bild som ska visas på ett kort.
ChannelAccount-objekt	Definierar en robot eller ett användarkonto på kanalen.
ConversationAccount-objekt	Definierar en konversation i en kanal.
ConversationMembers-objekt	Definierar medlemmarna i en konversation.
ConversationParameters-objekt	Definiera parametrar för att skapa en ny konversation
ConversationReference-objekt	Definierar en viss punkt i en konversation.
ConversationResourceResponse-objekt	Definierar ett svar på Skapa konversation.
ConversationsResult-objekt	Definierar resultatet av ett anrop till Hämta konversationer.
Entitetsobjekt	Definierar ett entitetsobjekt.
Felobjekt	Definierar ett fel.
ErrorResponse-objekt	Definierar ett HTTP API-svar.
Faktaobjekt	Definierar ett nyckel/värde-par som innehåller ett fakta.
GeoCoordinates-objekt	Definierar en geografisk plats med hjälp av WSG84-koordinater (World Geodetic System).
HeroCard-objekt	Definierar ett kort med en stor bild, rubrik, text och åtgärdsknappar.
InnerHttpError-objekt	Objekt som representerar ett inre HTTP-fel.
MediaEventValue-objekt	Tilläggsparameter för mediehändelser.
MediaUrl-objekt	Definierar URL:en till en mediefils källa.
Omnämnandeobjekt	Definierar en användare eller robot som nämndes i konversationen.
MessageReaction-objekt	Definierar en reaktion på ett meddelande.
PagedMembersResult-objekt	Sida med medlemmar som returneras av Get Conversation Paged Members.
Placera objekt	Definierar en plats som nämndes i konversationen.
ReceiptCard-objekt	Definierar ett kort som innehåller ett kvitto för ett köp.
ReceiptItem-objekt	Definierar ett radobjekt i ett kvitto.
ResourceResponse-objekt	Definierar en resurs.
SemanticAction-objekt	Definierar en referens till en programmatisk åtgärd.
SignInCard-objekt	Definierar ett kort som låter en användare logga in på en tjänst.
SuggestedActions-objekt	Definierar de alternativ som en användare kan välja mellan.
TextHighlight-objekt	Refererar till en delsträng av innehåll i ett annat fält.
ThumbnailCard-objekt	Definierar ett kort med en miniatyrbild, rubrik, text och åtgärdsknappar.
ThumbnailUrl-objekt	Definierar URL:en till en bilds källa.
Avskriftsobjekt	En samling aktiviteter som ska laddas upp med hjälp av Skicka konversationshistorik.
Videocard-objekt	Definierar ett kort som kan spela upp videor.

Aktivitetsobjekt

Definierar ett meddelande som utbyts mellan robot och användare.

Egenskap	Type	Description
åtgärd	String	Den åtgärd som ska tillämpas eller som tillämpades. Använd typegenskapen för att fastställa kontexten för åtgärden. Om typen till exempel är contactRelationUpdate läggs värdet för åtgärdsegenskapen till om användaren har lagt till din robot i kontaktlistan eller tar bort om de har tagit bort roboten från kontaktlistan.
attachmentLayout	String	Layout för de omfattande kortbilagor som meddelandet innehåller. Ett av följande värden: karusell, lista. Mer information om omfattande kortbilagor finns i Lägga till omfattande kortbilagor i meddelanden.
Bilagor	Bifogad fil[]	Matris med bifogade objekt som definierar ytterligare information som ska inkluderas i meddelandet. Varje bifogad fil kan vara antingen en fil (till exempel ljud, video, bild) eller ett rtF-kort.
Callerid	String	En sträng som innehåller en IRI som identifierar anroparen för en robot. Det här fältet är inte avsett att överföras via kabeln, utan fylls i i stället av robotar och klienter baserat på kryptografiskt verifierbara data som bekräftar anroparnas identitet (till exempel token).
channelData	Objekt	Ett objekt som innehåller kanalspecifikt innehåll. Vissa kanaler tillhandahåller funktioner som kräver ytterligare information som inte kan representeras med hjälp av schemat för bifogade filer. I sådana fall anger du den här egenskapen till det kanalspecifika innehållet enligt definitionen i kanalens dokumentation. Mer information finns i Implementera kanalspecifika funktioner.
channelId	String	Ett ID som unikt identifierar kanalen. Anges av kanalen.
kod	String	Kod som anger varför konversationen har avslutats.
Konversation	ConversationAccount	Ett ConversationAccount-objekt som definierar konversationen som aktiviteten tillhör.
deliveryMode	String	Ett leveranstips för att signalera till mottagarens alternativa leveranssökvägar för aktiviteten. Ett av följande värden: normal, meddelande.
entiteter	object[]	Matris med objekt som representerar de entiteter som nämndes i meddelandet. Objekt i den här matrisen kan vara valfritt Schema.org objekt. Matrisen kan till exempel innehålla Omnämnandeobjekt som identifierar någon som nämndes i konversationen och Placera objekt som identifierar en plats som nämndes i konversationen.
Förfallodagen	String	Den tidpunkt då aktiviteten ska anses vara "upphörd" och bör inte presenteras för mottagaren.
från	ChannelAccount	Ett ChannelAccount-objekt som anger meddelandets avsändare.
historyDisclosed	Booleskt	Flagga som anger om historiken avslöjas eller inte. Standardvärdet är false.
id	String	ID som unikt identifierar aktiviteten på kanalen.
Betydelse	String	Definierar vikten av en aktivitet. Ett av följande värden: låg, normal, hög.
inputHint	String	Värde som anger om roboten accepterar, förväntar sig eller ignorerar användarindata när meddelandet har levererats till klienten. Ett av följande värden: acceptInput, expectInput, ignoringInput.
label	String	En beskrivande etikett för aktiviteten.
listenFor	Sträng[]	Lista över fraser och referenser som tal- och språkprimeringssystem ska lyssna efter.
nationella inställningar	String	Språkvariant för det språk som ska användas för att visa text i meddelandet i formatet `<language>-<country>`. Kanalen använder den här egenskapen för att ange användarens språk, så att roboten kan ange visningssträngar på det språket. Standardvärdet är en-US.
localTimestamp	String	Datum och tid då meddelandet skickades i den lokala tidszonen, uttryckt i ISO-8601-format .
localTimezone	String	Innehåller namnet på den lokala tidszonen för meddelandet, uttryckt i databasformatet IANA Tidszon. Till exempel Amerika/Los_Angeles.
medlemmarLägg till	ChannelAccount[]	Matris med ChannelAccount-objekt som representerar listan över användare som anslöt till konversationen. Presentera endast om aktivitetstypen är "conversationUpdate" och användarna har anslutit till konversationen.
membersRemoved	ChannelAccount[]	Matris med ChannelAccount-objekt som representerar listan över användare som lämnade konversationen. Presentera endast om aktivitetstypen är "conversationUpdate" och användarna har lämnat konversationen.
Namn	String	Namnet på den åtgärd som ska anropas eller namnet på händelsen.
reaktionerLägg till	MessageReaction[]	Samlingen av reaktioner som lagts till i konversationen.
reactionsRemoved	MessageReaction[]	Samlingen av reaktioner som tagits bort från konversationen.
Mottagaren	ChannelAccount	Ett ChannelAccount-objekt som anger mottagaren av meddelandet.
relatesTo	ConversationReference	Ett ConversationReference-objekt som definierar en viss punkt i en konversation.
replyToId	String	ID:t för meddelandet som det här meddelandet svarar på. Om du vill svara på ett meddelande som användaren skickade anger du den här egenskapen till ID:t för användarens meddelande. Alla kanaler stöder inte trådade svar. I dessa fall ignorerar kanalen den här egenskapen och använder tidsordnad semantik (tidsstämpel) för att lägga till meddelandet i konversationen.
semanticAction	SemanticAction	Ett SemanticAction-objekt som representerar en referens till en programmatisk åtgärd.
serviceUrl	String	URL som anger kanalens tjänstslutpunkt. Anges av kanalen.
Tala	String	Text som ska talas av roboten på en talaktiverad kanal. Om du vill kontrollera olika egenskaper för robotens tal, till exempel röst, frekvens, volym, uttal och tonhöjd, anger du den här egenskapen i SSML-format (Speech Synthesis Markup Language).
suggestedActions	Föreslagna åtgärder	Ett SuggestedActions-objekt som definierar de alternativ som användaren kan välja mellan.
Sammanfattning	String	Sammanfattning av den information som meddelandet innehåller. För ett meddelande som till exempel skickas i en e-postkanal kan den här egenskapen ange de första 50 tecknen i e-postmeddelandet.
text	String	Text för meddelandet som skickas från användare till robot eller robot till användare. Se kanalens dokumentation för begränsningar som gäller för innehållet i den här egenskapen.
Textformat	String	Format för meddelandets text. Ett av följande värden: markdown, plain, xml. Mer information om textformat finns i Skapa meddelanden.
textHighlights	TextHighlight[]	Samlingen med textfragment som ska markeras när aktiviteten innehåller ett replyToId-värde .
Tidsstämpel	String	Datum och tid då meddelandet skickades i UTC-tidszonen, uttryckt i ISO-8601-format .
topicName	String	Ämne för konversationen som aktiviteten tillhör.
typ	String	Typ av aktivitet. Ett av följande värden: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Mer information om aktivitetstyper finns i Översikt över aktiviteter.
värde	Objekt	Öppet värde.
Valuetype	String	Typen av aktivitetens värdeobjekt.

Egenskap	Type	Description
Aspekt	Booleskt	Proportioner mellan miniatyrbild/medieplatshållare. Tillåtna värden är "16:9" och "4:3".
autoloop	Booleskt	Flagga som anger om listan över animerade GIF-filer ska spelas upp igen när den sista slutar. Ange den här egenskapen till true för att automatiskt spela upp animeringen, annars falskt. Standardvärdet är sant.
autostart	Booleskt	Flagga som anger om animeringen ska spelas upp automatiskt när kortet visas. Ange den här egenskapen till true för att automatiskt spela upp animeringen, annars falskt. Standardvärdet är sant.
Knappar	CardAction[]	Matris med CardAction-objekt som gör det möjligt för användaren att utföra en eller flera åtgärder. Kanalen avgör hur många knappar du kan ange.
Varaktighet	String	Längden på medieinnehållet i ISO 8601-varaktighetsformat.
Bild	ThumbnailUrl	Ett ThumbnailUrl-objekt som anger vilken bild som ska visas på kortet.
Media	MediaUrl[]	Matris med MediaUrl-objekt . När det här fältet innehåller mer än en URL är varje URL ett alternativt format för samma innehåll.
Shareable	Booleskt	Flagga som anger om animeringen kan delas med andra. Ange den här egenskapen till true om animeringen kan delas, annars falskt. Standardvärdet är sant.
Underrubrik	String	Underrubrik som ska visas under kortets rubrik.
text	String	Beskrivning eller uppmaning att visa under kortets rubrik eller underrubrik.
Titel	String	Kortets rubrik.
värde	Objekt	Tilläggsparameter för det här kortet.

Egenskap	Type	Beskrivning
Innehåll	Objekt	Innehållet i den bifogade filen. Om den bifogade filen är ett rtF-kort anger du den här egenskapen till rich card-objektet. Den här egenskapen och egenskapen contentUrl är ömsesidigt uteslutande.
Contenttype	String	Medietypen för innehållet i den bifogade filen. För mediefiler anger du den här egenskapen till kända medietyper som bild/png, ljud/wav och video/mp4. För omfattande kort anger du den här egenskapen till en av dessa leverantörsspecifika typer: application/vnd.microsoft.card.adaptive: Ett rtF-kort som kan innehålla valfri kombination av text, tal, bilder, knappar och indatafält. Ange innehållsegenskapen till ett AdaptiveCard-objekt. application/vnd.microsoft.card.animation: Ett rtf-kort som spelar upp animering. Ange innehållsegenskapen till ett Animeringskort-objekt. application/vnd.microsoft.card.audio: Ett rich-kort som spelar upp ljudfiler. Ange innehållsegenskapen till ett AudioCard-objekt. application/vnd.microsoft.card.hero: Ett Hero-kort. Ange innehållsegenskapen till ett HeroCard-objekt. application/vnd.microsoft.card.receipt: Ett kvittokort. Ange innehållsegenskapen till ett ReceiptCard-objekt. application/vnd.microsoft.card.signin: Ett inloggningskort för användare. Ange innehållsegenskapen till ett SignInCard-objekt. application/vnd.microsoft.card.thumbnail: Ett miniatyrkort. Ange innehållsegenskapen till ett ThumbnailCard-objekt. application/vnd.microsoft.card.video: Ett omfattande kort som spelar upp videor. Ange innehållsegenskapen till ett VideoCard-objekt.
contentUrl	String	URL för innehållet i den bifogade filen. Om den bifogade filen till exempel är en bild kan du ange contentUrl till den URL som representerar bildens plats. Protokoll som stöds är: HTTP, HTTPS, Fil och Data.
Namn	String	Namnet på den bifogade filen.
thumbnailUrl	String	URL till en miniatyrbild som kanalen kan använda om den stöder en alternativ, mindre form av innehåll eller contentUrl. Om du till exempel anger contentType till program/ord och anger contentUrl till platsen för Word-dokumentet kan du inkludera en miniatyrbild som representerar dokumentet. Kanalen kan visa miniatyrbilden i stället för dokumentet. När användaren klickar på bilden öppnar kanalen dokumentet.

Egenskap	Type	Description
Aspekt	String	Proportioner för miniatyrbilden som anges i bildegenskapen. Giltiga värden är 16:9 och 4:3.
autoloop	Booleskt	Flagga som anger om du vill spela upp listan över ljudfiler när den sista slutar. Ange den här egenskapen till true för att automatiskt spela upp ljudfilerna, annars falskt. Standardvärdet är sant.
autostart	Booleskt	Flagga som anger om ljudet ska spelas upp automatiskt när kortet visas. Ställ in den här egenskapen på true för att automatiskt spela upp ljudet, annars falskt. Standardvärdet är sant.
Knappar	CardAction[]	Matris med CardAction-objekt som gör det möjligt för användaren att utföra en eller flera åtgärder. Kanalen avgör hur många knappar du kan ange.
Varaktighet	String	Längden på medieinnehållet i ISO 8601-varaktighetsformat.
Bild	ThumbnailUrl	Ett ThumbnailUrl-objekt som anger vilken bild som ska visas på kortet.
Media	MediaUrl[]	Matris med MediaUrl-objekt . När det här fältet innehåller mer än en URL är varje URL ett alternativt format för samma innehåll.
Shareable	Booleskt	Flagga som anger om ljudfilerna kan delas med andra. Ange den här egenskapen till true om ljudet kan delas, annars falskt. Standardvärdet är sant.
Underrubrik	String	Underrubrik som ska visas under kortets rubrik.
text	String	Beskrivning eller uppmaning att visa under kortets rubrik eller underrubrik.
Titel	String	Kortets rubrik.
värde	Objekt	Tilläggsparameter för det här kortet.

Egenskap	Type	Description
channelData	String	Kanalspecifika data som är associerade med den här åtgärden.
displayText	String	Text som ska visas i chattflödet om knappen klickas.
Bild	String	Bild-URL som visas på knappen bredvid textetiketten.
text	String	Text för åtgärden.
Titel	String	Textbeskrivning som visas på knappen.
typ	String	Typ av åtgärd som ska utföras. En lista över giltiga värden finns i Lägga till omfattande kortbilagor i meddelanden.
värde	Objekt	Tilläggsparameter för åtgärden. Beteendet för den här egenskapen varierar beroende på åtgärdstyp. Mer information finns i Lägga till omfattande kortbilagor i meddelanden.

Egenskap	Type	Description
Alt	String	Beskrivning av bilden. Du bör inkludera beskrivningen för att stödja hjälpmedel.
Tryck	CardAction	Ett CardAction-objekt som anger vilken åtgärd som ska utföras om användaren trycker eller klickar på bilden.
Url	String	URL till bildens källa eller base64-binärfilen för bilden (till exempel `data:image/png;base64,iVBORw0KGgo...`).

Egenskap	Type	Description
aadObjectId	String	Det här kontots objekt-ID i Microsoft Entra-ID.
id	String	Unikt ID för användaren eller roboten på den här kanalen.
Namn	String	Visningsvänligt namn på roboten eller användaren.
Roll	String	Rollen för entiteten bakom kontot. Antingen användare eller robot.

Egenskap	Type	Beskrivning
id	String	Konversations-ID:t.
Medlemmar	ChannelAccount[]	Lista över medlemmar i den här konversationen.

Egenskap	Type	Description
Aktivitet	Aktivitet	Det första meddelandet som ska skickas till konversationen när den skapas.
Bot	ChannelAccount	Kanalkontoinformation som behövs för att dirigera ett meddelande till roboten.
channelData	Objekt	Kanalspecifik nyttolast för att skapa konversationen.
isGroup	Booleskt	Anger om det här är en gruppkonversation.
Medlemmar	ChannelAccount[]	Kanalkontoinformation som behövs för att dirigera ett meddelande till varje användare.
tenantId	String	Klientorganisations-ID:t där konversationen ska skapas.
topicName	String	Samtalsämne. Den här egenskapen används endast om en kanal stöder den.

Egenskap	Type	Description
activityId	String	ID som unikt identifierar aktiviteten som det här objektet refererar till.
Bot	ChannelAccount	Ett ChannelAccount-objekt som identifierar roboten i konversationen som det här objektet refererar till.
channelId	String	Ett ID som unikt identifierar kanalen i konversationen som det här objektet refererar till.
Konversation	ConversationAccount	Ett ConversationAccount-objekt som definierar konversationen som det här objektet refererar till.
serviceUrl	String	URL som anger kanalens tjänstslutpunkt i konversationen som det här objektet refererar till.
användare	ChannelAccount	Ett ChannelAccount-objekt som identifierar användaren i konversationen som det här objektet refererar till.

Egenskap	Type	Description
activityId	String	ID för aktiviteten, om det skickas.
id	String	ID för resursen.
serviceUrl	String	Tjänstslutpunkt där åtgärder som rör konversationen kan utföras.

Egenskap	Type	Description
Storlek	Antal	Filens storlek.
viewId	String	Visa ID.

Egenskap	Type	Description
Samtal	ConversationMembers[]	Medlemmarna i var och en av konversationerna.
continuationToken	String	Fortsättningstoken som kan användas i efterföljande anrop till Hämta konversationer.

Egenskap	Type	Description
kod	String	Felkod.
innerHttpError	InnerHttpError	Objekt som representerar det inre HTTP-felet.
meddelande	String	Beskrivning av felet.

Egenskap	Type	Description
nyckel	String	Namnet på fakta. Till exempel Incheckning. Nyckeln används som en etikett när du visar faktavärdet.
värde	String	Värdet av faktumet. Till exempel den 10 oktober 2016.

Egenskap	Type	Description
Höjd	Antal	Höjning av platsen.
Latitude	Antal	Latitud för platsen.
Longitud	Antal	Longitud för platsen.
Namn	String	Namnet på platsen.
typ	String	Typen av det här objektet. Ställ alltid in på GeoCoordinates.

Egenskap	Type	Description
statusCode	Antal	HTTP-statuskod från den misslyckade begäran.
brödtext	Objekt	Brödtext från den misslyckade begäran.

Egenskap	Type	Description
Profil	String	Tips som beskriver mediets innehåll.
Url	String	URL till mediefilens källa.

Egenskap	Type	Description
Nämnde	ChannelAccount	Ett ChannelAccount-objekt som anger användaren eller roboten som nämndes. Vissa kanaler, till exempel Slack, tilldelar namn per konversation, så det är möjligt att robotens nämnda namn (i meddelandets mottagaregenskap ) kan skilja sig från handtaget som du angav när du registrerade roboten. Konto-ID:t för båda skulle dock vara desamma.
text	String	Användaren eller roboten som nämns i konversationen. Om meddelandet till exempel är "@ColorBot väljer mig en ny färg" anges den här egenskapen till @ColorBot. Det är inte alla kanaler som anger den här egenskapen.
typ	String	Objektets typ. Ställ alltid in på Omnämnande.

Egenskap	Type	Description
Adress	Objekt	Adress till en plats. Den här egenskapen kan vara en sträng eller ett komplext objekt av typen PostalAddress.
Geo	GeoKoordinater	Ett GeoCoordinates-objekt som anger platsens geografiska koordinater.
hasMap	Objekt	Mappa till platsen. Den här egenskapen kan vara en sträng (URL) eller ett komplext objekt av typen Map.
Namn	String	Namnet på platsen.
typ	String	Objektets typ. Ställ alltid in på Placera.

Egenskap	Type	Beskrivning
Bild	CardImage	Ett CardImage-objekt som anger miniatyrbild som ska visas bredvid radobjektet.
Pris	String	En valutaformaterad sträng som anger det totala priset för alla köpta enheter.
Kvantitet	String	En numerisk sträng som anger antalet köpta enheter.
Underrubrik	String	Underrubrik som ska visas under radobjektets rubrik.
Tryck	CardAction	Ett CardAction-objekt som anger vilken åtgärd som ska utföras om användaren trycker eller klickar på radobjektet.
text	String	Beskrivning av radobjektet.
Titel	String	Rubrik på radobjektet.

Egenskap	Type	Description
entiteter	Objekt	Ett objekt där värdet för varje egenskap är ett entitetsobjekt.
id	String	ID för den här åtgärden.
state	String	Tillståndet för den här åtgärden. Tillåtna värden: starta, fortsätta, klar.

Dela via

API-referens för Bot Framework Anslut eller-tjänsten

Bas-URI

Sidhuvuden

Begärandehuvuden

Svarsrubriker

HTTP-statuskoder

Fel

Konversationsåtgärder

Skapa konversation

Ta bort aktivitet

Ta bort konversationsmedlem

Hämta aktivitetsmedlemmar

Hämta konversationer

Hämta konversationsmedlem

Hämta konversationsmedlemmar

Hämta konversationssidiga medlemmar

Svara på aktivitet

Skicka konversationshistorik

Skicka till konversation

Uppdatera aktivitet

Ladda upp bifogad fil till kanalen

Åtgärder för bifogade filer

Hämta information om bifogade filer

Hämta bifogad fil

Tillståndsåtgärder (inaktuella)

Schema

Aktivitetsobjekt

Animeringskortobjekt

Objekt för bifogad fil

AttachmentData-objekt

AttachmentInfo-objekt

AttachmentView-objekt

AudioCard-objekt

CardAction-objekt

CardImage-objekt

ChannelAccount-objekt

ConversationAccount-objekt

ConversationMembers-objekt

ConversationParameters-objekt

ConversationReference-objekt

ConversationResourceResponse-objekt

ConversationsResult-objekt

Entitetsobjekt

Felobjekt

ErrorResponse-objekt

Faktaobjekt

GeoCoordinates-objekt

HeroCard-objekt

InnerHttpError-objekt

MediaEventValue-objekt

MediaUrl-objekt

Omnämnandeobjekt

MessageReaction-objekt

PagedMembersResult-objekt

Placera objekt

ReceiptCard-objekt

ReceiptItem-objekt

ResourceResponse-objekt

SemanticAction-objekt

SignInCard-objekt

SuggestedActions-objekt

TextHighlight-objekt

ThumbnailCard-objekt

ThumbnailUrl-objekt

Avskriftsobjekt

Videocard-objekt

Ytterligare resurser

Egenskap	Type	Description
Åtgärder	CardAction[]	Matris med CardAction-objekt som definierar de föreslagna åtgärderna.
to	Sträng[]	Matris med strängar som innehåller ID:t för de mottagare som de föreslagna åtgärderna ska visas för.

Egenskap	Type	Description
Förekomst	Antal	Förekomst av textfältet i den refererade texten, om det finns flera.
text	String	Definierar textfragmentet som ska markeras.

Egenskap	Type	Description
Aspekt	String	Bildförhållandet för videon. Antingen 16:9 eller 4:3.
autoloop	Booleskt	Flagga som anger om du vill spela upp listan över videor när den sista slutar. Ställ in den här egenskapen på true för att automatiskt spela upp videorna, annars falskt. Standardvärdet är sant.
autostart	Booleskt	Flagga som anger om videor ska spelas upp automatiskt när kortet visas. Ange den här egenskapen till true för att automatiskt spela upp videorna, annars falskt. Standardvärdet är sant.
Knappar	CardAction[]	Matris med CardAction-objekt som gör det möjligt för användaren att utföra en eller flera åtgärder. Kanalen avgör hur många knappar du kan ange.
Varaktighet	String	Längden på medieinnehållet i ISO 8601-varaktighetsformat.
Bild	ThumbnailUrl	Ett ThumbnailUrl-objekt som anger vilken bild som ska visas på kortet.
Media	MediaUrl[]	Matris med MediaUrl. När det här fältet innehåller mer än en URL är varje URL ett alternativt format för samma innehåll.
Shareable	Booleskt	Flagga som anger om videorna kan delas med andra. Ange den här egenskapen till true om videorna kan delas, annars falskt. Standardvärdet är sant.
Underrubrik	String	Underrubrik som ska visas under kortets rubrik.
text	String	Beskrivning eller uppmaning att visa under kortets rubrik eller underrubrik.
Titel	String	Kortets rubrik.
värde	Objekt	Tilläggsparameter för det här kortet