Référence d’API de Rendez-vous intelligents
Important
À compter du 22 mai 2024, les rendez-vous intelligents sont obsolètes et ne sont plus disponibles pour le déploiement. Les utilisateurs existants peuvent continuer à utiliser la fonctionnalité normalement s’ils l’ont déjà déployée et configurée.
Utilisez l’ensemble d’API Rendez-vous intelligents pour rechercher des conseillers pertinents et pour planifier et gérer des réunions. L’API est basée sur l’API personnalisée Power Platform.
Note
Toutes les commandes de cette API utilisent des messages POST.
Disponibilité et planification des Commandes
Commande | Description |
---|---|
GetSchedulingProperties | Récupère toutes les informations relatives aux types de réunions à partir de l’environnement Dataverse. |
GetAvailableMeetingTimeSlots | Récupère les créneaux horaires disponibles du conseiller concerné en fonction du lieu, du sujet, des compétences et de la plage de dates demandés. |
CreateMeeting | Permet de programmer une réunion avec les ressources de conseiller demandées. |
GetMeeting | Récupère une réunion planifiée pour un contact. |
CancelMeeting | Annule une réunion existante. |
GetSchedulingProperties
Description : Récupère toutes les informations relatives aux types de réunions à partir de l’environnement Dataverse.
Nom du plug-in : GetSchedulingPropertiesPlugin.cs
Requête HTTP : POST {{url}}/api/data/v9.0/msfsi_GetSchedulingProperties
Demander des paramètres d’entrée (dans le corps) : Vide
Paramètres de sortie de réponse :
Nom du paramètre | Description | Type | Remarques |
---|---|---|---|
Emplacements | Choix des objets de lieu. Il s’agit de lieux qui résident dans les objets MeetingType. | Tableau d’objets | Les objets Lieu sont renseignés lorsque les réunions se déroulent uniquement sur place. |
Rubriques | Choix des objets de sujet. Il s’agit de sujets qui résident dans les objets MeetingType. | Tableau d’objets | |
Types de réunion | Un tableau de MeetingTypes | Tableau d’objets | |
Objet de lieu | |||
ID | ID de lieu (entité OrganizationalUnit). | Chaîne | |
Nom | Nom du lieu (entité de branche). | Chaîne | |
Adresse1 | Première ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Adresse2 | Deuxième ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Ville | Nom de la ville (entité de branche). | Chaîne | |
StateOrProvince | État ou province du lieu (entité de branche). | Chaîne | |
Pays | Pays du lieu (entité de branche). | Chaîne | |
PostalCode | Code postal du lieu (entité de branche). | Chaîne | |
Téléphone | Numéro de téléphone du lieu (entité de branche). | Chaîne | |
Objet du sujet | |||
ID | ID du sujet. | Chaîne | |
Nom | Nom du sujet. | Chaîne | |
Description | Description du sujet. | Chaîne | |
Objet MeetingType | |||
ID | ID du MeetingType. | Chaîne | |
Nom | Nom du MeetingType. | Chaîne | |
Description | Description du MeetingType. | Chaîne | |
Durée | Durée de la réunion décrite par le MeetingType. | Entier | |
Remarques | Notes pour le participant à la réunion à venir. | Chaîne | |
Rubriques | Tableau d’ID pour les sujets reliés à ce MeetingType. | Chaîne[] | La liste complète et détaillée est disponible dans le tableau Sujets. |
Emplacements | Tableau d’ID pour les lieux reliés à ce MeetingType. | Chaîne[] | Les objets Lieu sont renseignés lorsque les réunions se déroulent uniquement sur place. La liste détaillée complète est disponible dans le tableau Lieux. |
Canal | Canal défini pour ce MeetingType. | Groupe d’options |
Chaque groupe d’options est représenté par un objet contenant la valeur et l’étiquette. |
DefaultMethod | Méthode par défaut définie pour ce MeetingType. | Groupe d’options |
Chaque groupe d’options est représenté par un objet contenant la valeur et l’étiquette. |
Note
Certains paramètres ne sont pas retournés :
Les réunions qui se déroulent uniquement sur place et qui n’ont pas de branches ne sont pas affichées.
Les réunions sans champs obligatoires ne sont pas affichées.
Les entités à l’état inactif ne sont pas affichées.
Les paramètres suivants peuvent ne pas renvoyer de valeurs :
Les paramètres Channel et DefaultMethod ne sont pas renvoyés s’ils sont nuls.
Si aucun lieu n’est relié au MeetingType, il n’a pas de tableau Lieux. Ceci n’est possible que si le canal a une valeur autre que Sur site.
Le paramètre Sujets peut ne pas s’afficher si aucun sujet n’est connecté au MeetingType (via l’entité Connection).
Les paramètres ID, Name, Description et Duration font toujours partie de chaque élément de la réponse.
Sujet et Lieu sont des tableaux qui contiennent des entités. ID est le seul paramètre obligatoire pour les objets Sujet et Lieu.
Exemple de réponse :
{
"@odata.context": "https://orgc7816042.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetSchedulingPropertiesResponse",
"Locations": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "0781fd19-f1a8-ec11-983f-000d3a323337",
"Name": "Woodgrove Oklahoma City branch",
"Address1": "91011 East Blue Stone Drive",
"Address2": "91011 East Blue Stone Drive",
"City": "Oklahoma City",
"Country": "USA",
"PostalCode": "64555",
"Telephone": "+1(917)145-4533"
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "600ef125-f1a8-ec11-983f-000d3a323337",
"Name": "Woodgrove Savannah branch",
"Address1": "678 Van Hoose Drive",
"Address2": "678 Van Hoose Drive",
"City": "Savannah",
"Country": "USA",
"PostalCode": "48645",
"Telephone": "+1(403)123-4567"
}
],
"Topics": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "5a007aa3-809f-ec11-b400-0022480b8113",
"Name": "Everyday banking",
"Description": "Account opening, credit cards, financial health check ups and general assistance subjects"
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "eb4e85b5-819f-ec11-b400-0022480b8113",
"Name": "Loans",
"Description": "Mortgage, Loan consults, follow up and contracting meetings"
}
],
"MeetingTypes": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "5ce28b83-899f-ec11-b400-0022480b8113",
"Name": "Apply for credit card",
"Description": "Submitting an application for a credit card program",
"Duration": 30,
"Topics@odata.type": "#Collection(String)",
"Topics": [
"5a007aa3-809f-ec11-b400-0022480b8113"
],
"Locations@odata.type": "#Collection(String)",
"Locations": [
"0781fd19-f1a8-ec11-983f-000d3a323337",
"600ef125-f1a8-ec11-983f-000d3a323337"
],
"Channel": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800002,
"Label": "Online or on location"
},
"DefaultMethod": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800000,
"Label": "Online"
}
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "1167906a-8d9f-ec11-b400-0022480b8113",
"Name": "Mortgage Application phase 1",
"Description": "Onboarding meeting to submit a loan application for a specific property",
"Duration": 30,
"Topics@odata.type": "#Collection(String)",
"Topics": [
"eb4e85b5-819f-ec11-b400-0022480b8113"
],
"Locations@odata.type": "#Collection(String)",
"Channel": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800002,
"Label": "Online only"
},
"DefaultMethod": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 104800000,
"Label": "Online"
}
}
]
}
GetAvailableMeetingTimeSlots
Description : Récupère les créneaux horaires disponibles du conseiller concerné en fonction du lieu, du sujet, des compétences et de la plage de dates demandés.
Nom du plug-in : GetTimeSlotsPlugin.cs
Requête HTTP : POST {{url}}/api/data/v9.0/msfsi_GetAvailableMeetingTimeSlots
Demander des paramètres d’entrée (dans le corps) :
Nom du paramètre | Description | Type | Requise | Remarques |
---|---|---|---|---|
MeetingType | ID du MeetingType que l’utilisateur souhaite rechercher. | Chaîne (ID msfsi_meetingtype) | Oui | La valeur de ce paramètre doit être un GUID valide. |
StartDateTime | La date et l’heure de début de la recherche de disponibilité. | DateTime | Oui | L’heure fournie doit être en UTC. |
EndDateTime | La date et l’heure de fin de la recherche de disponibilité. | DateTime | Oui | L’heure fournie doit être en UTC. |
RequestedMeetingLocation | ID du lieu (OrganizationalUnit) que l’utilisateur souhaite rechercher. | Chaîne (ID msdyn_organizationalunit) | Non | Obligatoire lorsque IsOnlineMeeting est défini sur false. La valeur de ce paramètre doit être un GUID valide. |
IsOnlineMeeting | Indique si l’événement est une réunion en ligne ou non. | Entier | Oui | |
SkillFilter | Tableau de châines contenant tous les ID des compétences à inclure dans la recherche de demande de disponibilité. | String[] (ID des caractéristiques) | Non | L’ajout de filtres déjà définis par défaut sur le modèle de groupe de ressources entraîne une erreur. La valeur de ce paramètre doit être un GUID valide. |
Pagination | ID de la chaîne de pagination. Si aucun n’est fourni, récupère la première page ; sinon, renvoie la page correspondante. | Chaîne | Non |
Exemple de requête :
{
"MeetingType": "5ce28b83-899f-ec11-b400-0022480b8113",
"StartDateTime": "2022-08-21T11:00:00+03:00",
"EndDateTime": "2022-08-23T12:00:00+03:00",
"IsOnlineMeeting": false,
"RequestedMeetingLocation": "cfc7f51f-f1a8-ec11-983f-000d3a323337",
"SkillFilter": [
"2953c0d2-d2d9-ec11-a7b6-000d3a3089fb"
],
"Paging": ""
}
Paramètres de sortie de réponse :
Nom du paramètre | Description | Type | Remarques |
---|---|---|---|
Plages horaires | Tableau d’objets Plages horaires, représentant les plages horaires disponibles renvoyées pour les conseillers demandés, le type de réunion et le lieu. | Tableau d’objets Plages horaires | |
Pagination suivante | Chaîne de pagination utilisée pour la pagination. Si aucun résultat n’est disponible, cette valeur est nulle. | Chaîne | Pour plus d’informations, consultez la documentation URS. |
Objet Plages horaires | |||
StartTime | La date et l’heure de début spécifiées dans la demande de recherche. | DateHeure | L’heure est renvoyé en UTC. |
EndTime | La date et l’heure de fin spécifiées dans la demande de recherche. | DateHeure | L’heure est renvoyé en UTC. |
Conseillers | Liste d’objets représentants les conseillers. Chaque objet contient un identifiant et un nom de conseiller. | Tableau d’objets | Ces IDs sont utilisés lors de la création de la réunion à l’aide de CreateMeeting et pour extraire les informations de ressource pour les afficher. Un seul ensemble de conseillers est renvoyé pour chaque plage horaire. Si l’exigence d’un type de réunion concerne un seul conseiller lors de la réunion, chaque créneau horaire ne contient qu’une seule valeur. Si plusieurs conseillers sont disponibles, le moteur de planification hiérarchise les conseillers en fonction du contexte et de la capacité. |
Exemple de réponse : Certains des créneaux horaires retournés ont été supprimés, pour des raisons d’espace.
Note
NextPaging est ajouté lorsque plus de 20 plages horaires sont renvoyées.
{
"@odata.context": "https://demoenvironment.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_GetAvailableMeetingTimeSlotsResponse",
"NextPaging": "{\"nte\":\"1\",\"nti\":\"2022-08-21T17:30:00.0000000Z\",\"res\":{\"nfr\":20,\"nft\":20,\"rbd\":{\"2022-08-21T08:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T08:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T09:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T10:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T11:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T12:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T13:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T14:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T15:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T16:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:00:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null},\"2022-08-21T17:30:00.0000000Z\":{\"cpl\":1,\"nfr\":1,\"nft\":1,\"tic\":null,\"tid\":null}}}}",
"Timeslots": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"StartTime": "2022-08-21T08:15:00Z",
"EndTime": "2022-08-21T08:45:00Z",
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
"Name": "Temp Admin"
}
]
},
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"StartTime": "2022-08-21T08:45:00Z",
"EndTime": "2022-08-21T09:15:00Z",
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "876b4623-5d08-ed11-82e4-000d3a364a5d",
"Name": "Temp Admin"
}
]
}
]
}
CreateMeeting
Description : Permet de programmer une réunion avec les ressources de conseiller demandées.
Nom du plug-in : CreateMeetingPlugin.cs
Requête HTTP : POST {{url}}/api/data/v9.0/msfsi_CreateMeeting
Demander des paramètres d’entrée (dans le corps) :
Nom du paramètre | Description | Type | Requise | Remarques |
---|---|---|---|---|
MeetingType | ID du MeetingType sélectionné. | Chaîne (msfsi_meetingtype) | Oui | La valeur de ce paramètre doit être un GUID valide. |
StartDateTime | Date et heure de début de la réunion. | DateHeure | Oui | Les rendez-vous de préparation et de synthèse sont ajoutés au calendrier du conseiller en fonction du type de rendez-vous et de la configuration Administrateur. |
Contact | L’ID de contact qui représente le client participant à la réunion. | Chaîne (ID de contact) | Oui | La valeur de ce paramètre doit être un GUID valide. |
IsOnlineMeeting | Indique si l’événement est une réunion en ligne ou non. | Valeur booléenne | Oui | Si cette valeur est False, il est obligatoire de fournir à la place un lieu de réunion. |
RequestedMeetingLocation | ID de lieu (OrganizationalUnit) où la réunion doit se tenir. | Chaîne (ID OrganizationalUnit(OU)) | No | Pour une réunion en ligne, ce champ n’est pas obligatoire. Pour une implémentation de réunion en ligne où les conseillers en ligne se trouvent dans une unité organisationnelle (UO) spécifique, une référence d’UO dédiée est requise. |
RequestedAdvisors | Tableau des ID de conseiller requis (ID de ressources réservables). Ces ID sont tirés du tableau Conseillers fourni dans la réponse GetAvailableMeetingTimeSlots. | EntityCollection ((Resources) | Oui | Pour que la réservation réussisse, les ressources doivent être associées à des utilisateurs système. Ces utilisateurs apparaissent dans le champ Obligatoire du rendez-vous. Les chaînes à l’intérieur du tableau doivent être des GUID valides. |
CustomerAdditionalNotes | Notes que les clients souhaitent partager sur la réunion à venir. | Chaîne | Non | Ce paramètre apparaît dans les communications client et la description du rendez-vous dans l’application CRM. |
Exemple de requête :
{
"MeetingType": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"StartDateTime": "2022-8-17T12:30:00",
"Contact": "8788facf-828e-4333-8405-b825b0f29ea0",
"IsOnlineMeeting": false,
"RequestedMeetingLocation": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"RequestedAdvisors": ["8240fdbc-e20d-ed11-82e5-000d3a593e34"],
"CustomerAdditionalNotes": "Some test notes"
}
Paramètres de sortie de réponse :
Nom du paramètre | Description | Type | Remarques |
---|---|---|---|
ID | Un identifiant représentant la réunion planifiée. | Chaîne | Représente un GUID. |
StartTime | Date et heure de début de la réunion. | DateHeure | L’heure est indiquée en UTC. |
EndTime | Date et heure de fin de la réunion. | DateHeure | L’heure est indiquée en UTC. |
Durée | Durée de la réunion planifiée en minutes. | Entier | |
IsOnline | Indique si l’événement est une réunion en ligne ou non. | Entier | |
CustomerAdditionalNotes | Notes que les clients souhaitent partager sur la réunion planifiée. | Chaîne | |
MeetingJoinUrl | Lien pour rejoindre la réunion planifiée. | Chaîne | |
État | État actuel de la réunion planifiée. | Groupe d’options (objet) |
Chaque groupe d’options est représenté par un objet contenant la valeur et l’étiquette. |
Emplacement | Objet du lieu de la réunion pour un rendez-vous sur place. | Object | Ce paramètre n’est pas vide uniquement pour les réunions qui se déroulent sur place. |
Conseillers | Liste d’objets représentant les conseillers dans la réunion planifiée. | Tableau d’objets | |
MeetingType | Objet représentant le MeetingType. | Objet | |
Objet de lieu | |||
ID | ID de lieu (entité OrganizationalUnit). | Chaîne | Représente un GUID. |
Nom | Nom du lieu (entité de branche). | Chaîne | |
Adresse1 | Première ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Adresse2 | Première ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Ville | Nom de la ville (entité de branche). | Chaîne | |
StateOrProvince | État ou province du lieu (entité de branche). | Chaîne | |
Pays | Pays du lieu (entité de branche). | Chaîne | |
PostalCode | Code postal du lieu (entité de branche). | Chaîne | |
Téléphone | Numéro de téléphone du lieu (entité de branche). | Chaîne | |
Objet conseiller | |||
ID | ID du conseiller (entité de ressource réservable). | Chaîne | Représente un GUID. |
Nom | Nom du conseiller. | Chaîne | |
Objet MeetingType | |||
ID | ID du MeetingType. | Chaîne | |
Nom | Nom du MeetingType. | Chaîne | |
Remarques | Notes pour le participant à la réunion à venir. | Chaîne | |
Description | Description du MeetingType. | Chaîne |
Exemple de réponse :
{
"@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"StartTime": "2022-08-17T12:30:00Z",
"EndTime": "2022-08-17T13:15:00Z",
"Duration": 45,
"IsOnline": false,
"CustomerAdditionalNotes": "Some test notes",
"State": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 3,
"Label": "Scheduled"
},
"Location": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"Name": "Woodgrove Anchorage branch",
"Address1": "123 Eastview Lane",
"City": "Anchorage"
},
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
"Name": "IS admin"
}
],
"MeetingType": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"Name": "Setting Investment goals",
"Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
"Description": "Creating wealth management goals"
}
}
GetMeeting
Description : Récupère une réunion planifiée pour un contact.
Nom du plug-in : GetMeetingPlugin.cs
Requête HTTP : POST {{url}}/api/data/v9.0/msfsi_GetMeeting
Demander des paramètres d’entrée (dans le corps) :
Nom du paramètre | Description | Type | Requise | Remarques |
---|---|---|---|---|
Réunion | ID de la réunion. | Chaîne | Oui | L’identifiant de la réunion est tiré de la réponse CreateMeeting. La valeur de ce paramètre doit être un GUID valide. |
Contact | ID client pour lequel la réunion est planifiée. | Chaîne | Oui | La valeur de ce paramètre doit être un GUID valide. |
Exemple de requête :
{
"Meeting": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"Contact": "8788facf-828e-4333-8405-b825b0f29ea0"
}
Paramètres de sortie de réponse :
Nom du paramètre | Description | Type | Remarques |
---|---|---|---|
ID | Un identifiant représentant la réunion planifiée. | Chaîne | Représente un GUID. |
StartTime | Date et heure de début de la réunion. | DateHeure | L’heure est indiquée en UTC. |
EndTime | Date et heure de fin de la réunion. | DateHeure | L’heure est indiquée en UTC. |
Durée | Durée de la réunion planifiée en minutes. | Entier | |
IsOnline | Indique si l’événement est une réunion en ligne ou non. | Entier | |
CustomerAdditionalNotes | Notes que les clients souhaitent partager sur la réunion planifiée. | Chaîne | |
MeetingJoinUrl | Lien pour rejoindre la réunion planifiée. | Chaîne | |
État | État actuel de la réunion planifiée. | Groupe d’options (objet) |
Chaque groupe d’options est représenté par un objet contenant la valeur et l’étiquette. |
Emplacement | Objet du lieu de la réunion pour un rendez-vous sur place. | Object | Ce paramètre n’est pas vide uniquement pour les réunions qui se déroulent sur place. |
Conseillers | Liste d’objets représentant les conseillers dans la réunion planifiée. | Tableau d’objets | |
MeetingType | Objet représentant le MeetingType. | Objet | |
Objet de lieu | |||
ID | ID de lieu (entité OrganizationalUnit). | Chaîne | Représente un GUID. |
Nom | Nom du lieu (entité de branche). | Chaîne | |
Adresse1 | Première ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Adresse2 | Première ligne de l’adresse du lieu (entité de branche). | Chaîne | |
Ville | Nom de la ville (entité de branche). | Chaîne | |
StateOrProvince | État ou province du lieu (entité de branche). | Chaîne | |
Pays | Pays du lieu (entité de branche). | Chaîne | |
PostalCode | Code postal du lieu (entité de branche). | Chaîne | |
Téléphone | Numéro de téléphone du lieu (entité de branche). | Chaîne | |
Objet conseiller | |||
ID | ID du conseiller (entité de ressource réservable). | Chaîne | Représente un GUID. |
Nom | Nom du conseiller. | Chaîne | |
Objet MeetingType | |||
ID | ID du MeetingType. | Chaîne | |
Nom | Nom du MeetingType. | Chaîne | |
Remarques | Notes pour le participant à la réunion à venir. | Chaîne | |
Description | Description du MeetingType. | Chaîne |
Exemple de réponse :
{
"@odata.context": "https://aa-isdaily.crm.dynamics.com/api/data/v9.0/$metadata#expando/$entity",
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"StartTime": "2022-08-17T12:30:00Z",
"EndTime": "2022-08-17T13:15:00Z",
"Duration": 45,
"IsOnline": false,
"CustomerAdditionalNotes": "Some test notes",
"State": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Value": 3,
"Label": "Scheduled"
},
"Location": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "8bcdf8e8-eda8-ec11-983f-000d3a323337",
"Name": "Woodgrove Anchorage branch",
"Address1": "123 Eastview Lane",
"City": "Anchorage"
},
"Advisors@odata.type": "#Collection(Microsoft.Dynamics.CRM.crmbaseentity)",
"Advisors": [
{
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "f35a29b9-02b1-ec11-9840-000d3a9937ed",
"Name": "IS admin"
}
],
"MeetingType": {
"@odata.type": "#Microsoft.Dynamics.CRM.expando",
"Id": "aaafeaad-8c9f-ec11-b400-0022480b8113",
"Name": "Setting Investment goals",
"Notes": "If this is your first planning meeting, please bring:\n1. 401(k) and other investment plan statements\n2. Mortgage and other debt statements\n3. Pay stubs for you and/or your spouse\n4. Your most recent tax return\n5. Your monthly budget of income and expenses",
"Description": "Creating wealth management goals"
}
}
CancelMeeting
Description : Annule une réunion existante.
Nom du plug-in : CancelMeetingPlugin.cs
Requête HTTP : POST {{url}}/api/data/v9.0/msfsi_CancelMeeting
Demander des paramètres d’entrée (dans le corps) :
Nom du paramètre | Description | Type | Requise | Remarques |
---|---|---|---|---|
Réunion | ID de la réunion à annuler. | Chaîne (Id de rendez-vous) | Oui | L’ID de réunion est extrait de la demande de récupération des rendez-vous existants pour le client. Seules les futures réunions actives peuvent être annulées. Les rendez-vous de préparation et de synthèse liés au rendez-vous client sont également annulés. La valeur de ce paramètre doit être un GUID valide. |
Contact | ID client pour lequel la réunion est planifiée. | Chaîne (ID de contact) | Oui | La valeur de ce paramètre doit être un GUID valide. |
Exemple de requête :
{
"Meeting": "5d98de42-8c9f-ec11-b400-0022480b81c4",
"Contact": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
"Appointment": {
"activityid": "5d98de42-8c9f-ec11-b400-0022480b81c4"
},
"Contact": {
"contactid": "ce43d612-4d9d-ec11-b400-0022480b8d8e"
}
}
Paramètres de sortie de réponse :
Nom du paramètre | Description | Type | Remarques |
---|---|---|---|
IsAppointmentCancelled | Indique si la réunion est annulée ou non. | Entier | Seules les futures réunions actives peuvent être annulées. |
Exemple de réponse :
{
"@odata.context": "https://#####.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_CancelMeetingResponse",
"IsMeetingCancelled": true
}
Commandes de récupération des données
L’ensemble d’API et d’applications fournies pour les rendez-vous intelligents devrait vous fournir suffisamment d’informations. Les commandes d’extraction OData peuvent être utilisées pour récupérer des informations concernant les entités sous-jacentes utilisées pour les API. La récupération des données des entités s’effectue à l’aide de requêtes standard FetchXML Dataverse.
En savoir plus : Utilisez FetchXML pour créer une requête.
La liste recommandée des entités à récupérer est la suivante :
MeetingTopics : Récupère une liste des sujets de réunion disponibles. Un sujet est l’entité par laquelle vous pouvez regrouper les réunions dans différents conteneurs. Il s’agit d’une valeur facultative.
MeetingTypeTopic : Représente un mappage pour identifier le lien entre les types de réunion et un sujet. Un certain type de réunion peut être rendu disponible sous plusieurs rubriques. Si des sujets de réunion sont utilisés, assurez-vous de regrouper les réunions dans leurs conteneurs sujet pertinents.
MeetingTypes : Récupère la liste des types de réunions disponibles.
MeetingType : récupère les détails d’un type de réunion spécifique, tels que :
Méthodes de réunion prises en charge (en ligne, en personne ou les deux)
Description de la réunion
Liste des succursales offrant cette rencontre
Durée de la réunion
Instructions client pour la réunion à sa planification.
Branches : Récupère une liste des succursales prises en charge dans la solution Rendez-vous intelligents. Cette liste doit être référencée par rapport au type de réunion, pour vérifier que seules les succursales prenant en charge le service de réunion spécifique sont mises à la disposition des clients.
Succursale : Récupère les détails d’une succursale spécifique, tels que le nom de la succursale, le code de la succursale et l’adresse.
Rendez-vous : Récupère une liste des rendez-vous pour le client.
Rendez-vous : Récupère les détails d’un rendez-vous spécifique par identifiant de contact. Les détails incluent :
Statut du rendez-vous
Lien vers la réunion en ligne
Notes client supplémentaires ajoutées à la réunion
Emplacement de la réunion
Conseillers obligatoires présents à la réunion
Description
BookableResources : Récupère une liste des ressources disponibles et leurs détails, tels que le nom et le titre.
Voir aussi
Utiliser l’API web Microsoft Dataverse
Récupérer une ligne de table à l’aide de l’API web
Rendez-vous intelligents
Configuration de Rendez-vous intelligents
Présentation de Microsoft Cloud for Financial Services