Criar virtualAppointment (preterido)

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Cuidado

O recurso virtualAppointment e os métodos de suporte são preteridos e deixarão de retornar dados em 30 de junho de 2023. Recomendamos que você atualize aplicativos existentes que usam essa API para usar a nova função Obter link de junção .

Crie um novo objeto virtualAppointment .

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) OnlineMeetings.ReadWrite Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Observação

A consulta virtual fará a transição de permissões de reunião online para permissões de compromisso virtual mais específicas durante o período de visualização. Isso dará aos desenvolvedores um controle mais granular sobre as permissões de compromisso virtual. Forneceremos detalhes adicionais sobre quando as permissões de reunião online não terão mais suporte antes do término do período de visualização.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto virtualAppointment .

Você pode especificar as propriedades a seguir ao criar um ponto virtual.

Propriedade Tipo Descrição
appointmentClients coleção virtualAppointmentUser As informações do cliente para o compromisso virtual, incluindo nome, email e número de telefone SMS. Opcional.
appointmentClientJoinWebUrl Cadeia de caracteres A URL da Web de junção do compromisso virtual para clientes com sala de espera e ingresso no navegador. Opcional.
externalAppointmentId Cadeia de caracteres O identificador do compromisso do sistema de agendamento, associado ao compromisso virtual atual. Opcional.
externalAppointmentUrl Cadeia de caracteres A URL do recurso de compromisso do sistema de agendamento, associada ao compromisso virtual atual. Opcional.
settings virtualAppointmentSettings As configurações associadas ao recurso de compromisso virtual. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um 201 Created código de resposta e um objeto virtualAppointment no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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