Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Importante
- Esta é uma funcionalidade de pré-visualização pronta para produção.
- As pré-visualizações prontas para produção estão sujeitas a termos de utilização suplementares.
[Este artigo é uma documentação de pré-lançamento e está sujeito a alterações.]
Para entender melhor o contexto de uma reunião para a qual se estão a preparar ou de um e-mail que estão a ler, os vendedores querem informações relevantes de CRM (gestão das relações com os clientes), como consultas, preocupações e notas de clientes. A aplicação de Vendas utiliza IA para gerar um resumo de cada registo CRM. Este resumo destaca detalhes cruciais, como a fase de venda, o orçamento e a data de fecho projetada. Pode expandir a capacidade de resumo de registos do CRM que a aplicação de Vendas oferece com insights da sua própria aplicação.
Descrição da API
Tem de adicionar a seguinte descrição da API à ação. Desta forma, a aplicação Sales pode identificar a API correta que deve ser invocada para enriquecer a capacidade.
Esta ação obtém informações de vendas adicionais relacionadas com um registo do CRM que serão mostradas no cartão de resumo do registo C4S. A ação aprimora as capacidades existentes do Copilot para vendas.
Operação API
Esta API usa o tipo de operação: GET
Parâmetros de entrada
A aplicação Sales foi concebida para fornecer os seguintes parâmetros de entrada às suas APIs.
| Name | Tipo de dados/formato | Obrigatório | Detalhes | Descrição a adicionar na ação |
|---|---|---|---|---|
| recordType | Cadeia (de carateres) | Sim | O tipo de entidade ou objeto no CRM para o qual são pedidas informações relacionadas, tais como atividades. O valor inclui o nome exclusivo independente de idioma da entidade ou do tipo de objeto, não o nome a apresentar que pode ser localizado. Os exemplos incluem conta e oportunidade. | Esta entrada indica o tipo de objeto ou entidade na CRM para o qual são pedidas informações. |
| recordId | Cadeia (de carateres) | Sim | O identificador exclusivo do registo do CRM. | Esta entrada indica o identificador exclusivo do registo da CRM para o qual são pedidas as informações. |
| DataHoraDeInício | Cadeia (de carateres) no formato "data/hora" | Não | A data e hora de início para procurar informações. O formato segue a especificação de OpenAPI. Segue-se um exemplo: 2017-07-21T17:32:28Z. | Esta entrada indica a data e hora de início das informações pedidas. |
| endDateTime | Cadeia (de carateres) no formato "data/hora" | Não | A data e hora de fim para procurar informações. O formato segue a especificação de OpenAPI. Segue-se um exemplo: 2017-07-21T17:32:28Z. | Esta entrada indica a data e hora de fim das informações pedidas. |
| principal | Número inteiro | Não | O número de informações a obter. | Esta entrada indica o número de informações a obter. |
| ignorar | Número inteiro | Não | O número de informações a ignorar. | Esta entrada indica o número de informações a ignorar. |
| crmType | Cadeia (de carateres) | Não | Os valores válidos são Dynamics 365 e Salesforce. | Esta entrada indica o tipo de CRM no qual o registo da CRM existe, para o qual são pedidas as informações. |
| crmOrgUrl | Cadeia (de carateres) | Não | O nome do host da organização do CRM, como contoso.crm.dynamics.com. | Esta entrada indica o URL do ambiente da CRM no qual o registo da CRM existe, para o qual são pedidas as informações. |
Parâmetros de saída
A aplicação de Vendas espera receber uma lista de insights (objetos) das suas APIs, e espera que cada insight tenha parâmetros específicos. Para garantir que a aplicação Sales consegue analisar corretamente a saída, a estrutura de resposta deve seguir as diretrizes da tabela seguinte.
| Parâmetro | Tipo de dados | Obrigatório | Detalhes |
|---|---|---|---|
| valor | Matriz | Sim | Uma lista de informações (objetos) que são definidas conforme descrito na secção Esquema para informações. |
| hasMoreResults | booleano | Não | Um valor que indica se estão disponíveis mais resultados. |
Esquema para informações
| Name | Tipo de dados/formato | Obrigatório | Detalhes | Descrição a ser adicionada na ação |
|---|---|---|---|---|
| cargo | Cadeia (de carateres) | Sim | O título das informações no cartão de citações. É o título em linguagem natural das informações no idioma especificado através do cabeçalho do pedido Accept-Language. Segue-se um exemplo: Contrato assinado. |
Esta saída indica o título da atividade no cartão de citações. |
| descrição | Cadeia (de carateres) | Sim | A descrição das informações. É mostrado como marcas de lista no resumo do registo e é a descrição em linguagem natural das informações no idioma especificado através do cabeçalho Accept-Language. Aqui está um exemplo: Kenny, Logan e outros dois assinaram o Contrato de Renovação Contoso 2023 em 7/9/2023. |
Esta saída indica a descrição das informações. |
| dateTime | Cadeia (de carateres) no formato "data/hora" | Sim | A data e hora da atividade no formato UTC. Se a atividade tiver uma hora de início e uma hora de fim, a aplicação deve determinar a hora a mostrar. O formato segue a especificação de OpenAPI. Segue-se um exemplo: 2017-07-21T17:32:28Z. | Esta saída indica o tempo associado às informações. |
| url | Cadeia (de carateres) | Não | Um URL válido para abrir a atividade na aplicação de parceiro. | Esta saída indica o URL para abrir informações. |
| additionalProperties | Um objeto que tem os valores Nome da Propriedade e Valor da Propriedade do tipo Cadeia (de carateres) | Não | Propriedades adicionais que são mostradas na vista detalhada. Os nomes e valores de propriedade estão em linguagem natural no idioma especificado através do cabeçalho { |
Esta saída indica propriedades adicionais apresentadas na vista detalhada das informações. |
Nota
Embora os requisitos da API para expandir as capacidades de resumo de e-mail e de resumo de registos possam parecer semelhantes, têm de ser adicionados como ações separadas no conector.
Exemplo
{
"value": [
{
"title": "Contract signed",
"description": "You have 5 connections in Fourth Coffee Inc",
"dateTime": "2024-05-07T03:28:38.0667701Z",
"url": null,
"additionalProperties": {
"Contract name": "50 Cafe-A-100 Automatic Renewal Contract",
"Signed by": "Alberto Burgos, Tony",
"Signed": "9/7/23"
}
},
{
"title": "Contract signed",
"description": "Multiple stakeholders from Fourth Coffee have visited the Contoso website four times in the last four months",
"dateTime": "2024-05-07T03:28:38.0669445Z",
"url": null,
"additionalProperties": {
"Contract name": "50 Cafe-A-100 Automatic Renewal Contract",
"Signed by": "Alberto Burgos, Tony",
"Signed": "9/7/23"
}
}
],
"hasMoreResults": false
}
O exemplo na imagem a seguir mostra um exemplo de como a saída da API é mapeada para o resumo de registos.
Legenda:
- Secção que mostra informações da aplicação de parceiro. O título da secção é derivado do nome do conector do Microsoft Power Platform.
- Descrições das informações da resposta da API.
- Números de citação que podem ser selecionados para ver detalhes sobre as informações.
- Cartão de citações que mostra detalhes sobre as informações.
- Ícone e título das informações. O ícone é obtido dos metadados do conector do Microsoft Power Platform. O texto do título é o título das informações da resposta da API.
- Propriedades adicionais das informações da resposta da API.
- Nome da aplicação parceira. O nome que é mostrado é o nome do conector do Microsoft Power Platform.
- Ligação que pode ser selecionada para ver os detalhes das informações na aplicação do parceiro. Baseia-se no URL das informações na resposta da API.
Informações relacionadas
Ver resumo de registo
Enriquecer resumos do e-mail com informações da sua aplicação
Melhorar rascunhos de e-mail com ligações de ficheiro da sua aplicação
Enriqueça insights de oportunidades com dados de seu aplicativo
Melhorar detalhes do registo CRM com informações da sua aplicação
Amplie as Vendas no Microsoft 365 Copilot com aplicações parceiras
Construir extensões para Vendas no Microsoft 365 Copilot