Enriquecer os detalhes do registo CRM com informações da sua aplicação (pré-visualização)
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.]
Os vendedores podem ver os detalhes sobre um contacto guardado, juntamente com os respetivos registos associados, como contas e oportunidades. Pode estender a capacidade de detalhes de registo do CRM (gestão das relações com os clientes) que o Copilot para Vendas fornece com informações da sua própria aplicação.
Descrição da API
Tem de adicionar a seguinte descrição da API à ação. Dessa forma, o Copilot para Vendas pode identificar a API correta que deve ser invocada para melhorar o recurso.
Esta ação obtém registos relacionados com um registo do CRM. A ação aprimora as capacidades existentes do Copilot para Vendas.
Parâmetros de entrada
O Copilot para Vendas foi concebido para fornecer os seguintes parâmetros de entrada às suas APIs.
| Nome | Tipo de dados/formato | Obrigatório | Details | Descrição a adicionar na ação |
|---|---|---|---|---|
| recordType | Cadeia (de carateres) | Sim | O tipo de entidade ou objeto no CRM para o qual os registos relacionados são pedidos. 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 identifica o tipo de registo na CRM para o qual são pedidos os registos relacionados. |
| recordId | Cadeia (de carateres) | Sim | O identificador exclusivo do registo do CRM. | Esta entrada fornece o identificador exclusivo do registo da CRM para o qual são pedidos os registos relacionados. |
| principal | Número inteiro | Não | O número de atividades a obter. | Esta entrada indica o número de registos relacionados a obter. |
| skip | Número inteiro | Não | O número de atividades a ignorar. | Esta entrada indica o número de registos a ignorar ao obter registos relacionados. |
| crmType | Cadeia (de carateres) | Não | O tipo de sistema de CRM. Os valores válidos são Dynamics 365 e Salesforce. | Esta entrada indica o tipo de CRM a partir da qual os registos relacionados são obtidos. |
| 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 de CRM a partir da qual os registos relacionados são obtidos. |
Nota
Este ponto de extensão suporta a composição de informações de até cinco extensões de conector no sidecar do Outlook.
Parâmetros de saída
O Copilot para Vendas espera receber uma lista de informações (objetos) das suas APIs e espera que cada informação tenha parâmetros específicos. Para garantir que o Copilot para Vendas pode analisar corretamente a saída, a estrutura de resposta deve seguir as diretrizes na tabela seguinte.
| Parâmetro | Tipo de dados | Obrigatório | Details |
|---|---|---|---|
| valor | Matriz | Sim | Uma lista de informações (objetos) que são definidas conforme descrito na secção Esquema para informações. |
| hasMoreResults | Boolean | Não | Um valor que indica se estão disponíveis mais resultados. |
Esquema para informações
| Nome | Tipo de dados/formato | Obrigatório | Details | Descrição a adicionar na ação |
|---|---|---|---|---|
| recordId | Cadeia (de carateres) | Sim | O identificador exclusivo do registo. | Esta saída identifica exclusivamente cada registo relacionado devolvido pela ação. |
| recordTypeDisplayName | Cadeia (de carateres) | Sim | O nome para apresentação do tipo de registo, como Contrato. Deve ser localizado no idioma especificado através do cabeçalho Accept-Language. |
Esta saída indica o nome a apresentar de tipo de registo de cada registo relacionado devolvido pela ação. |
| recordTypePluralDisplayName | Cadeia (de carateres) | Sim | O nome a apresentar no plural do tipo de registo, como Contratos. Deve ser localizado no idioma especificado através do cabeçalho Accept-Language. |
Esta saída indica o nome a apresentar plural do tipo de registo de cada registo relacionado devolvido pela ação. |
| recordType | Cadeia (de carateres) | Sim | O nome do sistema do tipo de registo, como contrato. | Esta saída indica o tipo de cada registo relacionado devolvido pela ação. |
| recordTitle | Cadeia (de carateres) | Sim | O nome do registo, como Contrato de renovação Contoso 2023. | Esta saída indica o título de cada registo relacionado devolvido pela ação. |
| url | Cadeia (de carateres) | Não | Um URL válido para abrir o registo na aplicação parceira. | Esta saída indica o URL de cada registo relacionado devolvido pela ação. |
| 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 como pares nome-valor de cada registo relacionado devolvido pela ação. |
Exemplo
{
"value": [
{
"recordId": "ID1",
"recordTypeDisplayName": "Contract",
"recordTitle": "50 Cafe A-100 Automatic Renewal Contract",
"recordTypePluralDisplayName": "Documents",
"recordType": "contract",
"url": "https://contosohub.com/contract/id1",
"additionalProperties": {
"Status": "Signed",
"Date": "9/7/23",
"Signed by": "Alberto Burgos, Tony [last name]"
}
},
{
"recordId": "ID2",
"recordTypeDisplayName": "Contract",
"recordTitle": "ABC Company 2023 Renewal Contract",
"recordTypePluralDisplayName": "Documents",
"recordType": "contract",
"url": "https://contosohub.com/contract/id2",
"additionalProperties": {
"Status": "Delivered",
"Date": "9/3/23",
"Signed by": "Alberto Burgos"
}
}
],
"hasMoreResults": false
}
O exemplo na imagem que se segue mostra como a saída da API é mapeada para os registos relacionados.
Legenda:
- Cartão que mostra os registos relacionados da aplicação do parceiro.
- Ícone e título do cartão. O ícone é obtido dos metadados do conector do Microsoft Power Platform. O título é o nome do conector do Microsoft Power Platform.
- Títulos de registo relacionados da resposta da API. Duas propriedades adicionais da resposta da API são compostas como campos-chave de cada registo relacionado.
- Botão "Mais ações" que pode ser usado para copiar uma ligação para o registo ou para ver os detalhes do registo na aplicação de parceiro. A ligação é baseada no URL do registo relacionado na resposta da API.
- Propriedades adicionais do registo relacionado da resposta da API.
Informações relacionadas
Ver os detalhes de registo
Melhorar o resumos de e-mail com informações da sua aplicação
Melhorar rascunhos de e-mail com ligações de ficheiro da sua aplicação
Melhorar informações principais de vendas com informações da sua aplicação
Melhorar os resumos do registo CRM com informações da sua aplicação
Expandir o Microsoft 365 Copilot para Vendas com aplicações de parceiros
Compilar extensões do Copilot para Vendas