Referência de API para o Bot Framework Connector

Observação

A API REST não é equivalente ao SDK. A API REST é fornecida para permitir a comunicação REST padrão, no entanto, o método preferido de interação com o Framework Bot é o SDK.

Dentro do Bot Framework, o serviço Bot Connector permite que seu bot troque mensagens com usuários em canais que são configurados no Portal do Bot Framework. O serviço usa REST padrão do setor e JSON por HTTPS.

URI de base

Quando um usuário envia uma mensagem para o bot, a solicitação recebida contém um objeto Atividade com uma propriedade serviceUrl que especifica o ponto de extremidade para o qual o bot deve enviar a resposta. Para acessar o serviço do Bot Connector, use o valor serviceUrl como o URI de base para solicitações de API.

Por exemplo, suponha que o bot receba a seguinte atividade quando o usuário envia uma mensagem ao bot.

{
    "type": "message",
    "id": "bf3cc9a2f5de...",
    "timestamp": "2016-10-19T20:17:52.2891902Z",
    "serviceUrl": "https://smba.trafficmanager.net/apis",
    "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"
}

A propriedade serviceUrl na mensagem do usuário indica que o bot deve enviar a resposta ao ponto de extremidade https://smba.trafficmanager.net/apis, que será o URI de base para quaisquer solicitações subsequentes que o bot emite no contexto dessa conversa. Se o bot precisar enviar uma mensagem proativa ao usuário, salve o valor de serviceUrl.

O exemplo a seguir mostra a solicitação que o bot emite para responder à mensagem do usuário.

POST https://smba.trafficmanager.net/apis/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

Cabeçalhos da solicitação

Além dos cabeçalhos de solicitação HTTP padrão, cada solicitação de API que você emitir deverá incluir um cabeçalho Authorization que especifique um token de acesso para autenticar o bot. Especifique o cabeçalho Authorization usando este formato:

Authorization: Bearer ACCESS_TOKEN

Para obter detalhes sobre como obter um token de acesso para o bot, consulte Autenticar solicitações do bot para o serviço do Bot Connector.

Cabeçalhos de resposta

Além dos cabeçalhos de resposta HTTP padrão, cada resposta conterá um cabeçalho X-Correlating-OperationId. O valor deste cabeçalho é uma ID que corresponde à entrada de log do Bot Framework que contém detalhes sobre a solicitação. Sempre que você receber uma resposta de erro, deverá capturar o valor desse cabeçalho. Se não for possível resolver o problema de maneira independente, inclua esse valor nas informações fornecidas à Equipe de suporte ao relatar o problema.

Códigos de status HTTP

O Código de status HTTP retornado com cada resposta indica o resultado da solicitação correspondente.

Observação

A tabela a seguir descreve os códigos de status HTTP mais comuns. Alguns erros são gerados pelo canal. Para obter mais informações, talvez seja necessário ler a documentação do desenvolvedor do canal.

Código de status HTTP Significado
200 Solicitação com êxito.
201 Solicitação com êxito.
202 A solicitação foi aceita para processamento.
204 A solicitação foi processada com êxito, mas nenhum conteúdo foi retornado.
400 A solicitação foi malformada ou está incorreta.
401 O bot ainda não foi autenticado.
403 O bot não está autorizado a executar a operação solicitada.
404 O recurso solicitado não foi localizado.
405 O canal não é compatível com a operação solicitada.
500 Ocorreu um erro interno no servidor.
503 O serviço está temporariamente indisponível.

Errors

Qualquer resposta que especifique um código de status HTTP no intervalo 4xx ou 5xx incluirá um objeto ErrorResponse no corpo da resposta que fornece informações sobre o erro. Se você receber uma resposta de erro no intervalo 4xx, inspecione o objeto ErrorResponse para identificar a causa do erro e resolver o problema antes de reenviar a solicitação.

Operações de conversa

Use essas operações para criar conversas, enviar mensagens (atividades) e gerenciar o conteúdo das conversas.

Operação Descrição
Criar conversa Cria uma nova conversa.
Excluir atividade Exclui uma atividade existente.
Excluir membro da conversa Remove um membro de uma conversa.
Obter membros da atividade Obtém os membros da atividade especificada na conversa especificada.
Obter membro da conversa Obtém detalhes sobre um membro de uma conversa.
Obter membros da conversa Obtém os membros da conversa especificada.
Obter membros com page de conversa Obtém os membros da conversa especificada, uma página de cada vez.
Obter conversas Obtém uma lista das conversas de que o bot participou.
Responder à atividade Envia uma atividade (mensagem) para a conversa especificada, como uma resposta à atividade especificada.
Enviar histórico da conversa Carrega uma transcrição de atividades anteriores para a conversa.
Enviar para conversa Envia uma atividade (mensagem) para o final da conversa especificada.
Atividade de atualização Atualiza uma atividade existente.
Upload anexo ao canal Carrega um anexo diretamente no armazenamento de blobs de um canal.

Criar conversa

Cria uma nova conversa.

POST /v3/conversations
Conteúdo Descrição
Corpo da solicitação Um objeto ConversationParameters
Retorna Um objeto ConversationResourceResponse

Excluir atividade

Alguns canais permitem excluir uma atividade existente. Se tiver êxito, essa operação removerá a atividade especificada da conversa especificada.

DELETE /v3/conversations/{conversationId}/activities/{activityId}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um código de status HTTP que indica o resultado da operação. Nada é especificado no corpo da resposta.

Excluir membro de conversa

Remove um membro de uma conversa. Se esse membro for o último da conversa, a conversa também será excluída.

DELETE /v3/conversations/{conversationId}/members/{memberId}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um código de status HTTP que indica o resultado da operação. Nada é especificado no corpo da resposta.

Obter membros da atividade

Obtém os membros da atividade especificada na conversa especificada.

GET /v3/conversations/{conversationId}/activities/{activityId}/members
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Uma matriz de objetos ChannelAccount

Obter conversas

Obtém uma lista das conversas de que o bot participou.

GET /v3/conversations?continuationToken={continuationToken}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um objeto ConversationsResult

Obter membro da conversa

Obtém detalhes sobre um membro específico de uma conversa específica.

GET /v3/conversations/{conversationId}/members/{memberId}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um objeto ChannelAccount para o membro.

Obter membros da conversa

Obtém os membros da conversa especificada.

GET /v3/conversations/{conversationId}/members
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Uma matriz de objetos ChannelAccount para os membros da conversa.

Obter Membros paginados da conversa

Obtém os membros da conversa especificada, uma página de cada vez.

GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um objeto PagedMembersResult

Responder à atividade

Envia uma atividade (mensagem) para a conversa especificada, como uma resposta à atividade especificada. A atividade será adicionada como resposta a outra atividade, se houver suporte para isso no canal. Se o canal não der suporte a respostas aninhadas, essa operação se comportará como Enviar para conversa.

POST /v3/conversations/{conversationId}/activities/{activityId}
Conteúdo Descrição
Corpo da solicitação Um objeto Atividade
Retorna Um objeto ResourceResponse

Enviar histórico de conversa

Carrega uma transcrição de atividades anteriores para a conversa para que o cliente possa renderizá-las.

POST /v3/conversations/{conversationId}/activities/history
Conteúdo Descrição
Corpo da solicitação Um objeto Transcript.
Retorna Um objeto ResourceResponse.

Enviar para conversa

Envia uma atividade (mensagem) para a conversa especificada. A atividade será anexada ao final da conversa, de acordo com o carimbo de data/hora ou semântica do canal. Para responder a uma mensagem específica na conversa, use Responder a atividade.

POST /v3/conversations/{conversationId}/activities
Conteúdo Descrição
Corpo da solicitação Um objeto Atividade
Retorna Um objeto ResourceResponse

Atualizar atividade

Alguns canais permitem editar uma atividade existente para refletir o novo estado de uma conversa de bot. Por exemplo, será possível remover botões de uma mensagem na conversa depois que o usuário clicar em um dos botões. Se tiver êxito, essa operação atualizará a atividade especificada dentro da conversa especificada.

PUT /v3/conversations/{conversationId}/activities/{activityId}
Conteúdo Descrição
Corpo da solicitação Um objeto Atividade
Retorna Um objeto ResourceResponse

Upload anexo ao canal

Carrega um anexo para a conversa especificada diretamente no armazenamento de blobs de um canal. Isso permite que você armazene dados em um armazenamento compatível.

POST /v3/conversations/{conversationId}/attachments
Conteúdo Descrição
Corpo da solicitação Um objeto AttachmentData.
Retorna Um objeto ResourceResponse. A propriedade ID especifica a ID do anexo que pode ser usada com a operação obter informações de anexo e a operação obter anexo .

Operações de Anexo

Use essas operações para recuperar informações sobre um anexo, bem como os dados binários para o próprio arquivo.

Operação Descrição
Obter Informações do Anexo Obtém informações sobre o anexo especificado, incluindo o nome e o tipo de arquivo e os modos de exibição disponíveis (por exemplo, original ou miniatura).
Obter anexo Obtém a exibição especificada do anexo especificado como conteúdo binário.

Obter informações do anexo

Obtém informações sobre o anexo especificado, incluindo o nome do arquivo, o tipo e os modos de exibição disponíveis (por exemplo, original ou miniatura).

GET /v3/attachments/{attachmentId}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Um objeto AttachmentInfo

Obter anexo

Obtém a exibição especificada do anexo especificado como conteúdo binário.

GET /v3/attachments/{attachmentId}/views/{viewId}
Conteúdo Descrição
Corpo da solicitação n/d
Retorna Conteúdo binário que representa a exibição especificada do anexo especificado

Operações de estado (preterido)

O serviço de Estado do Microsoft Bot Framework foi desativado em 30 de março de 2018. Anteriormente, bots criados no Serviço de Bot do Azure ou no SDK do Bot Builder tinham uma conexão padrão com esse serviço hospedado pela Microsoft para armazenar dados de estado do bot. Os bots deverão ser atualizados para usar seu próprio armazenamento de estado.

Operação Descrição
Set User Data Armazena dados de estado para um usuário específico em um canal.
Set Conversation Data Armazena dados de estado para uma conversa específica em um canal.
Set Private Conversation Data Armazena dados de estado para um usuário específico no contexto de uma conversa específica em um canal.
Get User Data Recupera dados de estado que foram armazenados anteriormente para um usuário específico em todas as conversas em um canal.
Get Conversation Data Recupera dados de estado que foram armazenados anteriormente para uma conversa específica em um canal.
Get Private Conversation Data Recupera dados de estado que foram armazenados anteriormente para um usuário específico no contexto de uma conversa específica em um canal.
Delete State For User Exclui os dados de estado que foram armazenados para um usuário.

Esquema

O esquema do Bot Framework define os objetos e suas propriedades que seu bot pode usar para se comunicar com um usuário.

Objeto Descrição
Objeto Activity Define uma mensagem trocada entre o bot e o usuário.
Objeto AnimationCard Define um cartão que pode reproduzir GIFs animados ou vídeos curtos.
Objeto Attachment Define informações adicionais para incluir na mensagem. Um anexo pode ser um arquivo de mídia (por exemplo, áudio, vídeo, imagem, arquivo) ou um cartão avançado.
Objeto AttachmentData Descreve um anexo de dados.
Objeto AttachmentInfo Descreve um anexo.
Objeto AttachmentView Define um modo de exibição de anexo.
Objeto AudioCard Define um cartão que pode reproduzir um arquivo de áudio.
Objeto CardAction Define uma ação para executar.
Objeto CardImage Define uma imagem para exibir em um cartão.
Objeto ChannelAccount Define um bot ou uma conta de usuário no canal.
Objeto ConversationAccount Define uma conversa em um canal.
Objeto ConversationMembers Define os membros de uma conversa.
Objeto ConversationParameters Definir parâmetros para criar uma nova conversa
Objeto ConversationReference Define um ponto específico em uma conversa.
Objeto ConversationResourceResponse Define uma resposta a Criar conversa.
Objeto ConversationsResult Define o resultado de uma chamada para Obter conversas.
Objeto Entity Define um objeto de entidade.
Objeto Error Define um erro.
Objeto ErrorResponse Define uma resposta de API HTTP.
Objeto Fact Define um par chave-valor que contém um fato.
Objeto GeoCoordinates Define uma localização geográfica usando as coordenadas WSG84 (World Geodetic System).
Objeto HeroCard Define um cartão com uma imagem grande, título, texto e botões de ação.
Objeto InnerHttpError Objeto representando um erro HTTP interno.
Objeto MediaEventValue Parâmetro suplementar para eventos de mídia.
Objeto MediaUrl Define a URL para a fonte de um arquivo de mídia.
Objeto Mention Define um usuário ou bot que foi mencionado na conversa.
Objeto MessageReaction Define uma reação a uma mensagem.
Objeto PagedMembersResult Página de membros retornada por Obter Membros Paginados da Conversa.
Objeto Place Define um local que foi mencionado na conversa.
Objeto ReceiptCard Define um cartão que contém um recibo para uma compra.
Objeto ReceiptItem Define um item de linha dentro de um recibo.
Objeto ResourceResponse Define um recurso.
Objeto SemanticAction Define uma referência a uma ação através programática.
Objeto SignInCard Define um cartão que permite ao usuário entrar em um serviço.
Objeto SuggestedActions Define as opções que um usuário pode escolher.
Objeto TextHighlight Refere-se a uma substring de conteúdo dentro de outro campo.
Objeto ThumbnailCard Define um cartão com uma imagem em miniatura, título, texto e botões de ação.
Objeto ThumbnailUrl Define a URL para a fonte de uma imagem.
Objeto Transcript Uma coleção de atividades a ser carregada usando Enviar histórico da conversa.
Objeto VideoCard Define um cartão que pode reproduzir vídeos.

Objeto de Atividade

Define uma mensagem trocada entre o bot e o usuário.

Propriedade Type Descrição
action string A ação a aplicar ou que foi aplicada. Use a propriedade tipo para determinar o contexto da ação. Por exemplo, se tipo for contactRelationUpdate, o valor da propriedade ação será adicionar se o usuário adicionou o bot à lista de contatos ou remover se o usuário removeu o bot da lista de contatos.
attachmentLayout string Layout dos anexos de cartão avançado que a mensagem inclui. Um desses valores: carrossel, lista. Para obter mais informações sobre anexos de cartão avançado, consulte Adicionar anexos de cartão avançado às mensagens.
attachments Attachment[] Matriz de objetos Anexo que define informações adicionais para incluir na mensagem. Cada anexo pode ser um arquivo (por exemplo, áudio, vídeo, imagem) ou um cartão avançado.
callerId string Uma cadeia de caracteres que contém um IRI que identifica o chamador de um bot. Este campo não se destina a ser transmitido eletronicamente; em vez disso, ele é preenchido por bots e clientes com base em dados verificáveis criptograficamente que declara a identidade dos chamadores (por exemplo, tokens).
channelData objeto Um objeto que contém conteúdo específico do canal. Alguns canais fornecem recursos que exigem informações adicionais que não podem ser representadas usando o esquema de anexo. Para esses casos, defina essa propriedade para o conteúdo específico do canal, conforme definido na documentação do canal. Para obter mais informações, consulte Implementar funcionalidade específica do canal.
channelId string Uma ID que identifica exclusivamente o canal. Definida pelo canal.
code string Código indicando por que a conversa encerrou.
conversa ConversationAccount Um objeto ConversationAccount que define a conversa à qual a atividade pertence.
deliveryMode string Uma dica de entrega para sinalizar os caminhos de entrega alternativos do destinatário para a atividade. Um desses valores: normal, notification.
entidades object[] Matriz de objetos que representa as entidades mencionadas na mensagem. Objetos nessa matriz podem ser qualquer objeto Schema.org. Por exemplo, a matriz pode incluir objetos Menção que identificam alguém que foi mencionado na conversa e objetos Local que identificam um local mencionado na conversa.
expiration string A hora na qual a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário.
from ChannelAccount Um objeto ChannelAccount que especifica o remetente da mensagem.
historyDisclosed booleano Sinalizador que indica se o histórico é ou não divulgado. O valor padrão é false.
id string ID que identifica exclusivamente a atividade no canal.
importance string Define a importância de uma Atividade. Um destes valores: low, normal, high.
inputHint string Valor que indica se o bot está aceitando, esperando ou ignorando a entrada do usuário após a entrega da mensagem ao cliente. Um desses valores: acceptingInput, expectingInput, ignoringInput.
label string Um rótulo descritivo da atividade.
listenFor string[] Lista de frases e referências que os sistemas de preparação da fala e de linguagem devem escutar.
locale string Localidade do idioma que deve ser usado para exibir texto dentro da mensagem, no formato <language>-<country>. O canal usa essa propriedade para indicar o idioma do usuário, para que o bot possa especificar cadeia de caracteres de exibição nesse idioma. O valor padrão é en-US.
localTimestamp string Data e hora em que a mensagem foi enviada no fuso horário local, expressa no formato ISO-8601.
localTimezone string Contém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA. Por exemplo, America/Los_Angeles.
membersAdded ChannelAccount[] Matriz de objetos ChannelAccount que representam a lista de usuários que participaram da conversa. Presente apenas se a atividade tipo for "conversationUpdate" e os usuários ingressarem na conversa.
membersRemoved ChannelAccount[] Matriz de objetos ChannelAccount que representam a lista de usuários que saíram da conversa. Presente apenas se a atividade tipo for "conversationUpdate" e os usuários saírem da conversa.
name string Nome da operação a invocar ou o nome do evento.
reactionsAdded MessageReaction[] A coleção de reações adicionadas à conversa.
reactionsRemoved MessageReaction[] A coleção de reações removidas da conversa.
recipient ChannelAccount Um objeto ChannelAccount que especifica o destinatário da mensagem.
relatesTo ConversationReference Um objeto ConversationReference que define um ponto específico em uma conversa.
replyToId string A ID da mensagem à qual essa mensagem responde. Para responder a uma mensagem que o usuário enviou, defina essa propriedade como a ID da mensagem do usuário. Nem todos os canais dão suporte a respostas encadeadas. Nesses casos, o canal ignorará essa propriedade e usará a semântica ordenada por tempo (carimbo de data/hora) para acrescentar a mensagem à conversa.
semanticAction SemanticAction Um objeto SemanticAction que representa uma referência a uma ação programática.
serviceUrl string URL que especifica o ponto de extremidade de serviço do canal. Definida pelo canal.
speak string Texto a ser falado pelo bot em um canal habilitado para fala. Para controlar várias características de fala do bot como voz, velocidade, volume, pronúncia e tom, especifique essa propriedade no formato SSML (Linguagem de Marcação de Sintetização de Voz).
suggestedActions SuggestedActions Um objeto SuggestedActions que define as opções a partir das quais o usuário poderá escolher.
summary string Resumo das informações que a mensagem contém. Por exemplo, para uma mensagem enviada em um canal de email, essa propriedade pode especificar os primeiros 50 caracteres da mensagem de email.
text string Texto da mensagem que é enviada do usuário para o bot ou do bot para o usuário. Consulte a documentação do canal para os limites impostos sobre o conteúdo dessa propriedade.
textFormat string Formato do texto da mensagem. Um desses valores: markdown, plain, xml. Para detalhes sobre o formato de texto, consulte Criar mensagens.
textHighlights TextHighlight[] A coleção de fragmentos de texto a serem realçados quando a atividade contém um valor replyToId.
timestamp string Data e hora em que a mensagem foi enviada no fuso horário UTC, expressa no formato ISO-8601.
topicName string Tópico da conversa à qual a atividade pertence.
tipo string Tipo de atividade. Um destes valores: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Para detalhes sobre tipos de atividade, consulte Visão geral das atividades.
value objeto Valor em aberto.
valueType string O tipo do objeto de valor da atividade.

Retornar à tabela de esquemas

Objeto AnimationCard

Define um cartão que pode reproduzir GIFs animados ou vídeos curtos.

Propriedade Type Descrição
aspect booleano Taxa de proporção do espaço reservado de miniatura/mídia. Os valores permitidos são “16:9” e “4:3”.
autoloop booleano Sinalizador que indica se deve repetir a lista de GIFs animados quando o último encerrar. Configure essa propriedade como true para reproduzir automaticamente a animação, caso contrário, como false. O valor padrão é true.
autostart booleano Sinalizador que indica se deverá reproduzir automaticamente a animação quando o cartão for exibido. Defina essa propriedade como true para reproduzir automaticamente a animação, caso contrário, como false. O valor padrão é true.
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
duration string O comprimento do conteúdo de mídia, no formato de duração ISO 8601.
imagem ThumbnailUrl Um objeto ThumbnailUrl que especifica a imagem a ser exibida no cartão.
media MediaUrl[] Matriz de objetos MediaUrl. Quando esse campo contém mais de uma URL, cada URL é um formato alternativo do mesmo conteúdo.
shareable booleano Sinalizador que indica se a animação pode ser compartilhada com outras pessoas. Configure esta propriedade para true se a animação puder ser compartilhada, caso contrário, para false. O valor padrão é true.
subtitle string Subtítulo a ser exibido sob o título do cartão.
text string Descrição ou solicitação para exibir sob o título ou subtítulo do cartão.
title string Título do cartão.
value objeto Parâmetro suplementar para esse cartão.

Retornar à tabela de esquemas

Objeto Anexo

Define informações adicionais para incluir na mensagem. Um anexo pode ser um arquivo (como uma imagem, áudio ou vídeo) ou um cartão avançado.

Propriedade Type Descrição
content objeto O conteúdo do anexo. Se o anexo for um cartão avançado, defina essa propriedade para o objeto cartão avançado. Essa propriedade e a propriedade contentUrl são mutuamente exclusivas.
contentType string O tipo de mídia do conteúdo no anexo. Para arquivos de mídia, defina essa propriedade para tipos de mídia conhecidos, como image/png, audio/wav e video/mp4. Para cartões avançados, defina essa propriedade para um desses tipos específicos do fornecedor:
  • application/vnd.microsoft.card.adaptive: Um cartão sofisticado que pode conter qualquer combinação de texto, fala, imagens, botões e campos de entrada. Defina a propriedade de conteúdo para um objeto AdaptiveCard.
  • application/vnd.microsoft.card.animation: Um cartão sofisticado que reproduz animação. Defina a propriedade de conteúdo para um objeto AnimationCard.
  • application/vnd.microsoft.card.audio: Um cartão sofisticado que reproduz arquivos de áudio. Defina a propriedade de conteúdo como um objeto AudioCard.
  • application/vnd.microsoft.card.hero: Um cartão em destaque. Defina e propriedade de conteúdo para um objeto HeroCard.
  • application/vnd.microsoft.card.receipt: Um cartão de recibo. Defina e propriedade de conteúdo para um objeto ReceiptCard.
  • application/vnd.microsoft.card.signin: Um cartão de entrada do usuário. Defina e propriedade de conteúdo para um objeto SignInCard.
  • application/vnd.microsoft.card.thumbnail: Um cartão em miniatura. Defina a propriedade de conteúdo para um objeto ThumbnailCard.
  • application/vnd.microsoft.card.video: Um cartão sofisticado que reproduz vídeos. Defina a propriedade de conteúdo para um objeto VideoCard.
contentUrl string URL para o conteúdo do anexo. Por exemplo, se o anexo for uma imagem, será possível definir contentUrl como a URL que representa o local da imagem. Os protocolos com suporte são: HTTP, HTTPS, Arquivo e Dados.
name string Nome do anexo.
thumbnailUrl string URL para uma imagem em miniatura que o canal pode usar se for compatível com o uso de uma forma alternativa menor de conteúdo ou contentUrl. Por exemplo, se você definir contentType como application/word e definir contentUrl como o local do documento do Word, talvez inclua uma imagem em miniatura que represente o documento. O canal pode exibir a imagem em miniatura em vez do documento. Quando o usuário clicar na imagem, o canal abrirá o documento.

Retornar à tabela de esquemas

Objeto AttachmentData

Descreve os dados de um anexo.

Propriedade Type Descrição
name string Nome do anexo.
originalBase64 string Conteúdo do anexo.
thumbnailBase64 string Conteúdo em miniatura do anexo.
tipo string Tipo de conteúdo do anexo.

Retornar à tabela de esquemas

Objeto AttachmentInfo

Metadados de um anexo.

Propriedade Type Descrição
name string Nome do anexo.
tipo string Tipo de conteúdo do anexo.
modos de exibição AttachmentView[] Matriz de objetos AttachmentView que representam as exibições disponíveis para o anexo.

Retornar à tabela de esquemas

Objeto AttachmentView

Define um modo de exibição de anexo.

Propriedade Type Descrição
size número Tamanho do arquivo.
viewId string ID da exibição.

Retornar à tabela de esquemas

Objeto AudioCard

Define um cartão que pode reproduzir um arquivo de áudio.

Propriedade Type Descrição
aspect string Proporção da miniatura especificada na propriedade da imagem. Os valores válidos são 16:9 e 4:3.
autoloop booleano Sinalizador que indica se deverá reproduzir a lista de arquivos de áudio quando o último encerrar. Defina essa propriedade como true para reproduzir automaticamente os arquivos de áudio, caso contrário, como false. O valor padrão é true.
autostart booleano Sinalizador que indica se deverá reproduzir automaticamente o áudio quando o cartão for exibido. Defina essa propriedade como true para reproduzir automaticamente o áudio, caso contrário, como false. O valor padrão é true.
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
duration string O comprimento do conteúdo de mídia, no formato de duração ISO 8601.
imagem ThumbnailUrl Um objeto ThumbnailUrl que especifica a imagem a ser exibida no cartão.
media MediaUrl[] Matriz de objetos MediaUrl. Quando esse campo contém mais de uma URL, cada URL é um formato alternativo do mesmo conteúdo.
shareable booleano Sinalizador que indica se os arquivos de áudio podem ser compartilhados com outras pessoas. Defina essa propriedade como true se o áudio puder ser compartilhado, caso contrário, false. O valor padrão é true.
subtitle string Subtítulo a ser exibido sob o título do cartão.
text string Descrição ou solicitação para exibir sob o título ou subtítulo do cartão.
title string Título do cartão.
value objeto Parâmetro suplementar para esse cartão.

Retornar à tabela de esquemas

Objeto CardAction

Define uma ação que pode ser clicada com um botão.

Propriedade Type Descrição
channelData string Dados específicos do canal associados a esta ação.
displayText string Texto a ser exibido no feed do chat se o botão receber cliques.
imagem string URL da imagem que será exibida no botão, ao lado do rótulo de texto.
text string Texto da ação.
title string Descrição de texto exibida no botão.
tipo string Tipo de ação a ser executada. Para obter uma lista de valores válidos, consulte Adicionar anexos de cartão avançado às mensagens.
value objeto Parâmetro suplementar para a ação. O comportamento dessa propriedade variará de acordo com a ação tipo. Para obter mais informações, consulte Adicionar anexos de cartão avançado às mensagens.

Retornar à tabela de esquemas

Objeto CardImage

Define uma imagem para exibir em um cartão.

Propriedade Type Descrição
alt string Descrição da imagem. É necessário incluir a descrição para dar suporte à acessibilidade.
tap CardAction Um objeto CardAction que especificará a ação a ser executada se o usuário tocar ou clicar na imagem.
url string URL para a origem da imagem ou o binário base64 da imagem (por exemplo, data:image/png;base64,iVBORw0KGgo...).

Retornar à tabela de esquemas

Objeto ChannelAccount

Define um bot ou uma conta de usuário no canal.

Propriedade Type Descrição
aadObjectId string A ID de objeto desta conta no Azure Active Directory.
id string ID exclusiva para o usuário ou bot neste canal.
name string Exibir nome amigável do bot ou do usuário.
role string Função da entidade por trás da conta. Usuário ou bot.

Retornar à tabela de esquemas

Objeto ConversationAccount

Define uma conversa em um canal.

Propriedade Type Descrição
aadObjectId string A ID de objeto da conta dentro do AAD (Azure Active Directory).
conversationType string Indica o tipo de conversa nos canais que diferenciam os tipos de conversas (por exemplo, grupo, pessoal).
id string A ID que identifica a conversa. A ID é exclusiva por canal. Se o canal iniciar a conversa, ele definirá essa ID, caso contrário, o bot definirá essa propriedade como a ID que será retornada na resposta quando iniciar a conversa (confira Criar Conversa).
isGroup booleano Sinalizar para indicar se a conversa contém mais de dois participantes no momento em que a atividade foi gerada. Defina como true se esta for uma conversa em grupo, caso contrário, como false. O padrão é false.
name string Um nome de exibição que pode ser usado para identificar a conversa.
role string Função da entidade por trás da conta. Usuário ou bot.
tenantId string A ID de locatário da conversa.

Retornar à tabela de esquemas

Objeto ConversationMembers

Define os membros de uma conversa.

Propriedade Type Descrição
id string A ID da conversa.
members ChannelAccount[] Lista de membros nesta conversa.

Retornar à tabela de esquemas

Objeto ConversationParameters

Define parâmetros para criar uma conversa.

Propriedade Type Descrição
activity Atividade A mensagem inicial a ser enviada para a conversa quando ela for criada.
bot ChannelAccount Informações de conta do canal necessárias para rotear uma mensagem para o bot.
channelData objeto Conteúdo específico do canal para criar a conversa.
isGroup booleano Indica se essa é uma conversa em grupo.
members ChannelAccount[] Informações de conta do canal necessárias para rotear uma mensagem para cada usuário.
tenantId string A ID de locatário na qual a conversa deve ser criada.
topicName string Tópico da conversa. Essa propriedade será usada apenas se um canal der suporte.

Retornar à tabela de esquemas

Objeto ConversationReference

Define um ponto específico em uma conversa.

Propriedade Type Descrição
activityId string ID que identifica exclusivamente a atividade à qual esse objeto faz referência.
bot ChannelAccount Um objeto ChannelAccount que identifica o bot na conversa à qual esse objeto faz referência.
channelId string Uma ID que identifica exclusivamente o canal na conversa à qual esse objeto faz referência.
conversa ConversationAccount Um objeto ConversationAccount que define a conversação à qual esse objeto faz referência.
serviceUrl string URL que especifica o ponto de extremidade de serviço do canal na conversa à qual esse objeto faz referência.
user ChannelAccount Um objeto ChannelAccount que identifica o usuário na conversa à qual esse objeto faz referência.

Retornar à tabela de esquemas

Objeto ConversationResourceResponse

Define uma resposta a Criar conversa.

Propriedade Type Descrição
activityId string ID da atividade, se enviada.
id string ID do recurso.
serviceUrl string Ponto de extremidade de serviço em que as operações relacionadas à conversa podem ser executadas.

Retornar à tabela de esquemas

Objeto ConversationsResult

Define o resultado de Obter conversas.

Propriedade Type Descrição
conversations ConversationMembers[] Os membros em cada uma das conversas.
continuationToken string O token de continuação que pode ser usado em chamadas posteriores a Obter conversas.

Retornar à tabela de esquemas

Objeto de entidade

Objeto de metadados pertencente a uma atividade.

Propriedade Type Descrição
tipo string Tipo desta entidade (RFC 3987 IRI).

Retornar à tabela de esquemas

Objeto de erro

Objeto representando informações de erro.

Propriedade Type Descrição
code string Código do erro.
innerHttpError InnerHttpError Objeto representando o erro HTTP interno.
message string Uma descrição do erro.

Retornar à tabela de esquemas

Objeto ErrorResponse

Define uma resposta de API HTTP.

Propriedade Type Descrição
error Erro Um objeto Erro que contém informações sobre o erro.

Retornar à tabela de esquemas

Objeto Fato

Define um par chave-valor que contém um fato.

Propriedade Type Descrição
chave string Nome do fato. Por exemplo, Check-in. A chave é usada como um rótulo ao exibir o valor do fato.
value string Valor do fato. Por exemplo, 10 de outubro de 2016.

Retornar à tabela de esquemas

Objeto GeoCoordinates

Define uma localização geográfica usando as coordenadas WSG84 (World Geodetic System).

Propriedade Type Descrição
elevation número Elevação da localização.
latitude número Latitude da localização.
longitude número Longitude da localização.
name string Nome da localização.
tipo string O tipo desse objeto. Sempre definido para GeoCoordinates.

Retornar à tabela de esquemas

Objeto HeroCard

Define um cartão com uma imagem grande, título, texto e botões de ação.

Propriedade Type Descrição
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
images CardImage[] Matriz de objetos CardImage que especifica a imagem a ser exibida no cartão. Um cartão Hero contém apenas uma imagem.
subtitle string Subtítulo a ser exibido sob o título do cartão.
tap CardAction Um objeto CardAction que especifica a ação a ser executada se o usuário tocar ou clicar no cartão. Essa pode ser a mesma ação que um dos botões ou uma ação diferente.
text string Descrição ou solicitação para exibir sob o título ou subtítulo do cartão.
title string Título do cartão.

Retornar à tabela de esquemas

Objeto InnerHttpError

Objeto representando um erro HTTP interno.

Propriedade Type Descrição
statusCode número Código de status HTTP da solicitação com falha.
body objeto Corpo da solicitação com falha.

Retornar à tabela de esquemas

Objeto MediaEventValue

Parâmetro suplementar para eventos de mídia.

Propriedade Type Descrição
cardValue objeto Parâmetro de retorno de chamada especificado no campo value do cartão de mídia que originou esse evento.

Retornar à tabela de esquemas

Objeto MediaUrl

Define a URL para a fonte de um arquivo de mídia.

Propriedade Type Descrição
profile string Dica que descreve o conteúdo da mídia.
url string URL para a origem do arquivo de mídia.

Retornar à tabela de esquemas

Objeto Mention

Define um usuário ou bot que foi mencionado na conversa.

Propriedade Type Descrição
mentioned ChannelAccount Um objeto ChannelAccount que especifica o usuário ou o bot que foi mencionado. Observe que alguns canais, como Slack, atribuem nomes por conversa, portanto, é possível que o nome mencionado do bot (na propriedade do destinatário ) seja diferente do identificador especificado quando você registrou o bot. No entanto, as IDs da conta para ambos seriam as mesmas.
text string O usuário ou bot como mencionado na conversa. Por exemplo, se a mensagem for " escolha-me uma nova cor", essa propriedade @ColorBot será definida como @ ColorBot. Nem todos os canais definem essa propriedade.
tipo string Tipo desse objeto. Sempre defina para Menção.

Retornar à tabela de esquemas

Objeto MessageReaction

Define uma reação a uma mensagem.

Propriedade Type Descrição
tipo string Tipo de reação. like ou plusOne.

Retornar à tabela de esquemas

Objeto PagedMembersResult

Página de membros retornada por Obter Membros Paginados da Conversa.

Propriedade Type Descrição
continuationToken string O token de continuação que pode ser usado em chamadas posteriores a Obter Membros Paginados da Conversa.
members ChannelAccount[] Uma matriz de membros de conversa.

Retornar à tabela de esquemas

Objeto Local

Define um local que foi mencionado na conversa.

Propriedade Type Descrição
address objeto Endereço de um local. Essa propriedade pode ser uma cadeia de caracteres ou um objeto complexo do tipo PostalAddress.
geo GeoCoordinates Um objeto GeoCoordinates que especifica as coordenadas geográficas do lugar.
hasMap objeto Mapa para o local. Essa propriedade pode ser uma cadeia de caracteres (URL) ou um objeto complexo do tipo Map.
name string Nome do local.
tipo string Tipo desse objeto. Sempre defina para Local.

Retornar à tabela de esquemas

Objeto ReceiptCard

Define um cartão que contém um recibo para uma compra.

Propriedade Type Descrição
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
facts Fact[] Matriz de objetos Fato que especificam informações sobre a compra. Por exemplo, a lista de fatos para um recibo de hospedagem pode incluir a data de check-in e a data de check-out. O canal determina o número de fatos que podem ser especificados.
items ReceiptItem[] Matriz de objetos ReceiptItem que especificam os itens comprados
tap CardAction Um objeto CardAction que especifica a ação a ser executada se o usuário tocar ou clicar no cartão. Essa pode ser a mesma ação que um dos botões ou uma ação diferente.
tax string Uma cadeia de caracteres formatada em moeda que especifica o valor do imposto aplicado à compra.
title string Título exibido na parte superior do recebimento.
total string Uma cadeia de caracteres formatada em moeda que especifica o preço total de compra, incluindo todos os impostos aplicáveis.
vat string Uma cadeia de caracteres formatada como moeda que especifica o IVA (imposto sobre valor agregado) aplicado ao preço de compra.

Retornar à tabela de esquemas

Objeto ReceiptItem

Define um item de linha dentro de um recibo.

Propriedade Type Descrição
imagem CardImage Um objeto CardImage que especifica a imagem em miniatura para exibir ao lado do item de linha.
price string Uma cadeia de caracteres formatada como moeda que especifica o preço total de todas as unidades compradas.
quantity string Uma cadeia numérica que especifica o número de unidades compradas.
subtitle string Subtítulo a ser exibido abaixo do título do item de linha.
tap CardAction Um objeto CardAction que especifica a ação a ser executada se o usuário tocar ou clicar no item de linha.
text string Descrição do item de linha.
title string Título do item de linha.

Retornar à tabela de esquemas

Objeto ResourceResponse

Define uma resposta que contém uma ID de recurso.

Propriedade Type Descrição
id string ID que identifica exclusivamente o recurso.

Retornar à tabela de esquemas

Objeto SemanticAction

Define uma referência a uma ação através programática.

Propriedade Type Descrição
entidades objeto Um objeto em que o valor de cada propriedade é um objeto Entity.
id string ID desta ação.
state string Estado desta ação. Valores permitidos: start, continue, done.

Retornar à tabela de esquemas

Objeto SignInCard

Define um cartão que permite ao usuário entrar em um serviço.

Propriedade Type Descrição
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário entrar em um serviço. O canal determina o número de botões que você pode especificar.
text string Descrição ou solicitação para incluir no cartão de entrada.

Retornar à tabela de esquemas

Objeto SuggestedActions

Define as opções que um usuário pode escolher.

Propriedade Type Descrição
actions CardAction[] Matriz de objetos CardAction que definem as ações sugeridas.
to string[] Matriz de cadeias de caracteres que contém as IDs dos destinatários para os quais as ações sugeridas devem ser exibidas.

Retornar à tabela de esquemas

Objeto TextHighlight

Refere-se a uma substring de conteúdo dentro de outro campo.

Propriedade Type Descrição
occurrence número Ocorrência do campo de texto dentro do texto referenciado, se houver vários.
text string Define o snippet de texto a ser realçado.

Retornar à tabela de esquemas

Objeto ThumbnailCard

Define um cartão com uma imagem em miniatura, título, texto e botões de ação.

Propriedade Type Descrição
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
images CardImage[] Matriz de objetos CardImage que especificam imagens em miniatura para exibir no cartão. O canal determina o número de imagens em miniatura que podem ser especificados.
subtitle string Subtítulo a ser exibido sob o título do cartão.
tap CardAction Um objeto CardAction que especifica a ação a ser executada se o usuário tocar ou clicar no cartão. Essa pode ser a mesma ação que um dos botões ou uma ação diferente.
text string Descrição ou solicitação para exibir sob o título ou subtítulo do cartão.
title string Título do cartão.

Retornar à tabela de esquemas

Objeto ThumbnailUrl

Define a URL para a fonte de uma imagem.

Propriedade Type Descrição
alt string Descrição da imagem. É necessário incluir a descrição para dar suporte à acessibilidade.
url string URL para a origem da imagem ou o binário base64 da imagem (por exemplo, data:image/png;base64,iVBORw0KGgo...).

Retornar à tabela de esquemas

Objeto Transcript

Uma coleção de atividades a ser carregada usando Enviar histórico da conversa.

Propriedade Type Descrição
activities matriz Uma matriz de objetos Atividade. Eles devem ter uma ID exclusiva e um carimbo de data/hora.

Retornar à tabela de esquemas

Objeto VideoCard

Define um cartão que pode reproduzir vídeos.

Propriedade Type Descrição
aspect string Taxa de proporção do vídeo. 16:9 ou 4:3.
autoloop booleano Sinalizador que indica se deverá reproduzir a lista de vídeos quando o último encerrar. Defina esta propriedade como true para reproduzir automaticamente os vídeos, caso contrário, como false. O valor padrão é true.
autostart booleano Sinalizador que indica se deverá reproduzir automaticamente os vídeos quando o cartão for exibido. Defina essa propriedade para true para reproduzir automaticamente os vídeos, caso contrário, como false. O valor padrão é true.
buttons CardAction[] Matriz de objetos CardAction que permitem ao usuário executar uma ou mais ações. O canal determina o número de botões que você pode especificar.
duration string O comprimento do conteúdo de mídia, no formato de duração ISO 8601.
imagem ThumbnailUrl Um objeto ThumbnailUrl que especifica a imagem a ser exibida no cartão.
media MediaUrl[] Matriz de MediaUrl. Quando esse campo contém mais de uma URL, cada URL é um formato alternativo do mesmo conteúdo.
shareable booleano Sinalizador que indica se os vídeos podem ser compartilhados com outras pessoas. Defina esta propriedade para true se os vídeos puderem ser compartilhados, caso contrário, como false. O valor padrão é true.
subtitle string Subtítulo a ser exibido sob o título do cartão.
text string Descrição ou solicitação para exibir sob o título ou subtítulo do cartão.
title string Título do cartão.
value objeto Parâmetro suplementar para esse cartão

Retornar à tabela de esquemas