Comparteix a través de

Enriquir els detalls dels registres del CRM amb informació de l'aplicació (versió preliminar)

  • Article

Important

  • Aquesta és una funció en versió preliminar llesta per a la producció.
  • Les previsualitzacions preparades per a la producció estan subjectes a condicions d'ús addicionals.

[Aquest article forma part de la documentació preliminar i està subjecte a canvis.]

Els venedors poden veure detalls sobre un contacte desat, juntament amb registres associats, com ara comptes i oportunitats. Podeu ampliar la capacitat de detalls de registre de gestió de relacions amb els clients (CRM) que proporciona Copilot for Sales amb informació de la vostra pròpia aplicació.

Descripció de l'API

Heu d'afegir la següent descripció de l'API a l'acció. D'aquesta manera, Copilot for Sales pot identificar l'API correcta que s'ha d'invocar per enriquir la capacitat.

Aquesta acció obté registres relacionats amb un registre del CRM. L'acció potencia les habilitats existents de Copilot for Sales.

Funcionament de l'API

Aquesta API utilitza el tipus d'operació: GET

Paràmetres d’entrada

Copilot for Sales està dissenyat per proporcionar els paràmetres d'entrada següents a les vostres API.

Nom Tipus/format de dades Necessari Detalles Descripció per afegir a l'acció
recordType String Sí Tipus d'entitat o objecte del CRM per al qual es sol·liciten els registres relacionats. El valor inclou el nom únic independent de l'idioma de l'entitat o del tipus d'objecte, no el nom de visualització que es pot localitzar. Alguns exemples inclouen el compte i l'oportunitat. Aquesta entrada identifica el tipus de registre al CRM per al qual es sol·liciten registres relacionats.
registreId String Sí L'identificador únic del registre del CRM. Aquesta entrada proporciona l'identificador únic del registre CRM per al qual se sol·liciten registres relacionats.
principal Integer No El nombre d'activitats que s'han d'obtenir. Aquesta entrada indica el nombre de registres relacionats que s'han de recuperar.
omet Integer No El nombre d'activitats a saltar. Aquesta entrada indica el nombre de registres que s'han d'ometre quan s'obtenen registres relacionats.
Tipus de crm String No El tipus de sistema CRM. Els valors vàlids són Dynamics 365 i Salesforce. Aquesta entrada indica el tipus de CRM des del qual s'obtenen els registres relacionats.
crmOrgUrl String No El nom d'amfitrió de l'organització del CRM, com ara contoso.crm.dynamics.com. Aquesta entrada indica l'adreça URL de l'entorn CRM des de la qual s'obtenen els registres relacionats.

Nota

Aquest punt d'extensió admet la representació d'informació de fins a cinc extensions de connector al sidecar de l'Outlook.

Paràmetres de sortida

Copilot for Sales espera rebre una llista d'informació (objectes) de les vostres API i espera que cada informació tingui paràmetres específics. Per garantir que Copilot for Sales pugui analitzar correctament la sortida, l'estructura de resposta ha de complir les directrius de la taula següent.

Paràmetre Tipus de dades Necessari Detalles
valor Matriu Sí Llista d'estadístiques (objectes) que es defineixen tal com es descriu a la secció Esquema per a les estadístiques .
hasMoreResults Boolean No Valor que indica si hi ha més resultats disponibles.

Esquema per a estadístiques

Nom Tipus/format de dades Necessari Detalles Descripció per afegir a l'acció
registreId String Sí L'identificador únic del registre. Aquesta sortida identifica de manera única cada registre relacionat retornat per l'acció.
recordTypeDisplayName String Sí Nom de visualització del tipus de registre, com ara Contracte. S'ha de localitzar en l'idioma que s'especifica a través de la capçalera Accept-Language . Aquesta sortida indica el nom de visualització del tipus de registre de cada registre relacionat retornat per l'acció.
recordTypePluralDisplayName String Sí El nom de visualització en plural del tipus de registre, com ara Contractes. S'ha de localitzar en l'idioma que s'especifica a través de la capçalera Accept-Language . Aquesta sortida indica el nom de visualització en plural del tipus de registre de cada registre relacionat retornat per l'acció.
recordType String Sí Nom del sistema del tipus de registre, com ara contracte. Aquesta sortida indica el tipus de cada registre relacionat retornat per l'acció.
registreTítol String Sí El nom del registre, com ara Contracte de renovació de Contoso 2023. Aquesta sortida indica el títol de cada registre relacionat retornat per l'acció.
url String No Una adreça URL vàlida per obrir el registre a l'aplicació associada. Aquesta sortida indica l'adreça URL de cada registre relacionat retornat per l'acció.
Propietats addicionals Un objecte que té valors Nom de propietat i Valor de propietat del tipus Cadena No

Propietats addicionals que es mostren a la visualització detallada. Els noms i valors de les propietats estan en llenguatge natural en el llenguatge que s'especifica a través de la capçalera Accept-Language . Aquest és un exemple.

{
 "Motiu de l'estat": "S'ha signat",
 "Propietari": "Kenny Smith"
}
 Aquesta sortida indica propietats addicionals com a parells nom-valor de cada registre relacionat retornat per l'acció.

Exemple

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

L'exemple de la imatge següent mostra com s'assigna la sortida de l'API als registres relacionats.

Captura de pantalla que mostra l'anatomia dels registres relacionats d'una aplicació associada.

Llegenda:

  1. Targeta que mostra els registres relacionats de l'aplicació de socis.
  2. Icona i títol de la targeta. La icona es recupera de les metadades del Microsoft Power Platform connector. El títol és el nom del Microsoft Power Platform connector.
  3. Títols de registres relacionats de la resposta de l'API. Dues propietats addicionals de la resposta de l'API es representen com a camps clau de cada registre relacionat.
  4. Botó "Més accions" que es pot utilitzar per copiar un enllaç al registre o per visualitzar els detalls del registre a l'aplicació del soci. L'enllaç es basa en l'adreça URL del registre relacionat a la resposta de l'API.
  5. Propietats addicionals del registre relacionat de la resposta de l'API.

Visualitza els detalls del registre
Enriqueix els resums de correu electrònic amb informació de la teva aplicació
Enriqueix els esborranys de correu electrònic amb enllaços de fitxers de la teva aplicació
Enriqueix la informació clau de vendes amb informació de la teva aplicació
Enriquir els resums de registres del CRM amb informació de l'aplicació
Ampliar Microsoft 365 Copilot for Sales amb aplicacions de partners
Crear extensions de Copilot per al Sales