Creación de virtualAppointment (en desuso)

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Precaución

El recurso virtualAppointment y los métodos auxiliares están en desuso y dejarán de devolver datos el 30 de junio de 2023. Se recomienda actualizar las aplicaciones existentes que usan esta API para usar la nueva función Obtener vínculo de combinación .

Cree un nuevo objeto virtualAppointment .

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) OnlineMeetings.ReadWrite No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación No admitida. No admitida.

Nota:

La cita virtual pasará de permisos de reunión en línea a permisos de cita virtual más específicos durante el período de vista previa. Esto proporcionará a los desarrolladores un control más pormenorizado sobre los permisos de cita virtual. Proporcionaremos detalles adicionales sobre cuándo ya no se admitirán los permisos de reunión en línea antes de que finalice el período de vista previa.

Solicitud HTTP

PUT /me/onlineMeetings/{onlineMeetingId}/virtualAppointment
PUT /users/{userId}/onlineMeetings/{onlineMeetingId}/virtualAppointment

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto virtualAppointment .

Puede especificar las siguientes propiedades al crear una instancia de virtualAppointment.

Propiedad Tipo Descripción
appointmentClients Colección virtualAppointmentUser La información de cliente de la cita virtual, incluido el nombre, el correo electrónico y el número de teléfono SMS. Opcional.
appointmentClientJoinWebUrl Cadena Dirección URL web de unión de la cita virtual para los clientes con sala de espera y unión al explorador. Opcional.
externalAppointmentId Cadena Identificador de la cita del sistema de programación, asociado a la cita virtual actual. Opcional.
externalAppointmentUrl Cadena Dirección URL del recurso de cita del sistema de programación, asociada a la cita virtual actual. Opcional.
configuración virtualAppointmentSettings Configuración asociada al recurso de cita virtual. Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto virtualAppointment en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PUT https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi/virtualAppointment
Content-Type: application/json
ETag: W/"ZfYdV7Meckeip07P//nwjAAADyI7NQ=="
Content-length: 379

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA="
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "id": "0c7fda79-ff00-f57f-37e3-28183b6d09b5",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA=",
    "appointmentClientJoinWebUrl": "https://visit.teams.microsoft.com/webrtc-svc/api/route?tid=a796be92-&convId=19:meeting_=True"
}