Referencia de API de Citas inteligentes
Use el conjunto de API de Citas inteligentes para buscar asesores relevantes y para programar y administrar reuniones. La API se basa en la API personalizada de Power Platform.
Nota
Todos los comandos de esta API usan mensajes POST.
Comandos de disponibilidad y programación
| Comando | Descripción |
|---|---|
| GetSchedulingProperties | Recupera toda la información relacionada con los tipos de reunión del entorno de Dataverse. |
| GetAvailableMeetingTimeSlots | Obtiene los intervalos de tiempo disponibles del asesor pertinente en función de la ubicación solicitada, el tema, las habilidades y el intervalo de fechas. |
| CreateMeeting | Habilita la programación de una reunión con los recursos del asesor solicitados. |
| GetMeeting | Busca una reunión programada para un contacto. |
| CancelMeeting | Cancela una reunión existente. |
GetSchedulingProperties
Descripción: recupera toda la información relacionada con los tipos de reunión del entorno de Dataverse.
Nombre del complemento: GetSchedulingPropertiesPlugin.cs
Solicitud HTTP: POST {{url}}/api/data/v9.0/msfsi_GetSchedulingProperties
Parámetros de entrada de solicitud (en el cuerpo): vacío
Parámetros de salida de respuesta:
| Nombre de parámetro | Descripción | Tipo | Notas |
|---|---|---|---|
| Ubicaciones | Una matriz de objetos de ubicación. Estas son ubicaciones que residen en los objetos MeetingType. | Matriz de objetos | Los objetos de ubicación se rellenan cuando las reuniones son solo en el lugar. |
| Temas | Una matriz de objetos de tema. Estos son temas que residen en los objetos MeetingType. | Matriz de objetos | |
| Tipos de reunión | Una matriz de MeetingTypes | Matriz de objetos | |
| Objeto de ubicación | |||
| Id | El id. de la ubicación (entidad OrganizationalUnit). | Cadena | |
| Nombre | Nombre de la ubicación (entidad de rama). | Cadena | |
| Address1 | La primera línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Address2 | La segunda línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Ciudad | La ciudad de la ubicación (entidad de rama). | Cadena | |
| StateOrProvince | El estado o la provincia de la ubicación (entidad de rama). | Cadena | |
| País | El país de la ubicación (entidad de rama). | Cadena | |
| PostalCode | El código postal de la ubicación (entidad de rama). | Cadena | |
| Teléfono | El número de teléfono de la ubicación (entidad de rama). | Cadena | |
| Objeto de tema | |||
| Id | El id. del tema. | Cadena | |
| Nombre | El nombre del tema. | Cadena | |
| Descripción | Descripción del tema. | Cadena | |
| Objeto MeetingType | |||
| Id | El id. del MeetingType. | Cadena | |
| Nombre | El nombre del MeetingType. | Cadena | |
| Descripción | Una descripción del MeetingType. | Cadena | |
| Duración | La duración de la reunión descrita por MeetingType. | Int | |
| Notas | Las notas para que las siga el asistente a la reunión. | Cadena | |
| Temas | Una matriz de id. para los temas conectados a este MeetingType. | Cadena[] | Una lista detallada completa está disponible en la matriz Temas. |
| Ubicaciones | Una matriz de id. para las ubicaciones conectadas a este MeetingType. | Cadena[] | Los objetos de ubicación se rellenan cuando las reuniones son solo en el lugar. Se puede encontrar una lista detallada completa en la matriz Ubicaciones. |
| Canal | El canal establecido para este MeetingType. | Conjunto de opciones |
Cada conjunto de opciones está representado por un objeto que contiene el valor y la etiqueta. |
| DefaultMethod | El método predeterminado para este MeetingType. | Conjunto de opciones |
Cada conjunto de opciones está representado por un objeto que contiene el valor y la etiqueta. |
Nota
No se devuelven todos los parámetros:
Las reuniones que son solo en la ubicación y no tienen ramas no se muestran.
Las reuniones sin campos obligatorios no se muestran.
Las entidades en estado inactivo no se muestran.
Es posible que los siguientes parámetros no devuelvan valores:
Los parámetros Channel y DefaultMethod no se devuelven si son NULL.
Si no hay ubicaciones conectadas a MeetingType, no tiene la matriz Ubicaciones. Esto es posible solo si el canal tiene un valor que no sea En la ubicación.
Es posible que el parámetro Temas no se muestre si no hay temas conectados al MeetingType (a través de la entidad Conexión).
Los parámetros Id., Nombre, Descripción y Duración siempre forman parte de cada elemento de la respuesta.
Tema y ubicación son matrices que contienen entidades. Id. es el único parámetro obligatorio para los objetos Tema y Ubicación.
Ejemplo de respuesta:
{
"@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
Descripción: obtiene los intervalos de tiempo disponibles del asesor pertinente en función de la ubicación solicitada, el tema, las habilidades y el intervalo de fechas.
Nombre del complemento: GetTimeSlotsPlugin.cs
Solicitud HTTP: POST {{url}}/api/data/v9.0/msfsi_GetAvailableMeetingTimeSlots
Parámetros de entrada de solicitud (en el cuerpo):
| Nombre de parámetro | Descripción | Tipo | Obligatorio | Notas |
|---|---|---|---|---|
| MeetingType | El id. del MeetingType que el usuario desea buscar. | String (id. de msfsi_meetingtype) | Sí | El valor de este parámetro debe ser un valor GUID válido |
| StartDateTime | La fecha y hora de inicio para buscar la disponibilidad. | Fecha y hora | Sí | La hora proporcionada debe estar en UTC. |
| EndDateTime | La fecha y hora de finalización para buscar la disponibilidad. | Fecha y hora | Sí | La hora proporcionada debe estar en UTC. |
| RequestedMeetingLocation | El id. denla ubicación (OrganizationalUnit) que el usuario desea buscar. | Cadena (msdyn_organizationalunit Id) | No | Obligatorio cuando IsOnlineMeeting se establece en falso. El valor de este parámetro debe ser un valor GUID válido |
| IsOnlineMeeting | Indica si la cita es o no una reunión en línea. | Booleana | Sí | |
| SkillFilter | Matriz de cadenas que contiene todos los id. de aptitudes que se incluirán en una solicitud de búsqueda de disponibilidad. | String[] (id. de característica) | No | Agregar filtros que ya están configurados como predeterminados en la plantilla del grupo de recursos generará un error. El valor de este parámetro debe ser un valor GUID válido |
| Paginación | La cadena de búsqueda. Si no se proporciona ninguna, obtiene la primera página; de lo contrario, devuelve la página correspondiente. | Cadena | No |
Ejemplo de solicitud:
{
"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": ""
}
Parámetros de salida de respuesta:
| Nombre de parámetro | Descripción | Tipo | Notas |
|---|---|---|---|
| Intervalos de tiempo | Una matriz de objetos de intervalos de tiempo, que representan los intervalos de tiempo disponibles devueltos para los asesores solicitados, el tipo de reunión y la ubicación. | Matriz de objetos Timeslots | |
| Siguiente paginación | La cadena de búsqueda utilizada para la búsqueda. Si no hay resultados disponibles, este valor es nulo. | Cadena | Para obtener más información, vaya a Documentación de URS. |
| Objeto de intervalos de tiempo | |||
| StartTime | La fecha y hora de inicio especificadas en la solicitud de búsqueda. | Fecha y hora | La hora se devuelve en UTC. |
| EndTime | La fecha y hora de finalización especificadas en la solicitud de búsqueda. | Fecha y hora | La hora se devuelve en UTC. |
| Asesores | Lista de los objetos que representan los asesores. Cada objeto tiene un id. y un nombre de asesor. | Matriz de objetos | Estos id. se utilizan al crear la reunión mediante CreateMeeting y obtener la información de recursos para su visualización. Solo se devuelve un conjunto de asesores para cada intervalo de tiempo. Si el requisito para un tipo de reunión es para un solo asesor en la reunión, cada intervalo de tiempo tendrá un solo valor. Si hay más de un asesor disponible, el motor de programación prioriza a los asesores según el contexto y la capacidad. |
Ejemplo de respuesta: algunos de los intervalos de tiempo devueltos se eliminaron por motivos de espacio.
Nota
NextPaging se agrega cuando se devuelven más de 20 intervalos de tiempo.
{
"@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
Descripción: habilita la programación de una reunión con los recursos del asesor solicitados.
Nombre del complemento: CreateMeetingPlugin.cs
Solicitud HTTP: POST {{url}}/api/data/v9.0/msfsi_CreateMeeting
Parámetros de entrada de solicitud (en el cuerpo):
| Nombre de parámetro | Descripción | Tipo | Obligatorio | Notas |
|---|---|---|---|---|
| MeetingType | El id. del MeetingType seleccionado. | Cadena (msfsi_meetingtype) | Sí | El valor de este parámetro debe ser un valor GUID válido |
| StartDateTime | La fecha y la hora de inicio de la reunión. | Fecha y hora | Sí | Las citas de preparación y resumen se agregan al calendario del asesor según el tipo de reunión y la configuración del administrador. |
| Contacto | El id. de contacto que representa al cliente que asiste a la reunión. | String (id. de contacto) | Sí | El valor de este parámetro debe ser un valor GUID válido |
| IsOnlineMeeting | Indica si la cita es o no una reunión en línea. | Booleana | Sí | Si este valor es False, es obligatorio proporcionar un lugar de reunión. |
| RequestedMeetingLocation | El id. de la ubicación (OrganizationalUnit) donde se llevará a cabo la reunión. | String (Id. de OrganizationalUnit(OU)) | No | En el caso de una reunión en línea, este campo no es obligatorio. En el caso de una implementación de reunión en línea donde los asesores en línea se encuentran en una OrganizationalUnit(OU) específica, se requiere una referencia de OU dedicada. |
| RequestedAdvisors | Una matriz de los id. de asesor necesarios (id. de recursos reservables). Estos id. se toman de la matriz Asesores proporcionada en la respuesta GetAvailableMeetingTimeSlots. | EntityCollection ((Recursos) | Sí | Para que la reserva sea correcta, los recursos deben tener usuarios del sistema asociados a ellos. Estos usuarios aparecen en el campo Obligatorio de la cita. Las cadenas de dentro de la matriz deben ser GUID válidos. |
| CustomerAdditionalNotes | Notas que los clientes quieren compartir sobre la próxima reunión. | Cadena | No | Este parámetro aparece en las comunicaciones con el cliente y la descripción de la cita en la aplicación CRM. |
Ejemplo de solicitud:
{
"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"
}
Parámetros de salida de respuesta:
| Nombre de parámetro | Descripción | Tipo | Notas |
|---|---|---|---|
| Id | Un id. que representa la reunión programada. | Cadena | Representa un GUID. |
| StartTime | La fecha y la hora de inicio de la reunión. | Fecha y hora | La hora se facilita en UTC. |
| EndTime | La fecha y la hora de final de la reunión. | Fecha y hora | La hora se facilita en UTC. |
| Duración | La duración de la reunión programada en minutos. | Int | |
| IsOnline | Indica si la cita es o no una reunión en línea. | Booleana | |
| CustomerAdditionalNotes | Notas que los clientes quieren compartir sobre la reunión programada. | Cadena | |
| MeetingJoinUrl | Vínculo para unirse a la reunión programada. | Cadena | |
| Valor | Estado de la reunión programada. | Conjunto de opciones (objeto) |
Cada conjunto de opciones está representado por un objeto que contiene el valor y la etiqueta. |
| Ubicación | Un objeto de la ubicación de la reunión para una cita en la ubicación. | Objecto | Este parámetro no está vacío solo para las reuniones que se realizan en la ubicación. |
| Asesores | Una lista de objetos que representan a los asesores en la reunión programada. | Matriz de objetos | |
| MeetingType | Un objeto que representa el MeetingType. | Objecto | |
| Objeto de ubicación | |||
| Id | El id. de la ubicación (entidad OrganizationalUnit). | Cadena | Representa un GUID. |
| Nombre | Nombre de la ubicación (entidad de rama). | Cadena | |
| Address1 | La primera línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Address2 | La primera línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Ciudad | La ciudad de la ubicación (entidad de rama). | Cadena | |
| StateOrProvince | El estado o la provincia de la ubicación (entidad de rama). | Cadena | |
| País | El país de la ubicación (entidad de rama). | Cadena | |
| PostalCode | El código postal de la ubicación (entidad de rama). | Cadena | |
| Teléfono | El número de teléfono de la ubicación (entidad de rama). | Cadena | |
| Objeto de asesor | |||
| Id | El id. del asesor (entidad de recurso reservable). | Cadena | Representa un GUID. |
| Nombre | El nombre del asesor. | Cadena | |
| Objeto MeetingType | |||
| Id | El id. del MeetingType. | Cadena | |
| Nombre | El nombre del MeetingType. | Cadena | |
| Notas | Las notas para que las siga el asistente a la reunión. | Cadena | |
| Descripción | La descripción del MeetingType. | Cadena |
Ejemplo de respuesta:
{
"@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
Descripción: busca una reunión programada para un contacto.
Nombre del complemento: GetMeetingPlugin.cs
Solicitud HTTP: POST {{url}}/api/data/v9.0/msfsi_GetMeeting
Parámetros de entrada de solicitud (en el cuerpo):
| Nombre de parámetro | Descripción | Tipo | Obligatorio | Notas |
|---|---|---|---|---|
| Reunión | El id. de la reunión. | Cadena | Sí | El id. de la reunión se toma de la respuesta CreateMeeting. El valor de este parámetro debe ser un valor GUID válido |
| Contacto | El id. del cliente para el que está programada la reunión. | Cadena | Sí | El valor de este parámetro debe ser un valor GUID válido |
Ejemplo de solicitud:
{
"Meeting": "4d6d4b05-4e0f-ed11-82e5-00224822509a",
"Contact": "8788facf-828e-4333-8405-b825b0f29ea0"
}
Parámetros de salida de respuesta:
| Nombre de parámetro | Descripción | Tipo | Notas |
|---|---|---|---|
| Id | Un id. que representa la reunión programada. | Cadena | Representa un GUID. |
| StartTime | La fecha y la hora de inicio de la reunión. | Fecha y hora | La hora se facilita en UTC. |
| EndTime | La fecha y la hora de final de la reunión. | Fecha y hora | La hora se facilita en UTC. |
| Duración | La duración de la reunión programada en minutos. | Int | |
| IsOnline | Indica si la cita es o no una reunión en línea. | Booleana | |
| CustomerAdditionalNotes | Notas que los clientes quieren compartir sobre la reunión programada. | Cadena | |
| MeetingJoinUrl | Vínculo para unirse a la reunión programada. | Cadena | |
| Valor | Estado de la reunión programada. | Conjunto de opciones (objeto) |
Cada conjunto de opciones está representado por un objeto que contiene el valor y la etiqueta. |
| Ubicación | Un objeto de la ubicación de la reunión para una cita en la ubicación. | Objecto | Este parámetro no está vacío solo para las reuniones que se realizan en la ubicación. |
| Asesores | Una lista de objetos que representan a los asesores en la reunión programada. | Matriz de objetos | |
| MeetingType | Un objeto que representa el MeetingType. | Objecto | |
| Objeto de ubicación | |||
| Id | El id. de la ubicación (entidad OrganizationalUnit). | Cadena | Representa un GUID. |
| Nombre | Nombre de la ubicación (entidad de rama). | Cadena | |
| Address1 | La primera línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Address2 | La primera línea de la dirección de la ubicación (entidad de rama). | Cadena | |
| Ciudad | La ciudad de la ubicación (entidad de rama). | Cadena | |
| StateOrProvince | El estado o la provincia de la ubicación (entidad de rama). | Cadena | |
| País | El país de la ubicación (entidad de rama). | Cadena | |
| PostalCode | El código postal de la ubicación (entidad de rama). | Cadena | |
| Teléfono | El número de teléfono de la ubicación (entidad de rama). | Cadena | |
| Objeto de asesor | |||
| Id | El id. del asesor (entidad de recurso reservable). | Cadena | Representa un GUID. |
| Nombre | El nombre del asesor. | Cadena | |
| Objeto MeetingType | |||
| Id | El id. del MeetingType. | Cadena | |
| Nombre | El nombre del MeetingType. | Cadena | |
| Notas | Las notas para que las siga el asistente a la reunión. | Cadena | |
| Descripción | La descripción del MeetingType. | Cadena |
Ejemplo de respuesta:
{
"@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
Descripción: cancela una reunión existente.
Nombre del complemento: CancelMeetingPlugin.cs
Solicitud HTTP: POST {{url}}/api/data/v9.0/msfsi_CancelMeeting
Parámetros de entrada de solicitud (en el cuerpo):
| Nombre de parámetro | Descripción | Tipo | Obligatorio | Notas |
|---|---|---|---|---|
| Reunión | El id. de la reunión a cancelar. | String (id. de cita) | Sí | El Id. de la reunión se toma de la solicitud fetch de citas existentes para el cliente. Solo se pueden cancelar futuras reuniones activas. También se cancelan las citas de preparación y resumen vinculadas a la reunión con el cliente. El valor de este parámetro debe ser un valor GUID válido |
| Contacto | El id. del cliente para el que está programada la reunión. | String (id. de contacto) | Sí | El valor de este parámetro debe ser un valor GUID válido |
Ejemplo de solicitud:
{
"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"
}
}
Parámetros de salida de respuesta:
| Nombre de parámetro | Descripción | Tipo | Notas |
|---|---|---|---|
| IsAppointmentCancelled | Indica si la reunión se ha cancelado o no. | Booleana | Solo se pueden cancelar futuras reuniones activas. |
Ejemplo de respuesta:
{
"@odata.context": "https://#####.crm.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msfsi_CancelMeetingResponse",
"IsMeetingCancelled": true
}
Comandos de datos Fetch
El conjunto de API y aplicaciones entregadas para Citas inteligentes debería brindarle suficiente información. Los comandos de obtención de OData se pueden utilizar para recuperar información sobre las entidades subyacentes utilizadas para las API. La obtención de datos de entidades se realiza mediante consultas FetchXML estándar sobre Dataverse.
Más información: Usar FetchXML para construir una consulta.
A continuación se muestra la lista recomendada de entidades para obtener:
MeetingTopics: recupera una lista de los temas de reunión disponibles. Un tema es la entidad en base a la cual puede agrupar las reuniones en diferentes contenedores. Se trata de un valor opcional.
MeetingTypeTopic: representa una asignación para identificar el vínculo entre los tipos de reunión y un tema. Un determinado tipo de reunión puede estar disponible en varios temas. Si se utilizan temas de reunión, asegúrese de agrupar las reuniones en sus contenedores de tema pertinentes.
MeetingTypes: recupera la lista de los tipos de reunión disponibles.
MeetingType: recupera los detalles de un tipo de reunión específico, como:
Métodos de reunión admitidos (en línea, en persona o ambos)
Descripción de la reunión
Lista de sucursales que ofrece esta reunión
Duración de la reunión
Instrucciones del cliente para la reunión al programarla.
Sucursales: recupera una lista de sucursales admitidas en la solución de Citas inteligentes. Esta lista debe tener referencias cruzadas con el tipo de reunión para verificar que solo aquellas sucursales que admitan el servicio de reunión específico estén disponibles para que los clientes las seleccionen.
Sucursal: recupera los detalles de una sucursal específica, como el nombre de la sucursal, el código de la sucursal y la dirección.
Citas: recupera una lista de citas para el cliente.
Cita: recupera los detalles de una cita específica por id. de contacto. Los detalles incluyen:
Estado de la cita
Vínculo a la reunión en línea
Notas de clientes adicionales agregadas a la reunión
Ubicación de la reunión
Consejeros requeridos que asisten a la reunión
Descripción
BookableResources: recupera una lista de los recursos disponibles y sus detalles, como el nombre y el título.