Node ASE Appointment

Este node permite a interação com a plataforma Appointment Scheduling Enterprise (ASE) para agendar, reagendar, buscar ou cancelar consultas programadas e de demanda espontânea. Na plataforma Studio, você pode usar o node ASE Appointment, da categoria Engageware.

 No vídeo, mostraremos como acessá-lo e os parâmetros para configurá-lo:

 Aqui você pode baixar um exemplo de fluxo com os nodes da categoria Engageware.

Abaixo você encontrará a descrição das propriedades que utilizará no processo e os outputs de cada ação.

Propriedades:  

1. Name (opcional): Nome opcional do node. Aqui você pode alterar o valor padrão.
   
   
2. Credentials (obrigatórias): São as credenciais do serviço Engageware Appointment Schedule Enterprise. É possível armazenar várias credenciais, mas apenas uma pode estar ativa.
   
   Na configuração será solicitado:

   • Instance URL: A URL do ambiente.

   • Username: O usuário para consumo da API (credenciais do usuário de API).

   • Password: A senha do usuário de API.

3.  Action (obrigatória):São os tipos de operação disponíveis.

   • Book: agenda uma consulta em uma data e hora específicas, de acordo com os critérios fornecidos.

     • Client External ID (obrigatória): é o ID do cliente criado previamente. Se foi criado com um ID personalizado (por exemplo, um e-mail), esse dado deve ser fornecido exatamente como foi criado.

     • Start Date Time (obrigatória): indica a data e a hora de início da consulta (para agendar ou reagendar), no formato ISO 8601.

     • Send Notification (opcional): envia um e-mail ao cliente sobre a consulta utilizando templates personalizáveis da plataforma Appointment Scheduling Enterprise (ASE).

     • Criteria Properties: critérios para agendar a consulta, como respostas a perguntas específicas ou alertas por SMS.

       • SMS Phone Number: o número de telefone em formato internacional: +{código_pais}{código_acesso_celular}{número_celular}, por exemplo: +54911XXXXXXXX.

       • SMS Enabled (boolean): ao preencher este campo, habilita o envio de um SMS com a confirmação para o número configurado. Esta função requer ativação por meio de um ticket de Service Request.

   • Enqueue: agenda uma consulta de demanda espontânea (ad hoc), de acordo com os critérios fornecidos.

     • Client External ID (obrigatória): o ID do cliente criado previamente.

     • Send Notification (opcional): envia um e-mail ao cliente sobre a consulta.

     • Criteria Properties: propriedades para agendar a consulta.

       • SMS Phone Number: o número de telefone em formato internacional.

       • SMS Enabled (boolean): habilita o envio de um SMS com a confirmação para o número configurado.

   • Rebook: permite reagendar uma consulta mantendo o número de confirmação.

     • Start Date Time (obrigatória): data e hora no formato ISO 8601.

     • Confirmation Number (obrigatória): código identificador da consulta, obtido ao agendar.

     • Resource Availability Required (obrigatória):

       • True: requer disponibilidade do recurso, e ele também será removido dos disponíveis.

       • False: não requer disponibilidade do recurso, mas ele também será removido dos disponíveis.

     • Send Notification (opcional):

       • Modification: envia por e-mail ao cliente os detalhes modificados de uma consulta específica.

       • Reassign: envia por e-mail ao recurso ou recursos os detalhes da reatribuição de uma consulta específica.

     • Criteria Properties (opcional): propriedades que podem ser modificadas no reagendamento da consulta, como respostas ou alertas por SMS.

   • Get By Client: busca consultas por ID do cliente em um intervalo de datas.

     • Client External ID (obrigatória): o ID do cliente criado anteriormente.

     • Start Date Time (obrigatória): data e hora de início da busca no formato ISO 8601.

     • End Date Time (obrigatória): data e hora de término da busca no formato ISO 8601.

   • Get By Confirmation Number: buscar uma consulta pelo identificador obtido no momento do agendamento.

     • Confirmation Number (obrigatória): o código identificador da consulta, obtido ao agendar.

   • Cancel: cancela uma consulta específica.

     • Confirmation Number (obrigatória): o código identificador da consulta, obtido ao agendar.

     • Send Notification (opcional): habilita o envio dos detalhes do cancelamento da consulta por e-mail ao cliente.

 Outputs:

1. msg.payload.metadata.EW_ASE_BookAppointmentResponse: Retorna o número de confirmação da consulta se realizada com sucesso. Em caso de erro, será retornada a propriedade "error".

2. msg.payload.metadata.EW_ASE_BookAdHocAppointmentResponse: Retorna o número de confirmação da consulta ad hoc se realizada com sucesso. Em caso de erro, será retornada a propriedade "error".

3. msg.payload.metadata.EW_ASE_RebookAppointmentResponse: Retorna o número de confirmação da consulta reagendada se realizada com sucesso. Em caso de erro, será retornada a propriedade "error".

4. msg.payload.metadata.EW_ASE_GetAppointmentByClientExternalIdResponse: Retorna as consultas correspondentes ao cliente em caso de sucesso. Em caso de erro, será retornada a propriedade "error".

5. msg.payload.metadata.EW_ASE_GetAppointmentByConfirmationNumberResponse: Retorna a consulta correspondente ao número de confirmação em caso de sucesso. Em caso de erro, será retornada a propriedade "error".

6. msg.payload.metadata.EW_ASE_CancelAppointmentResponse: Retorna o status 0 se o cancelamento for realizado com sucesso. Em caso de erro, será retornada a propriedade "error".