Informazioni di riferimento sulle API per il servizio Bot Framework Connector

Note

L'API REST non equivale all'SDK. L'API REST viene fornita per consentire la comunicazione REST standard, ma il metodo preferito per interagire con Bot Framework è l'SDK.

All'interno di Bot Framework, il servizio Bot Connector consente al bot di scambiare messaggi con gli utenti nei canali configurati nel portale di Bot Framework. Il servizio usa rest e JSON standard di settore su HTTPS.

URI di base

Quando un utente invia un messaggio al bot, la richiesta in ingresso contiene un oggetto Activity con una serviceUrl proprietà che specifica l'endpoint a cui il bot deve inviare la risposta. Per accedere al servizio Bot Connector, usare il serviceUrl valore come URI di base per le richieste API.

Quando non si ha già un URL del servizio per il canale, usare https://smba.trafficmanager.net/teams/ come URL del servizio. Per altre informazioni, vedere come creare una conversazione e un messaggio proattivo in Teams.

Si supponga, ad esempio, che il bot riceva l'attività seguente quando l'utente invia un messaggio al bot.

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

La serviceUrl proprietà all'interno del messaggio dell'utente indica che il bot deve inviare la risposta all'endpoint https://smba.trafficmanager.net/teams/. L'URL del servizio sarà l'URI di base per le richieste successive che il bot emette nel contesto di questa conversazione. Se il bot dovrà inviare un messaggio proattivo all'utente, assicurarsi di salvare il valore di serviceUrl.

L'esempio seguente mostra la richiesta che il bot invia per rispondere al messaggio dell'utente.

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

Intestazioni

Header di richiesta

Oltre alle intestazioni di richiesta HTTP standard, ogni richiesta API inviata deve includere un'intestazione Authorization che specifica un token di accesso per autenticare il bot. Specificare l'intestazione Authorization usando questo formato:

Authorization: Bearer ACCESS_TOKEN

Per informazioni dettagliate su come ottenere un token di accesso per il bot, vedere Autenticare le richieste dal bot al servizio Bot Connector.

Intestazioni di risposta

Oltre alle intestazioni di risposta HTTP standard, ogni risposta conterrà un'intestazione X-Correlating-OperationId . Il valore di questa intestazione è un ID che corrisponde alla voce di log di Bot Framework, che contiene informazioni dettagliate sulla richiesta. Quando si riceve una risposta di errore, è necessario acquisire il valore di questa intestazione. Se non è possibile risolvere il problema in modo indipendente, includere questo valore nelle informazioni fornite al team di supporto quando si segnala il problema.

Codici di stato HTTP

Il codice di stato HTTP restituito con ogni risposta indica il risultato della richiesta corrispondente.

Note

Nella tabella seguente vengono descritti i codici di stato HTTP più comuni. Alcuni errori vengono generati dal canale. Per altre informazioni, potrebbe essere necessario leggere la documentazione per sviluppatori del canale.

Codice di stato HTTP	Meaning
200	La richiesta è stata accolta.
201	La richiesta è stata accolta.
202	La richiesta è stata accettata per l'elaborazione.
204	La richiesta ha avuto esito positivo ma non è stato restituito alcun contenuto.
400	La richiesta non è valida o non è corretta.
401	Il bot non è ancora autenticato.
403	Il bot non è autorizzato a eseguire l'operazione richiesta.
404	La risorsa richiesta non è stata trovata.
405	Il canale non supporta l'operazione richiesta.
500	Si è verificato un errore interno del server.
503	Il servizio è temporaneamente non disponibile.

Errors

Qualsiasi risposta che specifica un codice di stato HTTP nell'intervallo 4xx o 5xx includerà un oggetto ErrorResponse nel corpo della risposta che fornisce informazioni sull'errore. Se viene visualizzata una risposta di errore nell'intervallo 4xx, esaminare l'oggetto ErrorResponse per identificare la causa dell'errore e risolvere il problema prima di inviare nuovamente la richiesta.

Operazioni di conversazione

Usare queste operazioni per creare conversazioni, inviare messaggi (attività) e gestire il contenuto delle conversazioni.

Importante

Non tutti i canali supportano tutti gli endpoint. Tuttavia, tutti i canali devono supportare la risposta all'endpoint dell'attività .

Ad esempio, solo Direct Line e chat Web supportano l'endpoint di recupero delle conversazioni.

Operation	Description
Creare una conversazione	Crea una nuova conversazione.
Elimina attività	Elimina un'attività esistente.
Eliminare un membro della conversazione	Rimuove un membro da una conversazione.
Ottenere i membri dell'attività	Ottiene i membri dell'attività specificata all'interno della conversazione specificata.
Ottenere un membro della conversazione	Ottiene i dettagli relativi a un membro di una conversazione.
Ottenere i membri della conversazione	Ottiene i membri della conversazione specificata.
Ottenere membri con pagine di conversazione	Ottiene i membri della conversazione specificata una pagina alla volta.
Ottenere conversazioni	Ottiene un elenco di conversazioni a cui il bot ha partecipato.
Rispondi all'attività	Invia un'attività (messaggio) alla conversazione specificata, come risposta all'attività specificata.
Invia cronologia conversazioni	Carica una trascrizione delle attività passate nella conversazione.
Invia alla conversazione	Invia un'attività (messaggio) alla fine della conversazione specificata.
Attività di aggiornamento	Aggiorna un'attività esistente.
Caricare l'allegato nel canale	Carica un allegato direttamente nell'archivio BLOB di un canale.

Creare una conversazione

Crea una nuova conversazione.

POST /v3/conversations

Contenuto	Description
Corpo della richiesta	Oggetto ConversationParameters
Resi	Oggetto ConversationResourceResponse

Elimina attività

Alcuni canali consentono di eliminare un'attività esistente. In caso di esito positivo, questa operazione rimuove l'attività specificata dalla conversazione specificata.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Codice di stato HTTP che indica il risultato dell'operazione. Non viene specificato alcun valore nel corpo della risposta.

Eliminare un membro della conversazione

Rimuove un membro da una conversazione. Se tale membro è l'ultimo membro della conversazione, verrà eliminata anche la conversazione.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Codice di stato HTTP che indica il risultato dell'operazione. Non viene specificato alcun valore nel corpo della risposta.

Ottenere i membri dell'attività

Ottiene i membri dell'attività specificata all'interno della conversazione specificata.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Matrice di oggetti ChannelAccount

Ottenere conversazioni

Ottiene un elenco di conversazioni a cui il bot ha partecipato.

GET /v3/conversations?continuationToken={continuationToken}

Contenuto	Description
Corpo della richiesta	n/a
Resi	Oggetto ConversationsResult

Ottenere un membro della conversazione

Ottiene informazioni dettagliate su un membro specifico di una conversazione specifica.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Oggetto ChannelAccount per il membro.

Inserisci i membri della conversazione

Ottiene i membri della conversazione specificata.

GET /v3/conversations/{conversationId}/members

Contenuto	Description
Corpo della richiesta	n/a
Resi	Matrice di oggetti ChannelAccount per i membri della conversazione.

Ottenere membri con pagine di conversazione

Ottiene i membri della conversazione specificata una pagina alla volta.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Oggetto PagedMembersResult

Rispondi all'attività

Invia un'attività (messaggio) alla conversazione specificata, come risposta all'attività specificata. L'attività verrà aggiunta come risposta a un'altra attività, se il canale lo supporta. Se il canale non supporta le risposte annidate, questa operazione si comporta come Invia a conversazione.

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

Contenuto	Description
Corpo della richiesta	Oggetto Activity
Resi	Oggetto ResourceResponse

Invia cronologia conversazioni

Carica una trascrizione delle attività passate nella conversazione in modo che il client possa eseguirne il rendering.

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

Contenuto	Description
Corpo della richiesta	Oggetto Transcript .
Resi	Oggetto ResourceResponse .

Invia alla conversazione

Invia un'attività (messaggio) alla conversazione specificata. L'attività verrà aggiunta alla fine della conversazione in base al timestamp o alla semantica del canale. Per rispondere a un messaggio specifico all'interno della conversazione, usare invece Rispondi all'attività .

POST /v3/conversations/{conversationId}/activities

Contenuto	Description
Corpo della richiesta	Oggetto Activity
Resi	Oggetto ResourceResponse

Attività di aggiornamento

Alcuni canali consentono di modificare un'attività esistente per riflettere il nuovo stato di una conversazione bot. Ad esempio, è possibile rimuovere pulsanti da un messaggio nella conversazione dopo che l'utente ha fatto clic su uno dei pulsanti. In caso di esito positivo, questa operazione aggiorna l'attività specificata all'interno della conversazione specificata.

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

Contenuto	Description
Corpo della richiesta	Oggetto Activity
Resi	Oggetto ResourceResponse

Caricare l'allegato nel canale

Carica un allegato per la conversazione specificata direttamente nell'archivio BLOB di un canale. In questo modo è possibile archiviare i dati in un archivio conforme.

POST /v3/conversations/{conversationId}/attachments

Contenuto	Description
Corpo della richiesta	Oggetto AttachmentData .
Resi	Oggetto ResourceResponse . La proprietà id specifica l'ID allegato che può essere usato con l'operazione Get attachment information (Ottieni informazioni sugli allegati ) e l'operazione Get attachment (Ottieni allegato ).

Operazioni di allegato

Utilizzare queste operazioni per recuperare informazioni su un allegato e i dati binari per il file stesso.

Operation	Description
Ottenere informazioni sugli allegati	Ottiene informazioni sull'allegato specificato, inclusi il nome del file, il tipo di file e le visualizzazioni disponibili, ad esempio originale o anteprima.
Ottieni allegato	Ottiene la visualizzazione specificata dell'allegato specificato come contenuto binario.

Note

Per gli allegati Direct Line ospitati, entrambe le operazioni degli allegati del connettore richiedono un token di accesso da bot a connettore nell'intestazioneAuthorization: Bearer <access_token>. Non usare un token di Direct Line segreto o di conversazione per queste richieste. Per informazioni dettagliate, vedere Autenticare le richieste dal bot al servizio Bot Connector.

Ottenere informazioni sugli allegati

Ottiene informazioni sull'allegato specificato, inclusi il nome del file, il tipo e le visualizzazioni disponibili, ad esempio originale o anteprima.

GET /v3/attachments/{attachmentId}

Contenuto	Description
Corpo della richiesta	n/a
Resi	Oggetto AttachmentInfo

Ottenere l'allegato

Ottiene la visualizzazione specificata dell'allegato specificato come contenuto binario.

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

Contenuto	Description
Corpo della richiesta	n/a
Resi	Contenuto binario che rappresenta la visualizzazione specificata dell'allegato specificato

Operazioni di stato (deprecate)

Il servizio di informazioni sullo stato di Microsoft Bot Framework è stato ritirato il 30 marzo 2018. In precedenza, i bot basati su Azure AI servizio Bot o Bot Builder SDK avevano una connessione predefinita a questo servizio ospitato da Microsoft per archiviare i dati sullo stato del bot. I bot dovranno essere aggiornati per usare il proprio spazio di archiviazione dello stato.

Operation	Description
`Set User Data`	Archivia i dati sullo stato per un utente specifico in un canale.
`Set Conversation Data`	Archivia i dati sullo stato per una conversazione specifica in un canale.
`Set Private Conversation Data`	Archivia i dati sullo stato per un utente specifico all'interno del contesto di una conversazione specifica in un canale.
`Get User Data`	Recupera i dati sullo stato archiviati in precedenza per un utente specifico in tutte le conversazioni in un canale.
`Get Conversation Data`	Recupera i dati sullo stato archiviati in precedenza per una conversazione specifica in un canale.
`Get Private Conversation Data`	Recupera i dati sullo stato archiviati in precedenza per un utente specifico all'interno del contesto di una conversazione specifica in un canale.
`Delete State For User`	Elimina i dati sullo stato archiviati in precedenza per un utente.

Schema

Lo schema di Bot Framework definisce gli oggetti e le relative proprietà che il bot può usare per comunicare con un utente.

oggetto	Description
Oggetto Activity	Definisce un messaggio scambiato tra bot e utente.
Oggetto AnimationCard	Definisce una scheda che può riprodurre GIF animate o brevi video.
Oggetto Attachment	Definisce informazioni aggiuntive da includere nel messaggio. Un allegato può essere un file multimediale (ad esempio audio, video, immagine, file) o una scheda avanzata.
Oggetto AttachmentData	Descrive i dati di un allegato.
Oggetto AttachmentInfo	Descrive un allegato.
Oggetto AttachmentView	Definisce un oggetto che rappresenta una visualizzazione disponibile per un allegato.
Oggetto AudioCard	Definisce una scheda in grado di riprodurre un file audio.
Oggetto CardAction	Definisce un'azione da eseguire.
Oggetto CardImage	Definisce un'immagine da visualizzare su una scheda.
Oggetto ChannelAccount	Definisce un bot o un account utente nel canale.
Oggetto ConversationAccount	Definisce una conversazione in un canale.
Oggetto ConversationMembers	Definisce i membri di una conversazione.
Oggetto ConversationParameters	Definire i parametri per la creazione di una nuova conversazione
Oggetto ConversationReference	Definisce un punto specifico in una conversazione.
Oggetto ConversationResourceResponse	Definisce una risposta a Crea conversazione.
Oggetto ConversationsResult	Definisce il risultato di una chiamata a Recupera conversazioni.
Oggetto entità	Definisce un oggetto entità.
Oggetto Error	Definisce un errore.
Oggetto ErrorResponse	Definisce una risposta API HTTP.
Oggetto Fact	Definisce una coppia chiave-valore che contiene un fatto.
Oggetto GeoCoordinates	Definisce una posizione geografica usando coordinate WSG84 (World Geodetic System).
Oggetto HeroCard	Definisce una scheda con un'immagine di grandi dimensioni, un titolo, un testo e pulsanti di azione.
Oggetto InnerHttpError	Oggetto che rappresenta un errore HTTP interno.
Oggetto MediaEventValue	Parametro supplementare per gli eventi multimediali.
Oggetto MediaUrl	Definisce l'URL dell'origine di un file multimediale.
Oggetto Mention	Definisce un utente o un bot menzionato nella conversazione.
Oggetto MessageReaction	Definisce una reazione a un messaggio.
Oggetto PagedMembersResult	Pagina dei membri restituiti da Get Conversation Paged Members.Page of members returned by Get Conversation Paged Members.
Oggetto Place	Definisce un luogo menzionato nella conversazione.
Oggetto ReceiptCard	Definisce una scheda contenente una ricevuta per un acquisto.
Oggetto ReceiptItem	Definisce una voce all'interno di una ricevuta.
Oggetto ResourceResponse	Definisce una risorsa.
Oggetto SemanticAction	Definisce un riferimento a un'azione programmatica.
Oggetto SignInCard	Definisce una scheda che consente a un utente di accedere a un servizio.
Oggetto SuggestedActions	Definisce le opzioni da cui un utente può scegliere.
Oggetto TextHighlight	Fa riferimento a una sottostringa del contenuto all'interno di un altro campo.
Oggetto ThumbnailCard	Definisce una scheda con un'immagine di anteprima, un titolo, un testo e pulsanti di azione.
Oggetto ThumbnailUrl	Definisce l'URL dell'origine di un'immagine.
Oggetto trascrizione	Raccolta di attività da caricare tramite Invia cronologia conversazioni.
Oggetto VideoCard	Definisce una scheda in grado di riprodurre video.

Oggetto Activity

Definisce un messaggio scambiato tra bot e utente.

Property	TIPO	Description
azione	Stringa	Azione da applicare o applicata. Utilizzare la proprietà type per determinare il contesto per l'azione. Ad esempio, se type è contactRelationUpdate, il valore della proprietà action verrà aggiunto se l'utente ha aggiunto il bot all'elenco dei contatti o rimosso se il bot è stato rimosso dall'elenco dei contatti.
attachmentLayout	Stringa	Layout degli allegati della scheda avanzata inclusi nel messaggio. Uno di questi valori: sequenza, elenco. Per altre informazioni sugli allegati di schede avanzate, vedere Aggiungere allegati di schede avanzate ai messaggi.
Allegati	Allegato[]	Matrice di oggetti Attachment che definisce informazioni aggiuntive da includere nel messaggio. Ogni allegato può essere un file (ad esempio audio, video, immagine) o una scheda avanzata.
callerId	Stringa	Stringa contenente un IRI che identifica il chiamante di un bot. Questo campo non è destinato a essere trasmesso in rete, ma viene popolato da bot e client basati su dati verificabili crittograficamente che asserisce l'identità dei chiamanti (ad esempio token).
channelData	oggetto	Un oggetto che contiene contenuto specifico del canale. Alcuni canali forniscono funzionalità che richiedono informazioni aggiuntive che non possono essere rappresentate usando lo schema degli allegati. Per questi casi, impostare questa proprietà sul contenuto specifico del canale, come definito nella documentazione del canale. Per altre informazioni, vedere Implementare funzionalità specifiche del canale.
channelId	Stringa	Un ID che identifica in modo unico il canale. Impostato dal canale.
code	Stringa	Codice che indica il motivo per cui la conversazione è terminata.
conversazione	ConversationAccount	Oggetto ConversationAccount che definisce la conversazione a cui appartiene l'attività.
deliveryMode	Stringa	Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. Uno di questi valori: normale, notifica.
entities	oggetto[]	Matrice di oggetti che rappresenta le entità menzionate nel messaggio. Gli oggetti in questa matrice possono essere qualsiasi oggetto Schema.org . Ad esempio, la matrice può includere oggetti Mention che identificano qualcuno che è stato menzionato nella conversazione e oggetti Place che identificano un luogo menzionato nella conversazione.
expiration	Stringa	Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.
from	ChannelAccount	Oggetto ChannelAccount che specifica il mittente del messaggio.
historyDisclosed	Boolean	Flag che indica se la cronologia viene divulgata o meno. Il valore predefinito è false.
id	Stringa	ID che identifica in modo univoco l'attività nel canale.
importance	Stringa	Definisce l'importanza di un'attività. Uno di questi valori: basso, normale, alto.
inputHint	Stringa	Valore che indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Uno di questi valori: accettareInput, expectingInput, ignoringInput.
label	Stringa	Etichetta descrittiva per l'attività.
listenFor	String[]	Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto.
impostazioni locali	Stringa	Impostazioni locali della lingua che deve essere usata per visualizzare il testo all'interno del messaggio, nel formato `<language>-<country>`. Il canale usa questa proprietà per indicare la lingua dell'utente, in modo che il bot possa specificare stringhe di visualizzazione in tale lingua. Il valore predefinito è en-US.
localTimestamp	Stringa	Data e ora in cui il messaggio è stato inviato nel fuso orario locale, espresso in formato ISO-8601 .
localTimezone	Stringa	Contiene il nome del fuso orario locale del messaggio, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.
membersAdded	ChannelAccount[]	Matrice di oggetti ChannelAccount che rappresenta l'elenco di utenti che hanno partecipato alla conversazione. Presente solo se il tipo di attività è "conversationUpdate" e gli utenti hanno partecipato alla conversazione.
membersRemoved	ChannelAccount[]	Matrice di oggetti ChannelAccount che rappresenta l'elenco di utenti che hanno lasciato la conversazione. Presente solo se il tipo di attività è "conversationUpdate" e gli utenti hanno lasciato la conversazione.
nome	Stringa	Nome dell'operazione da richiamare o il nome dell'evento.
reazioniAggiungi	MessageReaction[]	Raccolta di reazioni aggiunte alla conversazione.
reazioniRemoved	MessageReaction[]	Raccolta di reazioni rimosse dalla conversazione.
destinatario	ChannelAccount	Oggetto ChannelAccount che specifica il destinatario del messaggio.
relatesTo	ConversationReference	Oggetto ConversationReference che definisce un punto specifico in una conversazione.
replyToId	Stringa	ID del messaggio a cui risponde il messaggio. Per rispondere a un messaggio inviato dall'utente, impostare questa proprietà sull'ID del messaggio dell'utente. Non tutti i canali supportano le risposte thread. In questi casi, il canale ignorerà questa proprietà e userà la semantica ordinata del tempo (timestamp) per accodare il messaggio alla conversazione.
semanticAction	SemanticAction	Oggetto SemanticAction che rappresenta un riferimento a un'azione a livello di codice.
serviceUrl	Stringa	URL che specifica l'endpoint di servizio del canale. Impostato dal canale.
parlare	Stringa	Testo da pronunciare dal bot in un canale abilitato per il riconoscimento vocale. Per controllare varie caratteristiche del parlato del bot, ad esempio voce, frequenza, volume, pronuncia e passo, specificare questa proprietà in formato SSML (Speech Synthesis Markup Language).
suggestedActions	SuggestedActions	Oggetto SuggestedActions che definisce le opzioni tra cui l'utente può scegliere.
riepilogo	Stringa	Riepilogo delle informazioni contenute nel messaggio. Ad esempio, per un messaggio inviato su un canale di posta elettronica, questa proprietà può specificare i primi 50 caratteri del messaggio di posta elettronica.
testo	Stringa	Testo del messaggio inviato dall'utente al bot o al bot all'utente. Per i limiti imposti al contenuto di questa proprietà, vedere la documentazione del canale.
textFormat	Stringa	Formato del testo del messaggio. Uno di questi valori: markdown, plain, xml. Per informazioni dettagliate sul formato di testo, vedere Creare messaggi.
textHighlights	TextHighlight[]	Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore replyToId .
timestamp	Stringa	Data e ora in cui il messaggio è stato inviato nel fuso orario UTC, espresso in formato ISO-8601 .
topicName	Stringa	Argomento della conversazione a cui appartiene l'attività.
type	Stringa	Tipo di attività. Uno di questi valori: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Per informazioni dettagliate sui tipi di attività, vedere la specifica del protocollo attività.
valore	oggetto	Valore illimitato.
valueType	Stringa	Tipo dell'oggetto valore dell'attività.

Property	TIPO	Description
aspetto	Boolean	Proporzioni del segnaposto dell'anteprima/del supporto. I valori consentiti sono "16:9" e "4:3".
autoloop	Boolean	Flag che indica se riprodurre l'elenco di GIF animate al termine dell'ultimo. Impostare questa proprietà su true per riprodurre automaticamente l'animazione; in caso contrario, false. Il valore predefinito è true.
Avvio automatico	Boolean	Flag che indica se riprodurre automaticamente l'animazione quando viene visualizzata la scheda. Impostare questa proprietà su true per riprodurre automaticamente l'animazione; in caso contrario, false. Il valore predefinito è true.
Pulsanti	CardAction[]	Matrice di oggetti CardAction che consentono all'utente di eseguire una o più azioni. Il canale determina il numero di pulsanti che è possibile specificare.
duration	Stringa	Lunghezza del contenuto multimediale, in formato di durata ISO 8601.
image	ThumbnailUrl	Oggetto ThumbnailUrl che specifica l'immagine da visualizzare sulla scheda.
supporti	MediaUrl[]	Matrice di oggetti MediaUrl . Quando questo campo contiene più URL, ogni URL è un formato alternativo dello stesso contenuto.
condivisibile	Boolean	Flag che indica se l'animazione può essere condivisa con altri utenti. Impostare questa proprietà su true se l'animazione può essere condivisa; in caso contrario, false. Il valore predefinito è true.
Sottotitolo	Stringa	Sottotitolo da visualizzare sotto il titolo della scheda.
testo	Stringa	Descrizione o richiesta di visualizzazione sotto il titolo o il sottotitolo della scheda.
Titolo	Stringa	Titolo della carta.
valore	oggetto	Parametro supplementare per questa scheda.

Property	TIPO	Description
contenuto	oggetto	Contenuto dell'allegato. Se l'allegato è una scheda avanzata, impostare questa proprietà sull'oggetto scheda rtf. Questa proprietà e la proprietà contentUrl si escludono a vicenda.
contentType	Stringa	Tipo di supporto del contenuto nell'allegato. Per i file multimediali, impostare questa proprietà su tipi di supporti noti, ad esempio image/png, audio/wav e video/mp4. Per le schede avanzate, impostare questa proprietà su uno di questi tipi specifici del fornitore: application/vnd.microsoft.card.adaptive: scheda avanzata che può contenere qualsiasi combinazione di testo, riconoscimento vocale, immagini, pulsanti e campi di input. Impostare la proprietà content su un oggetto AdaptiveCard . application/vnd.microsoft.card.animation: scheda avanzata che riproduce l'animazione. Impostare la proprietà content su un oggetto AnimationCard . application/vnd.microsoft.card.audio: scheda avanzata che riproduce file audio. Impostare la proprietà content su un oggetto AudioCard . application/vnd.microsoft.card.hero: scheda Hero. Impostare la proprietà content su un oggetto HeroCard . application/vnd.microsoft.card.receipt: scheda ricevuta. Impostare la proprietà content su un oggetto ReceiptCard . application/vnd.microsoft.card.signin: scheda di accesso utente. Impostare la proprietà content su un oggetto SignInCard . application/vnd.microsoft.card.thumbnail: scheda Anteprima. Impostare la proprietà content su un oggetto ThumbnailCard . application/vnd.microsoft.card.video: scheda avanzata che riproduce video. Impostare la proprietà content su un oggetto VideoCard .
contentUrl	Stringa	URL per il contenuto dell'allegato. Ad esempio, se l'allegato è un'immagine, è possibile impostare contentUrl sull'URL che rappresenta la posizione dell'immagine. I protocolli supportati sono HTTP, HTTPS, File e Dati.
nome	Stringa	Nome dell'allegato.
thumbnailUrl	Stringa	URL di un'immagine di anteprima che il canale può usare se supporta l'uso di una forma alternativa di contenuto o contentUrl. Ad esempio, se si imposta contentType su application/word e si imposta contentUrl sul percorso del documento Word, è possibile includere un'immagine di anteprima che rappresenta il documento. Il canale potrebbe visualizzare l'immagine di anteprima anziché il documento. Quando l'utente fa clic sull'immagine, il canale aprirà il documento.

Property	TIPO	Description
size	Number	Dimensioni del file.
viewId	Stringa	ID visualizzazione.

Property	TIPO	Description
aspetto	Stringa	Proporzioni dell'anteprima specificata nella proprietà image . I valori validi sono 16:9 e 4:3.
autoloop	Boolean	Flag che indica se riprodurre l'elenco di file audio al termine dell'ultimo. Impostare questa proprietà su true per riprodurre automaticamente i file audio; in caso contrario, false. Il valore predefinito è true.
Avvio automatico	Boolean	Flag che indica se riprodurre automaticamente l'audio quando viene visualizzata la scheda. Impostare questa proprietà su true per riprodurre automaticamente l'audio; in caso contrario, false. Il valore predefinito è true.
Pulsanti	CardAction[]	Matrice di oggetti CardAction che consentono all'utente di eseguire una o più azioni. Il canale determina il numero di pulsanti che è possibile specificare.
duration	Stringa	Lunghezza del contenuto multimediale, in formato di durata ISO 8601.
image	ThumbnailUrl	Oggetto ThumbnailUrl che specifica l'immagine da visualizzare sulla scheda.
supporti	MediaUrl[]	Matrice di oggetti MediaUrl . Quando questo campo contiene più URL, ogni URL è un formato alternativo dello stesso contenuto.
condivisibile	Boolean	Flag che indica se i file audio possono essere condivisi con altri utenti. Impostare questa proprietà su true se l'audio può essere condiviso; in caso contrario, false. Il valore predefinito è true.
Sottotitolo	Stringa	Sottotitolo da visualizzare sotto il titolo della scheda.
testo	Stringa	Descrizione o richiesta di visualizzazione sotto il titolo o il sottotitolo della scheda.
Titolo	Stringa	Titolo della carta.
valore	oggetto	Parametro supplementare per questa scheda.

Property	TIPO	Description
channelData	Stringa	Dati specifici per canale associati a questa azione.
displayText	Stringa	Testo da visualizzare nel feed di chat se si fa clic sul pulsante.
image	Stringa	URL dell'immagine che verrà visualizzato sul pulsante accanto all'etichetta di testo.
testo	Stringa	Testo per l'azione.
Titolo	Stringa	Descrizione del testo visualizzata sul pulsante.
type	Stringa	Tipo di azione da eseguire. Per un elenco di valori validi, vedere Aggiungere allegati di schede avanzate ai messaggi.
valore	oggetto	Parametro supplementare per l'azione. Il comportamento di questa proprietà varia in base al tipo di azione. Per altre informazioni, vedere Aggiungere allegati di schede avanzate ai messaggi.

Property	TIPO	Description
Alt	Stringa	Descrizione dell'immagine. È necessario includere la descrizione per supportare l'accessibilità.
toccare	CardAction	Oggetto CardAction che specifica l'azione da eseguire se l'utente tocca o fa clic sull'immagine.
url	Stringa	URL dell'origine dell'immagine o del file binario base64 dell'immagine , ad esempio `data:image/png;base64,iVBORw0KGgo...`.

Property	TIPO	Description
aadObjectId	Stringa	ID oggetto dell'account all'interno di Microsoft Entra ID.
id	Stringa	ID univoco per l'utente o il bot in questo canale.
nome	Stringa	Nome descrittivo del bot o dell'utente.
ruolo	Stringa	Ruolo dell'entità dietro l'account. Utente o bot.

Property	TIPO	Description
id	Stringa	L'ID della conversazione.
membri	ChannelAccount[]	Elenco di membri in questa conversazione.

Property	TIPO	Description
attività	Activity	Messaggio iniziale da inviare alla conversazione al momento della creazione.
bot	ChannelAccount	Informazioni sull'account del canale necessarie per instradare un messaggio al bot.
channelData	oggetto	Payload specifico del canale per la creazione della conversazione.
isGroup	Boolean	Indica se si tratta di una conversazione di gruppo.
membri	ChannelAccount[]	Informazioni sull'account del canale necessarie per instradare un messaggio a ogni utente.
tenantId	Stringa	ID tenant in cui deve essere creata la conversazione.
topicName	Stringa	Argomento della conversazione. Questa proprietà viene utilizzata solo se un canale lo supporta.

Property	TIPO	Description
activityId	Stringa	ID che identifica in modo univoco l'attività a cui fa riferimento questo oggetto.
bot	ChannelAccount	Oggetto ChannelAccount che identifica il bot nella conversazione a cui fa riferimento questo oggetto.
channelId	Stringa	ID che identifica in modo univoco il canale nella conversazione a cui fa riferimento questo oggetto.
conversazione	ConversationAccount	Oggetto ConversationAccount che definisce la conversazione a cui fa riferimento questo oggetto.
serviceUrl	Stringa	URL che specifica l'endpoint di servizio del canale nella conversazione a cui fa riferimento questo oggetto.
user	ChannelAccount	Oggetto ChannelAccount che identifica l'utente nella conversazione a cui fa riferimento questo oggetto.

Property	TIPO	Description
activityId	Stringa	ID dell'attività, se inviato.
id	Stringa	ID della risorsa.
serviceUrl	Stringa	endpoint di servizio dove possono essere eseguite operazioni relative alla conversazione.

Property	TIPO	Description
conversazioni	ConversationMembers[]	Membri di ognuna delle conversazioni.
continuationToken	Stringa	Token di continuazione che può essere usato nelle chiamate successive a Recupera conversazioni.

Property	TIPO	Description
code	Stringa	Codice di errore.
innerHttpError	InnerHttpError	Oggetto che rappresenta l'errore HTTP interno.
Messaggio	Stringa	Una descrizione dell'errore.

Property	TIPO	Description
key	Stringa	Nome del fatto. Ad esempio, Archiviazione. La chiave viene usata come etichetta quando viene visualizzato il valore del fatto.
valore	Stringa	Valore del fatto. Ad esempio, 10 ottobre 2016.

Property	TIPO	Description
elevazione dei privilegi	Number	Elevazione della posizione.
Latitudine	Number	Latitudine della posizione.
Longitudine	Number	Longitudine della posizione.
nome	Stringa	Nome del percorso.
type	Stringa	Il tipo di questo oggetto. Impostare sempre su GeoCoordinates.

Property	TIPO	Description
statusCode	Number	Codice di stato HTTP dalla richiesta non riuscita.
body	oggetto	Corpo della richiesta non riuscita.

Property	TIPO	Description
profile	Stringa	Hint che descrive il contenuto del supporto.
url	Stringa	URL dell'origine del file multimediale.

Property	TIPO	Description
menzionato	ChannelAccount	Oggetto ChannelAccount che specifica l'utente o il bot menzionato. Alcuni canali, ad esempio Slack, assegnano nomi per conversazione, quindi è possibile che il nome indicato dal bot (nella proprietà del destinatario del messaggio) sia diverso dall'handle specificato al momento della registrazione del bot. Tuttavia, gli ID account per entrambi sarebbero gli stessi.
testo	Stringa	L'utente o il bot come indicato nella conversazione. Ad esempio, se il messaggio è "@ColorBot selezionare un nuovo colore", questa proprietà verrà impostata su @ColorBot. Non tutti i canali impostano questa proprietà.
type	Stringa	Tipo dell'oggetto. Sempre impostato su Menzioni.

Property	TIPO	Description
Indirizzo	oggetto	Indirizzo di un luogo. Questa proprietà può essere una stringa o un oggetto complesso di tipo PostalAddress.
geo	GeoCoordinates	Oggetto GeoCoordinates che specifica le coordinate geografiche del luogo.
hasMap	oggetto	Mappa al posto. Questa proprietà può essere una stringa (URL) o un oggetto complesso di tipo Map.
nome	Stringa	Nome del luogo.
type	Stringa	Tipo dell'oggetto. Sempre impostata su Luogo.

Property	TIPO	Description
image	CardImage	Oggetto CardImage che specifica l'immagine di anteprima da visualizzare accanto all'elemento della riga.
prezzo	Stringa	Stringa in formato valuta che specifica il prezzo totale di tutte le unità acquistate.
quantità	Stringa	Stringa numerica che specifica il numero di unità acquistate.
Sottotitolo	Stringa	Sottotitolo da visualizzare sotto il titolo dell'elemento della riga.
toccare	CardAction	Oggetto CardAction che specifica l'azione da eseguire se l'utente tocca o fa clic sull'elemento della riga.
testo	Stringa	Descrizione dell'elemento della riga.
Titolo	Stringa	Titolo dell'elemento della riga.

Informazioni di riferimento sulle API per il servizio Bot Framework Connector

URI di base

Intestazioni

Header di richiesta

Intestazioni di risposta

Codici di stato HTTP

Errors

Operazioni di conversazione

Creare una conversazione

Elimina attività

Eliminare un membro della conversazione

Ottenere i membri dell'attività

Ottenere conversazioni

Ottenere un membro della conversazione

Inserisci i membri della conversazione

Ottenere membri con pagine di conversazione

Rispondi all'attività

Invia cronologia conversazioni

Invia alla conversazione

Attività di aggiornamento

Caricare l'allegato nel canale

Operazioni di allegato

Ottenere informazioni sugli allegati

Ottenere l'allegato

Operazioni di stato (deprecate)

Schema

Oggetto Activity

Oggetto AnimationCard

Oggetto Attachment

Oggetto AttachmentData

Oggetto AttachmentInfo

Oggetto AttachmentView

Oggetto AudioCard

Oggetto CardAction

Oggetto CardImage

Oggetto ChannelAccount

Oggetto ConversationAccount

Oggetto ConversationMembers

Oggetto ConversationParameters

Oggetto ConversationReference

Oggetto ConversationResourceResponse

Oggetto ConversationsResult

Oggetto entità

Oggetto di errore

Oggetto ErrorResponse

Oggetto Fact

Oggetto GeoCoordinates

Oggetto HeroCard

Oggetto InnerHttpError

Oggetto MediaEventValue

Oggetto MediaUrl

Oggetto Mention

Oggetto MessageReaction

Oggetto PagedMembersResult

Oggetto Place

Oggetto ReceiptCard

Oggetto ReceiptItem

Oggetto ResourceResponse

Oggetto SemanticAction

Oggetto SignInCard

Oggetto SuggestedActions

Oggetto TextHighlight

Oggetto ThumbnailCard

Oggetto ThumbnailUrl

Oggetto trascrizione

Oggetto VideoCard

Risorse aggiuntive

Property	TIPO	Description
entities	oggetto	Oggetto in cui il valore di ogni proprietà è un oggetto Entity .
id	Stringa	ID di questa azione.
stato	Stringa	Stato di questa azione. Valori consentiti: start, continue, done.

Property	TIPO	Description
actions	CardAction[]	Matrice di oggetti CardAction che definiscono le azioni suggerite.
per	String[]	Matrice di stringhe che contiene gli ID dei destinatari a cui devono essere visualizzate le azioni suggerite.

Property	TIPO	Description
occorrenza	Number	Occorrenza del campo di testo all'interno del testo a cui si fa riferimento, se sono presenti più.
testo	Stringa	Definisce il frammento di testo da evidenziare.

Property	TIPO	Description
aspetto	Stringa	Proporzioni del video. 16:9 o 4:3.
autoloop	Boolean	Flag che indica se riprodurre l'elenco di video al termine dell'ultimo. Impostare questa proprietà su true per riprodurre automaticamente i video; in caso contrario, false. Il valore predefinito è true.
Avvio automatico	Boolean	Flag che indica se riprodurre automaticamente i video quando viene visualizzata la scheda. Impostare questa proprietà su true per riprodurre automaticamente i video; in caso contrario, false. Il valore predefinito è true.
Pulsanti	CardAction[]	Matrice di oggetti CardAction che consentono all'utente di eseguire una o più azioni. Il canale determina il numero di pulsanti che è possibile specificare.
duration	Stringa	Lunghezza del contenuto multimediale, in formato di durata ISO 8601.
image	ThumbnailUrl	Oggetto ThumbnailUrl che specifica l'immagine da visualizzare sulla scheda.
supporti	MediaUrl[]	Matrice di MediaUrl. Quando questo campo contiene più URL, ogni URL è un formato alternativo dello stesso contenuto.
condivisibile	Boolean	Flag che indica se i video possono essere condivisi con altri utenti. Impostare questa proprietà su true se i video possono essere condivisi; in caso contrario, false. Il valore predefinito è true.
Sottotitolo	Stringa	Sottotitolo da visualizzare sotto il titolo della scheda.
testo	Stringa	Descrizione o richiesta di visualizzazione sotto il titolo o il sottotitolo della scheda.
Titolo	Stringa	Titolo della carta.
valore	oggetto	Parametro supplementare per questa scheda