API-verwijzing voor de Bot Framework-Verbinding maken orservice

Artikel
10/27/2023

Notitie

De REST API is niet gelijk aan de SDK. De REST API wordt geleverd om standaard REST-communicatie toe te staan, maar de voorkeursmethode voor interactie met het Bot Framework is de SDK.

Binnen bot framework stelt de Bot Verbinding maken or-service uw bot in staat berichten uit te wisselen met gebruikers op kanalen die zijn geconfigureerd in de Bot Framework-portal. De service maakt gebruik van industriestandaard REST en JSON via HTTPS.

Basis-URI

Wanneer een gebruiker een bericht naar uw bot verzendt, bevat de binnenkomende aanvraag een activiteitsobject met een serviceUrl eigenschap waarmee het eindpunt wordt opgegeven waarnaar uw bot het antwoord moet verzenden. Als u toegang wilt krijgen tot de Bot Verbinding maken or-service, gebruikt u de serviceUrl waarde als de basis-URI voor API-aanvragen.

Als u nog geen service-URL voor het kanaal hebt, gebruikt https://smba.trafficmanager.net/teams/ u deze als service-URL. Zie voor meer informatie hoe u een gesprek en een proactief bericht maakt in Teams.

Stel dat uw bot de volgende activiteit ontvangt wanneer de gebruiker een bericht naar de bot verzendt.

{
    "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"
}

De serviceUrl eigenschap in het bericht van de gebruiker geeft aan dat de bot het antwoord naar het eindpunt https://smba.trafficmanager.net/teams/moet verzenden. De service-URL is de basis-URI voor eventuele volgende aanvragen die de bot in de context van dit gesprek uitgeeft. Als uw bot een proactief bericht naar de gebruiker moet verzenden, moet u de waarde van serviceUrl.

In het volgende voorbeeld ziet u de aanvraag waarmee de bot reageert op het bericht van de gebruiker.

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..."
}

Headers

Aanvraagheaders

Naast de standaard HTTP-aanvraagheaders moet elke API-aanvraag die u uitgeeft een header bevatten die een Authorization toegangstoken opgeeft om uw bot te verifiëren. Geef de Authorization header op met behulp van deze indeling:

Authorization: Bearer ACCESS_TOKEN

Zie Aanvragen van uw bot verifiëren bij de bot Verbinding maken orservice voor meer informatie over het verkrijgen van een toegangstoken voor uw bot.

Responsheaders

Naast de standaard HTTP-antwoordheaders bevat elk antwoord een X-Correlating-OperationId header. De waarde van deze header is een id die overeenkomt met de Vermelding van het Bot Framework-logboek, dat details over de aanvraag bevat. Wanneer u een foutbericht ontvangt, moet u de waarde van deze header vastleggen. Als u het probleem niet onafhankelijk kunt oplossen, neemt u deze waarde op in de informatie die u aan het ondersteuningsteam opgeeft wanneer u het probleem meldt.

HTTP-statuscode

De HTTP-statuscode die met elk antwoord wordt geretourneerd, geeft het resultaat van de bijbehorende aanvraag aan.

Notitie

In de volgende tabel worden de meest voorkomende HTTP-statuscodes beschreven. Sommige fouten worden gegenereerd door het kanaal. Mogelijk moet u de documentatie voor ontwikkelaars van het kanaal lezen voor meer informatie.

HTTP-statuscode	Betekenis
200	De aanvraag is voltooid.
201	De aanvraag is voltooid.
202	De aanvraag is geaccepteerd voor verwerking.
204	De aanvraag is voltooid, maar er is geen inhoud geretourneerd.
400	De aanvraag is onjuist of anderszins onjuist.
401	De bot is nog niet geverifieerd.
403	De bot is niet gemachtigd om de aangevraagde bewerking uit te voeren.
404	De aangevraagde resource is niet gevonden.
405	Het kanaal biedt geen ondersteuning voor de aangevraagde bewerking.
500	Er is een interne serverfout opgetreden.
503	De services zijn tijdelijk niet beschikbaar.

Fouten

Elk antwoord dat een HTTP-statuscode in het bereik 4xx of 5xx opgeeft, bevat een ErrorResponse-object in de hoofdtekst van het antwoord dat informatie over de fout bevat. Als u een foutbericht ontvangt in het bereik 4xx, inspecteert u het object ErrorResponse om de oorzaak van de fout te identificeren en het probleem op te lossen voordat u de aanvraag opnieuw indient.

Gespreksbewerkingen

Gebruik deze bewerkingen om gesprekken te maken, berichten (activiteiten) te verzenden en de inhoud van gesprekken te beheren.

Belangrijk

Niet alle kanalen ondersteunen alle eindpunten. Alle kanalen moeten echter het antwoord op het activiteitseindpunt ondersteunen.

Zo ondersteunen alleen Direct Line en Webchat het eindpunt voor het ophalen van gesprekken.

Operation	Beschrijving
Gesprek maken	Hiermee maakt u een nieuw gesprek.
Activiteit verwijderen	Hiermee verwijdert u een bestaande activiteit.
Gesprekslid verwijderen	Hiermee verwijdert u een lid uit een gesprek.
Activiteitsleden ophalen	Haalt de leden van de opgegeven activiteit op binnen het opgegeven gesprek.
Gesprekslid ophalen	Hiermee haalt u details op over een lid van een gesprek.
Gespreksleden ophalen	Haalt de leden van het opgegeven gesprek op.
Gepaginade leden van gesprek ophalen	Hiermee haalt u de leden van het opgegeven gesprek één pagina tegelijk op.
Gesprekken ophalen	Hiermee haalt u een lijst op met gesprekken waaraan de bot heeft deelgenomen.
Activiteit beantwoorden	Verzendt een activiteit (bericht) naar het opgegeven gesprek als antwoord op de opgegeven activiteit.
Gespreksgeschiedenis verzenden	Uploadt een transcriptie van eerdere activiteiten naar het gesprek.
Verzenden naar gesprek	Hiermee wordt een activiteit (bericht) verzonden naar het einde van het opgegeven gesprek.
Activiteit bijwerken	Hiermee wordt een bestaande activiteit bijgewerkt.
Bijlage uploaden naar kanaal	Uploadt een bijlage rechtstreeks naar de blobopslag van een kanaal.

Gesprek maken

Hiermee maakt u een nieuw gesprek.

POST /v3/conversations

Inhoud	Omschrijving
Aanvraagbody	Een ConversationParameters-object
Retouren	Een ConversationResourceResponse-object

Activiteit verwijderen

Met sommige kanalen kunt u een bestaande activiteit verwijderen. Als dit lukt, verwijdert deze bewerking de opgegeven activiteit uit het opgegeven gesprek.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een HTTP-statuscode die het resultaat van de bewerking aangeeft. Er wordt niets opgegeven in de hoofdtekst van het antwoord.

Gesprekslid verwijderen

Hiermee verwijdert u een lid uit een gesprek. Als dat lid het laatste lid van het gesprek was, wordt het gesprek ook verwijderd.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een HTTP-statuscode die het resultaat van de bewerking aangeeft. Er wordt niets opgegeven in de hoofdtekst van het antwoord.

Activiteitsleden ophalen

Haalt de leden van de opgegeven activiteit op binnen het opgegeven gesprek.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een matrix van ChannelAccount-objecten

Gesprekken ophalen

Hiermee haalt u een lijst op met gesprekken waaraan de bot heeft deelgenomen.

GET /v3/conversations?continuationToken={continuationToken}

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een ConversationsResult-object

Gesprekslid ophalen

Hiermee haalt u details op over een specifiek lid van een specifiek gesprek.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een ChannelAccount-object voor het lid.

Gespreksleden ophalen

Haalt de leden van het opgegeven gesprek op.

GET /v3/conversations/{conversationId}/members

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een matrix van ChannelAccount-objecten voor de leden van het gesprek.

Gepaginade leden van gesprek ophalen

Hiermee haalt u de leden van het opgegeven gesprek één pagina tegelijk op.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een PagedMembersResult-object

Activiteit beantwoorden

Verzendt een activiteit (bericht) naar het opgegeven gesprek als antwoord op de opgegeven activiteit. De activiteit wordt toegevoegd als antwoord op een andere activiteit als het kanaal deze ondersteunt. Als het kanaal geen ondersteuning biedt voor geneste antwoorden, gedraagt deze bewerking zich als Verzenden naar gesprek.

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

Inhoud	Omschrijving
Aanvraagbody	Een activiteitsobject
Retouren	Een ResourceResponse-object

Gespreksgeschiedenis verzenden

Uploadt een transcriptie van eerdere activiteiten naar het gesprek, zodat de client deze kan weergeven.

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

Inhoud	Omschrijving
Aanvraagbody	Een transcriptieobject .
Retouren	Een ResourceResponse-object .

Verzenden naar gesprek

Hiermee wordt een activiteit (bericht) verzonden naar het opgegeven gesprek. De activiteit wordt toegevoegd aan het einde van het gesprek volgens de tijdstempel of semantiek van het kanaal. Als u een specifiek bericht in het gesprek wilt beantwoorden, gebruikt u in plaats daarvan De activiteit Beantwoorden.

POST /v3/conversations/{conversationId}/activities

Inhoud	Omschrijving
Aanvraagbody	Een activiteitsobject
Retouren	Een ResourceResponse-object

Activiteit bijwerken

Met sommige kanalen kunt u een bestaande activiteit bewerken om de nieuwe status van een botgesprek weer te geven. U kunt bijvoorbeeld knoppen verwijderen uit een bericht in het gesprek nadat de gebruiker op een van de knoppen heeft geklikt. Als dit lukt, wordt met deze bewerking de opgegeven activiteit in het opgegeven gesprek bijgewerkt.

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

Inhoud	Omschrijving
Aanvraagbody	Een activiteitsobject
Retouren	Een ResourceResponse-object

Bijlage uploaden naar kanaal

Uploadt een bijlage voor het opgegeven gesprek rechtstreeks naar de blobopslag van een kanaal. Hiermee kunt u gegevens opslaan in een compatibele opslag.

POST /v3/conversations/{conversationId}/attachments

Inhoud	Omschrijving
Aanvraagbody	Een AttachmentData-object .
Retouren	Een ResourceResponse-object . De id-eigenschap geeft de bijlage-id op die kan worden gebruikt met de bewerking Bijlagegegevens ophalen en de bewerking Bijlage ophalen.

Bijlagebewerkingen

Gebruik deze bewerkingen om informatie over een bijlage op te halen, evenals de binaire gegevens voor het bestand zelf.

Operation	Beschrijving
Bijlagegegevens ophalen	Hiermee wordt informatie opgehaald over de opgegeven bijlage, inclusief bestandsnaam, bestandstype en de beschikbare weergaven (bijvoorbeeld origineel of miniatuur).
Bijlage ophalen	Hiermee haalt u de opgegeven weergave van de opgegeven bijlage op als binaire inhoud.

Bijlagegegevens ophalen

Hiermee wordt informatie opgehaald over de opgegeven bijlage, inclusief bestandsnaam, type en de beschikbare weergaven (bijvoorbeeld origineel of miniatuur).

GET /v3/attachments/{attachmentId}

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Een AttachmentInfo-object

Bijlage ophalen

Hiermee haalt u de opgegeven weergave van de opgegeven bijlage op als binaire inhoud.

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

Inhoud	Omschrijving
Aanvraagbody	n.v.t.
Retouren	Binaire inhoud die de opgegeven weergave van de opgegeven bijlage vertegenwoordigt

Statusbewerkingen (afgeschaft)

De Microsoft Bot Framework State-service wordt vanaf 30 maart 2018 buiten gebruik gesteld. Eerder hadden bots die zijn gebouwd op de Azure AI Bot Service of de Bot Builder SDK een standaardverbinding met deze service die wordt gehost door Microsoft om botstatusgegevens op te slaan. Bots moeten worden bijgewerkt om hun eigen statusopslag te kunnen gebruiken.

Operation	Beschrijving
`Set User Data`	Slaat statusgegevens op voor een specifieke gebruiker op een kanaal.
`Set Conversation Data`	Slaat statusgegevens op voor een specifiek gesprek op een kanaal.
`Set Private Conversation Data`	Slaat statusgegevens op voor een specifieke gebruiker binnen de context van een specifiek gesprek op een kanaal.
`Get User Data`	Haalt statusgegevens op die eerder zijn opgeslagen voor een specifieke gebruiker in alle gesprekken op een kanaal.
`Get Conversation Data`	Haalt statusgegevens op die eerder zijn opgeslagen voor een specifiek gesprek op een kanaal.
`Get Private Conversation Data`	Haalt statusgegevens op die eerder zijn opgeslagen voor een specifieke gebruiker binnen de context van een specifiek gesprek op een kanaal.
`Delete State For User`	Hiermee verwijdert u statusgegevens die eerder zijn opgeslagen voor een gebruiker.

Schema

Het Bot Framework-schema definieert de objecten en de bijbehorende eigenschappen die uw bot kan gebruiken om met een gebruiker te communiceren.

Object	Omschrijving
Activiteitsobject	Definieert een bericht dat wordt uitgewisseld tussen bot en gebruiker.
AnimatieCard-object	Definieert een kaart die GIF-animaties of korte video's kan afspelen.
Bijlageobject	Definieert aanvullende informatie die moet worden opgenomen in het bericht. Een bijlage kan een mediabestand zijn (bijvoorbeeld audio, video, afbeelding, bestand) of een uitgebreide kaart.
AttachmentData-object	Beschrijft een bijlagegegevens.
AttachmentInfo-object	Beschrijft een bijlage.
AttachmentView-object	Hiermee definieert u een object dat een beschikbare weergave voor een bijlage vertegenwoordigt.
AudioCard-object	Hiermee definieert u een kaart die een audiobestand kan afspelen.
CardAction-object	Definieert een actie die moet worden uitgevoerd.
CardImage-object	Hiermee definieert u een afbeelding die op een kaart moet worden weergegeven.
ChannelAccount-object	Hiermee definieert u een bot of gebruikersaccount in het kanaal.
ConversationAccount-object	Definieert een gesprek in een kanaal.
ConversationMembers-object	Definieert de leden van een gesprek.
Object ConversationParameters	Parameters definiëren voor het maken van een nieuw gesprek
ConversationReference-object	Definieert een bepaald punt in een gesprek.
ConversationResourceResponse-object	Definieert een antwoord op Gesprek maken.
ConversationsResult-object	Hiermee definieert u het resultaat van een oproep naar Gesprekken ophalen.
Entiteitsobject	Hiermee definieert u een entiteitsobject.
Foutobject	Definieert een fout.
ErrorResponse-object	Definieert een HTTP API-antwoord.
Feitobject	Definieert een sleutel-waardepaar dat een feit bevat.
GeoCoördinaten-object	Definieert een geografische locatie met behulp van WSG84-coördinaten (World Geodetic System).
HeroCard-object	Definieert een kaart met een grote afbeelding, titel, tekst en actieknoppen.
InnerHttpError-object	Object dat een interne HTTP-fout vertegenwoordigt.
MediaEventValue-object	Aanvullende parameter voor media-gebeurtenissen.
MediaUrl-object	Hiermee definieert u de URL naar de bron van een mediabestand.
Object vermelden	Hiermee definieert u een gebruiker of bot die in het gesprek is genoemd.
MessageReaction-object	Hiermee definieert u een reactie op een bericht.
PagedMembersResult-object	Pagina met leden die worden geretourneerd door Get Conversation Paged Members.
Object plaatsen	Definieert een plaats die in het gesprek is vermeld.
ReceiptCard-object	Hiermee definieert u een kaart die een ontvangstbewijs voor een aankoop bevat.
Object ReceiptItem	Hiermee definieert u een regelitem binnen een ontvangstbewijs.
ResourceResponse-object	Hiermee definieert u een resource.
SemanticAction-object	Definieert een verwijzing naar een programmatische actie.
SignInCard-object	Hiermee definieert u een kaart waarmee een gebruiker zich kan aanmelden bij een service.
Object SuggestedActions	Definieert de opties waaruit een gebruiker kan kiezen.
TextHighlight-object	Verwijst naar een subtekenreeks van inhoud binnen een ander veld.
ThumbnailCard-object	Definieert een kaart met een miniatuurafbeelding, titel, tekst en actieknoppen.
ThumbnailUrl-object	Hiermee definieert u de URL naar de bron van een afbeelding.
Transcriptieobject	Een verzameling activiteiten die moeten worden geüpload met gespreksgeschiedenis verzenden.
VideoCard-object	Definieert een kaart die video's kan afspelen.

Activiteitsobject

Definieert een bericht dat wordt uitgewisseld tussen bot en gebruiker.

Eigenschappen	Type	Omschrijving
action	String	De actie die moet worden toegepast of die is toegepast. Gebruik de eigenschap Type om de context voor de actie te bepalen. Als het type bijvoorbeeld contactRelationUpdate is, wordt de waarde van de actie-eigenschap toegevoegd als de gebruiker uw bot heeft toegevoegd aan de lijst met contactpersonen of verwijdert als deze de bot uit de lijst met contactpersonen heeft verwijderd.
attachmentLayout	String	Indeling van de uitgebreide kaartbijlagen die het bericht bevat. Een van deze waarden: carrousel, lijst. Zie Uitgebreide kaartbijlagen toevoegen aan berichten voor meer informatie over uitgebreide kaartbijlagen.
Bijlagen	Bijlage[]	Matrix van bijlageobjecten waarmee aanvullende informatie wordt gedefinieerd die in het bericht moet worden opgenomen. Elke bijlage kan een bestand zijn (bijvoorbeeld audio, video, afbeelding) of een uitgebreide kaart.
callerId	String	Een tekenreeks met een IRI die de aanroeper van een bot identificeert. Dit veld is niet bedoeld om via de kabel te worden verzonden, maar wordt in plaats daarvan gevuld door bots en clients op basis van cryptografische verifieerbare gegevens die de identiteit van de bellers (bijvoorbeeld tokens) bevestigen.
channelData	Object	Een object dat kanaalspecifieke inhoud bevat. Sommige kanalen bieden functies waarvoor aanvullende informatie nodig is die niet kan worden weergegeven met behulp van het bijlageschema. Voor deze gevallen stelt u deze eigenschap in op de kanaalspecifieke inhoud, zoals gedefinieerd in de documentatie van het kanaal. Zie Kanaalspecifieke functionaliteit implementeren voor meer informatie.
channelId	String	Een id die het kanaal uniek identificeert. Ingesteld door het kanaal.
code	String	Code die aangeeft waarom het gesprek is beëindigd.
Gesprek	ConversationAccount	Een ConversationAccount-object waarmee het gesprek wordt gedefinieerd waartoe de activiteit behoort.
deliveryMode	String	Een bezorgingshint om aan te geven aan de geadresseerde alternatieve bezorgingspaden voor de activiteit. Een van deze waarden: normaal, melding.
entities	object[]	Matrix van objecten die de entiteiten vertegenwoordigen die in het bericht zijn vermeld. Objecten in deze matrix kunnen elk Schema.org object zijn. De matrix kan bijvoorbeeld vermeldingsobjecten bevatten waarmee iemand wordt geïdentificeerd die in het gesprek is genoemd en objecten plaatsen die een plaats identificeren die in het gesprek is vermeld.
Verloop	String	Het tijdstip waarop de activiteit moet worden beschouwd als 'verlopen' en mag niet aan de ontvanger worden gepresenteerd.
van	ChannelAccount	Een ChannelAccount-object dat de afzender van het bericht aangeeft.
historyDisclosed	Booleaanse waarde	Vlag die aangeeft of de geschiedenis al dan niet wordt bekendgemaakt. De standaardwaarde is Onwaar.
id	String	Id waarmee de activiteit op het kanaal uniek wordt geïdentificeerd.
Belang	String	Definieert het belang van een activiteit. Een van deze waarden: laag, normaal, hoog.
inputHint	String	Waarde die aangeeft of uw bot gebruikersinvoer accepteert, verwacht of negeert nadat het bericht aan de client is bezorgd. Een van deze waarden: accepterenInput, verwachtInput, negerenInput.
label	String	Een beschrijvend label voor de activiteit.
listenFor	Tekenreeks[]	Lijst met woordgroepen en verwijzingen waarnaar spraak- en taalinstellingen moeten luisteren.
locale	String	Landinstelling van de taal die moet worden gebruikt om tekst in het bericht weer te geven, in de notatie `<language>-<country>`. Het kanaal gebruikt deze eigenschap om de taal van de gebruiker aan te geven, zodat uw bot weergavetekenreeksen in die taal kan opgeven. De standaardwaarde is en-US.
localTimestamp	String	Datum en tijd waarop het bericht is verzonden in de lokale tijdzone, uitgedrukt in ISO-8601-indeling .
localTimezone	String	Bevat de naam van de lokale tijdzone van het bericht, uitgedrukt in de database-indeling IANA Time Zone. Bijvoorbeeld Amerika/Los_Angeles.
membersAdded	ChannelAccount[]	Matrix van ChannelAccount-objecten die de lijst vertegenwoordigen van gebruikers die deelnemen aan het gesprek. Alleen aanwezig als het activiteitstype 'conversationUpdate' is en gebruikers deelnemen aan het gesprek.
membersRemoved	ChannelAccount[]	Matrix van ChannelAccount-objecten die de lijst met gebruikers vertegenwoordigen die het gesprek hebben verlaten. Alleen aanwezig als het activiteitstype 'conversationUpdate' is en gebruikers het gesprek hebben verlaten.
name	String	De naam van de bewerking die moet worden aangeroepen of de naam van de gebeurtenis.
reactionsAdded	MessageReaction[]	De verzameling reacties die aan het gesprek zijn toegevoegd.
reactionsRemoved	MessageReaction[]	De verzameling reacties die uit het gesprek zijn verwijderd.
Ontvanger	ChannelAccount	Een ChannelAccount-object waarmee de ontvanger van het bericht wordt opgegeven.
relateerto	ConversationReference	Een ConversationReference-object dat een bepaald punt in een gesprek definieert.
replyToId	String	De id van het bericht waarop dit bericht reageert. Als u een bericht wilt beantwoorden dat de gebruiker heeft verzonden, stelt u deze eigenschap in op de id van het bericht van de gebruiker. Niet alle kanalen ondersteunen threaded antwoorden. In deze gevallen negeert het kanaal deze eigenschap en gebruikt tijd geordende semantiek (tijdstempel) om het bericht toe te voegen aan het gesprek.
semanticAction	SemanticAction	Een SemanticAction-object dat een verwijzing naar een programmatische actie vertegenwoordigt.
serviceUrl	String	URL die het service-eindpunt van het kanaal aangeeft. Ingesteld door het kanaal.
Spreken	String	Tekst die door uw bot moet worden gesproken in een kanaal met spraak. Als u verschillende kenmerken van de spraak van uw bot wilt beheren, zoals spraak, snelheid, volume, uitspraak en toonhoogte, geeft u deze eigenschap op in de SSML-indeling (Speech Synthesis Markup Language).
suggestedActions	SuggestedActions	Een SuggestedActions-object waarmee de opties worden gedefinieerd waaruit de gebruiker kan kiezen.
Samenvatting	String	Samenvatting van de informatie die het bericht bevat. Voor een bericht dat wordt verzonden op een e-mailkanaal, kan deze eigenschap bijvoorbeeld de eerste 50 tekens van het e-mailbericht opgeven.
sms verzenden	String	Tekst van het bericht dat wordt verzonden van gebruiker naar bot of bot naar gebruiker. Zie de documentatie van het kanaal voor limieten die gelden voor de inhoud van deze eigenschap.
Textformat	String	Opmaak van de tekst van het bericht. Een van deze waarden: markdown, plain, xml. Zie Berichten maken voor meer informatie over de tekstindeling.
textHighlights	TextHighlight[]	De verzameling tekstfragmenten die moeten worden gemarkeerd wanneer de activiteit een replyToId-waarde bevat.
Tijdstempel	String	Datum en tijd waarop het bericht is verzonden in de UTC-tijdzone, uitgedrukt in ISO-8601-indeling .
topicName	String	Onderwerp van het gesprek waartoe de activiteit behoort.
type	String	Type activiteit. Een van deze waarden: bericht, contactRelationUpdate, conversationUpdate, typen, endOfConversation, gebeurtenis, aanroepen, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestie, trace, handoff. Zie Activiteitenoverzicht voor meer informatie over activiteitstypen.
value	Object	Open-ended waarde.
Valuetype	String	Het type waardeobject van de activiteit.

Eigenschappen	Type	Omschrijving
Aspect	Booleaanse waarde	Hoogte-breedteverhouding van tijdelijke aanduiding voor miniatuur/media. Toegestane waarden zijn '16:9' en '4:3'.
autoloop	Booleaanse waarde	Vlag die aangeeft of de lijst met gif-animaties opnieuw moet worden afgespeeld wanneer de laatste eindigt. Stel deze eigenschap in op true om de animatie automatisch opnieuw af te spelen; anders onwaar. De standaardwaarde is waar.
Autostart	Booleaanse waarde	Vlag die aangeeft of de animatie automatisch moet worden afgespeeld wanneer de kaart wordt weergegeven. Stel deze eigenschap in op True om de animatie automatisch af te spelen; anders onwaar. De standaardwaarde is waar.
Knoppen	CardAction[]	Matrix van CardAction-objecten waarmee de gebruiker een of meer acties kan uitvoeren. Het kanaal bepaalt het aantal knoppen dat u kunt opgeven.
Duur	String	De lengte van de media-inhoud, in ISO 8601-duurnotatie.
afbeelding	ThumbnailUrl	Een ThumbnailUrl-object dat de afbeelding opgeeft die op de kaart moet worden weergegeven.
Media	MediaUrl[]	Matrix van MediaUrl-objecten . Wanneer dit veld meer dan één URL bevat, is elke URL een alternatieve indeling van dezelfde inhoud.
Shareable	Booleaanse waarde	Vlag die aangeeft of de animatie kan worden gedeeld met anderen. Stel deze eigenschap in op true als de animatie kan worden gedeeld, anders onwaar. De standaardwaarde is waar.
Ondertitel	String	Ondertitel om weer te geven onder de titel van de kaart.
sms verzenden	String	Beschrijving of prompt om weer te geven onder de titel of subtitel van de kaart.
title	String	Titel van de kaart.
value	Object	Aanvullende parameter voor deze kaart.

Eigenschappen	Type	Omschrijving
Inhoud	Object	De inhoud van de bijlage. Als de bijlage een uitgebreide kaart is, stelt u deze eigenschap in op het uitgebreide kaartobject. Deze eigenschap en de eigenschap contentUrl sluiten elkaar wederzijds uit.
Contenttype	String	Het mediatype van de inhoud in de bijlage. Voor mediabestanden stelt u deze eigenschap in op bekende mediatypen, zoals afbeelding/png, audio/wav en video/mp4. Voor uitgebreide kaarten stelt u deze eigenschap in op een van deze leverancierspecifieke typen: application/vnd.microsoft.card.adaptive: een uitgebreide kaart die elke combinatie van tekst, spraak, afbeeldingen, knoppen en invoervelden kan bevatten. Stel de inhoudseigenschap in op een AdaptiveCard-object. application/vnd.microsoft.card.animation: een uitgebreide kaart die animatie afspeelt. Stel de inhoudseigenschap in op een AnimationCard-object. application/vnd.microsoft.card.audio: een uitgebreide kaart die audiobestanden afspeelt. Stel de inhoudseigenschap in op een AudioCard-object. application/vnd.microsoft.card.hero: A Hero card. Stel de inhoudseigenschap in op een HeroCard-object. application/vnd.microsoft.card.receipt: Een ontvangstbewijskaart. Stel de inhoudseigenschap in op een ReceiptCard-object. application/vnd.microsoft.card.signin: Een gebruikersaanmeldingskaart. Stel de inhoudseigenschap in op een SignInCard-object. application/vnd.microsoft.card.thumbnail: een miniatuurkaart. Stel de inhoudseigenschap in op een ThumbnailCard-object. application/vnd.microsoft.card.video: een uitgebreide kaart die video's afspeelt. Stel de inhoudseigenschap in op een VideoCard-object.
contentUrl	String	URL voor de inhoud van de bijlage. Als de bijlage bijvoorbeeld een afbeelding is, kunt u contentUrl instellen op de URL die de locatie van de afbeelding vertegenwoordigt. Ondersteunde protocollen zijn: HTTP, HTTPS, Bestand en Gegevens.
name	String	Naam van de bijlage.
thumbnailUrl	String	URL naar een miniatuurafbeelding die het kanaal kan gebruiken als het ondersteuning biedt voor het gebruik van een alternatieve, kleinere vorm van inhoud of contentUrl. Als u bijvoorbeeld contentType instelt op application/word en contentUrl instelt op de locatie van het Word-document, kunt u een miniatuurafbeelding opnemen die het document vertegenwoordigt. Het kanaal kan de miniatuurafbeelding weergeven in plaats van het document. Wanneer de gebruiker op de afbeelding klikt, zou het kanaal het document openen.

Eigenschappen	Type	Omschrijving
Grootte	Aantal	Grootte van het bestand.
viewId	String	Id weergeven.

Eigenschappen	Type	Omschrijving
Aspect	String	Hoogte-breedteverhouding van de miniatuur die is opgegeven in de eigenschap afbeelding . Geldige waarden zijn 16:9 en 4:3.
autoloop	Booleaanse waarde	Vlag die aangeeft of de lijst met audiobestanden opnieuw moet worden afgespeeld wanneer de laatste eindigt. Stel deze eigenschap in op True om de audiobestanden automatisch opnieuw af te spelen; anders onwaar. De standaardwaarde is waar.
Autostart	Booleaanse waarde	Vlag die aangeeft of de audio automatisch moet worden afgespeeld wanneer de kaart wordt weergegeven. Stel deze eigenschap in op true om de audio automatisch af te spelen; anders onwaar. De standaardwaarde is waar.
Knoppen	CardAction[]	Matrix van CardAction-objecten waarmee de gebruiker een of meer acties kan uitvoeren. Het kanaal bepaalt het aantal knoppen dat u kunt opgeven.
Duur	String	De lengte van de media-inhoud, in ISO 8601-duurnotatie.
afbeelding	ThumbnailUrl	Een ThumbnailUrl-object dat de afbeelding opgeeft die op de kaart moet worden weergegeven.
Media	MediaUrl[]	Matrix van MediaUrl-objecten . Wanneer dit veld meer dan één URL bevat, is elke URL een alternatieve indeling van dezelfde inhoud.
Shareable	Booleaanse waarde	Vlag die aangeeft of de audiobestanden met anderen kunnen worden gedeeld. Stel deze eigenschap in op true als de audio kan worden gedeeld, anders onwaar. De standaardwaarde is waar.
Ondertitel	String	Ondertitel om weer te geven onder de titel van de kaart.
sms verzenden	String	Beschrijving of prompt om weer te geven onder de titel of subtitel van de kaart.
title	String	Titel van de kaart.
value	Object	Aanvullende parameter voor deze kaart.

Eigenschappen	Type	Omschrijving
channelData	String	Kanaalspecifieke gegevens die aan deze actie zijn gekoppeld.
displayText	String	Tekst die moet worden weergegeven in de chatfeed als op de knop wordt geklikt.
afbeelding	String	Afbeeldings-URL die wordt weergegeven op de knop, naast het tekstlabel.
sms verzenden	String	Tekst voor de actie.
title	String	Tekstbeschrijving die op de knop wordt weergegeven.
type	String	Type actie dat moet worden uitgevoerd. Zie Uitgebreide kaartbijlagen toevoegen aan berichten voor een lijst met geldige waarden.
value	Object	Aanvullende parameter voor de actie. Het gedrag van deze eigenschap is afhankelijk van het actietype. Zie Uitgebreide kaartbijlagen toevoegen aan berichten voor meer informatie.

Eigenschappen	Type	Omschrijving
Alt	String	Beschrijving van de afbeelding. Neem de beschrijving op ter ondersteuning van toegankelijkheid.
Tik	CardAction	Een CardAction-object dat de actie aangeeft die moet worden uitgevoerd als de gebruiker op de afbeelding tikt of klikt.
Url	String	URL naar de bron van de afbeelding of het binaire bestand base64 van de afbeelding (bijvoorbeeld `data:image/png;base64,iVBORw0KGgo...`).

Eigenschappen	Type	Omschrijving
aadObjectId	String	De object-id van dit account in Microsoft Entra-id.
id	String	Unieke id voor de gebruiker of bot in dit kanaal.
name	String	Weergavevriendelijke naam van de bot of gebruiker.
Role	String	Rol van de entiteit achter het account. Gebruiker of bot.

Eigenschappen	Type	Beschrijving
id	String	De gespreks-id.
Leden	ChannelAccount[]	Lijst met leden in dit gesprek.

Eigenschappen	Type	Omschrijving
Activiteit	Activiteit	Het eerste bericht dat naar het gesprek wordt verzonden wanneer het wordt gemaakt.
Bot	ChannelAccount	Kanaalaccountgegevens die nodig zijn om een bericht naar de bot te routeren.
channelData	Object	Kanaalspecifieke nettolading voor het maken van het gesprek.
isGroup	Booleaanse waarde	Geeft aan of dit een groepsgesprek is.
Leden	ChannelAccount[]	Kanaalaccountgegevens die nodig zijn om een bericht naar elke gebruiker te routeren.
tenantId	String	De tenant-id waarin het gesprek moet worden gemaakt.
topicName	String	Onderwerp van het gesprek. Deze eigenschap wordt alleen gebruikt als een kanaal dit ondersteunt.

Eigenschappen	Type	Omschrijving
activityId	String	Id waarmee de activiteit waarnaar dit object verwijst, uniek wordt geïdentificeerd.
Bot	ChannelAccount	Een ChannelAccount-object dat de bot identificeert in het gesprek waarnaar dit object verwijst.
channelId	String	Een id die het kanaal uniek identificeert in het gesprek waarnaar dit object verwijst.
Gesprek	ConversationAccount	Een ConversationAccount-object dat het gesprek definieert waarnaar dit object verwijst.
serviceUrl	String	URL die het service-eindpunt van het kanaal aangeeft in het gesprek waarnaar dit object verwijst.
gebruiker	ChannelAccount	Een ChannelAccount-object dat de gebruiker identificeert in het gesprek waarnaar dit object verwijst.

Eigenschappen	Type	Omschrijving
activityId	String	Id van de activiteit, indien verzonden.
id	String	Id van de resource.
serviceUrl	String	Service-eindpunt waarbij bewerkingen met betrekking tot het gesprek kunnen worden uitgevoerd.

Eigenschappen	Type	Omschrijving
Gesprekken	ConversationMembers[]	De leden in elk van de gesprekken.
continuationToken	String	Het vervolgtoken dat kan worden gebruikt in volgende aanroepen naar Gesprekken ophalen.

Eigenschappen	Type	Omschrijving
code	String	Foutcode.
innerHttpError	InnerHttpError	Object dat de interne HTTP-fout vertegenwoordigt.
bericht	String	Een beschrijving van de fout.

Eigenschappen	Type	Omschrijving
key	String	Naam van het feit. Bijvoorbeeld inchecken. De sleutel wordt gebruikt als label bij het weergeven van de waarde van het feit.
value	String	Waarde van het feit. Bijvoorbeeld 10 oktober 2016.

Eigenschappen	Type	Omschrijving
Hoogte	Aantal	Hoogte van de locatie.
Latitude	Aantal	Breedtegraad van de locatie.
lengtegraad	Aantal	Lengtegraad van de locatie.
name	String	Naam van de locatie.
type	String	Het type van dit object. Altijd ingesteld op GeoCoördinaten.

Eigenschappen	Type	Omschrijving
statusCode	Aantal	HTTP-statuscode van de mislukte aanvraag.
hoofdtekst	Object	Hoofdtekst van de mislukte aanvraag.

Eigenschappen	Type	Omschrijving
Profiel	String	Hint die de inhoud van de media beschrijft.
Url	String	URL naar de bron van het mediabestand.

Eigenschappen	Type	Omschrijving
Genoemd	ChannelAccount	Een ChannelAccount-object dat de gebruiker of de bot aangeeft die is vermeld. Sommige kanalen, zoals Slack, wijzen namen per gesprek toe, dus het is mogelijk dat de naam van de bot (in de eigenschap geadresseerde van het bericht) verschilt van de ingang die u hebt opgegeven toen u uw bot registreerde. De account-id's voor beide zijn echter hetzelfde.
sms verzenden	String	De gebruiker of bot zoals vermeld in het gesprek. Als het bericht bijvoorbeeld '@ColorBot mij een nieuwe kleur kiezen' is, wordt deze eigenschap ingesteld op @ColorBot. Niet alle kanalen stellen deze eigenschap in.
type	String	Het type van dit object. Altijd ingesteld op Vermelden.

Eigenschappen	Type	Omschrijving
Adres	Object	Adres van een plaats. Deze eigenschap kan een tekenreeks of een complex object van het type PostalAddress zijn.
Geo	Geocoördinaten	Een GeoCoördinaat-object dat de geografische coördinaten van de plaats aangeeft.
hasMap	Object	Wijs aan de plaats toe. Deze eigenschap kan een tekenreeks (URL) of een complex object van het type Kaart zijn.
name	String	Naam van de plaats.
type	String	Het type van dit object. Altijd ingesteld op Plaats.

Eigenschappen	Type	Beschrijving
afbeelding	CardImage	Een CardImage-object dat miniatuurafbeelding aangeeft die naast het regelitem moet worden weergegeven.
Prijs	String	Een tekenreeks met valutanotatie die de totale prijs aangeeft van alle aangeschafte eenheden.
Hoeveelheid	String	Een numerieke tekenreeks die het aantal aangeschafte eenheden aangeeft.
Ondertitel	String	Ondertitel die moet worden weergegeven onder de titel van het regelitem.
Tik	CardAction	Een CardAction-object dat de actie aangeeft die moet worden uitgevoerd als de gebruiker op het regelitem tikt of klikt.
sms verzenden	String	Beschrijving van het regelitem.
title	String	Titel van het regelitem.

Delen via

API-verwijzing voor de Bot Framework-Verbinding maken orservice

Basis-URI

Headers

Aanvraagheaders

Responsheaders

HTTP-statuscode

Fouten

Gespreksbewerkingen

Gesprek maken

Activiteit verwijderen

Gesprekslid verwijderen

Activiteitsleden ophalen

Gesprekken ophalen

Gesprekslid ophalen

Gespreksleden ophalen

Gepaginade leden van gesprek ophalen

Activiteit beantwoorden

Gespreksgeschiedenis verzenden

Verzenden naar gesprek

Activiteit bijwerken

Bijlage uploaden naar kanaal

Bijlagebewerkingen

Bijlagegegevens ophalen

Bijlage ophalen

Statusbewerkingen (afgeschaft)

Schema

Activiteitsobject

AnimatieCard-object

Bijlageobject

AttachmentData-object

AttachmentInfo-object

AttachmentView-object

AudioCard-object

CardAction-object

CardImage-object

ChannelAccount-object

ConversationAccount-object

ConversationMembers-object

Object ConversationParameters

ConversationReference-object

ConversationResourceResponse-object

ConversationsResult-object

Entiteitsobject

Foutobject

ErrorResponse-object

Feitobject

GeoCoördinaten-object

HeroCard-object

InnerHttpError-object

MediaEventValue-object

MediaUrl-object

Object vermelden

MessageReaction-object

PagedMembersResult-object

Object plaatsen

ReceiptCard-object

Object ReceiptItem

ResourceResponse-object

SemanticAction-object

SignInCard-object

Object SuggestedActions

TextHighlight-object

ThumbnailCard-object

ThumbnailUrl-object

Transcriptieobject

VideoCard-object

Aanvullende resources

Eigenschappen	Type	Omschrijving
entities	Object	Een object waarbij de waarde van elke eigenschap een entiteitsobject is.
id	String	Id van deze actie.
state	String	Status van deze actie. Toegestane waarden: starten, doorgaan, gereed.

Eigenschappen	Type	Omschrijving
Acties	CardAction[]	Matrix van CardAction-objecten die de voorgestelde acties definiëren.
to	Tekenreeks[]	Matrix van tekenreeksen met de id's van de geadresseerden aan wie de voorgestelde acties moeten worden weergegeven.

Eigenschappen	Type	Omschrijving
Voorkomen	Aantal	Exemplaar van het tekstveld in de tekst waarnaar wordt verwezen, als er meerdere bestaan.
sms verzenden	String	Hiermee definieert u het fragment van de tekst dat moet worden gemarkeerd.

Eigenschappen	Type	Omschrijving
Aspect	String	Hoogte-breedteverhouding van de video. 16:9 of 4:3.
autoloop	Booleaanse waarde	Vlag die aangeeft of de lijst met video's opnieuw moet worden afgespeeld wanneer de laatste eindigt. Stel deze eigenschap in op True om de video's automatisch opnieuw af te spelen; anders onwaar. De standaardwaarde is waar.
Autostart	Booleaanse waarde	Vlag die aangeeft of de video's automatisch moeten worden afgespeeld wanneer de kaart wordt weergegeven. Stel deze eigenschap in op true om de video's automatisch af te spelen; anders onwaar. De standaardwaarde is waar.
Knoppen	CardAction[]	Matrix van CardAction-objecten waarmee de gebruiker een of meer acties kan uitvoeren. Het kanaal bepaalt het aantal knoppen dat u kunt opgeven.
Duur	String	De lengte van de media-inhoud, in ISO 8601-duurnotatie.
afbeelding	ThumbnailUrl	Een ThumbnailUrl-object dat de afbeelding opgeeft die op de kaart moet worden weergegeven.
Media	MediaUrl[]	Matrix van MediaUrl. Wanneer dit veld meer dan één URL bevat, is elke URL een alternatieve indeling van dezelfde inhoud.
Shareable	Booleaanse waarde	Vlag die aangeeft of de video's kunnen worden gedeeld met anderen. Stel deze eigenschap in op waar als de video's kunnen worden gedeeld; anders onwaar. De standaardwaarde is waar.
Ondertitel	String	Ondertitel om weer te geven onder de titel van de kaart.
sms verzenden	String	Beschrijving of prompt om weer te geven onder de titel of subtitel van de kaart.
title	String	Titel van de kaart.
value	Object	Aanvullende parameter voor deze kaart