NotifyJsTelephoneDriver - Global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 9 min. de leitura

    • A API NotifyJsTelethonyDriver fornece métodos que você pode usar para obter informações sobre os recursos do driver de telefonia associado.

    É um ponto de extensão com script que só pode ser usado quando seu objeto é retornado por outro método, como NotifyUtil - getTelephoneDriverFromNotifyNumber(). Você não pode chamar esta API diretamente. O método de chamada associa um driver específico à interface, abstraindo os detalhes da determinação do driver. Cada um dos drivers disponíveis implementa a mesma interface, que é definida pela API NotifyJsTelethonyDriver.

    No exemplo de código a seguir, o método getTelethonyDriverFromNotifyNumber() retorna uma implementação dessa API, com a interface do driver sendo determinada pelo número de telefone passado, como TwilioNotifyJsTelethonyDriver. 
    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        driverName: driver.getName(),
        supportsCall: driver.supportsCall(),
        supportsSMS: driver.supportsSms()
      } 
    }
}

    Para ver quais drivers estão associados ao ponto de extensão NotifyJsTelephoneDriver, navegue até Pontos de extensão do sistema>global.NotifyJsTelephoneDriver. Todas as implementações de driver associadas aparecem na guia Implementações.

    Para obter informações adicionais sobre pontos de extensão com script, consulte Como usar pontos de extensão para estender o ponto de funcionalidade da aplicação.

    Para usar esta API, você deve ativar o plug-in Notify (com.snc.notify). Para ativar implementações de driver específicas, como o Twillo, você deve ativar o plug-in específico.

    NotifyJsTelephoneDriver - call (objeto notifyPhoneNumber, cadeia de caracteres phoneNumber)

    Liga para um número de telefone especificado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    notifyPhoneNumber NotifyPhoneNumber - Global Registro NotifyPhoneNumber que contém o número de telefone do Notify a partir do qual a chamada será feita.

    Tabela: tabela Número de telefone do Notify [notify_number].
    paraNúmeroDeTelefone Cadeia de caracteres Número de telefone para ligar.

    Formato: E.164
    Tabela 2. Retornos
    Tipo Descrição
    Nenhum

    NotifyJsTelethonyDriver – getCapabilities()

    Retorna uma lista dos recursos do driver de telefonia.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Nenhum

    Este exemplo retorna os recursos do driver de telefonia associado.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       capabilities: driver.getCapabilities()
      } 
    }
}

    NotifyJsTelethonyDriver – getMaxSizeForBulkSms(cadeia de caracteres phoneNumber)

    Retorna o número máximo de números de telefone para os quais o driver de telefonia associado ao número de telefone do Notify passado pode enviar uma mensagem SMS de uma só vez.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    phoneNumber Cadeia de caracteres Notifique o número de telefone para verificar o número máximo de números de telefone que o driver associado pode enviar em uma mensagem SMS em massa.
    Tabela 6. Retornos
    Tipo Descrição
    Número Número máximo de números de telefone para os quais uma mensagem SMS pode ser enviada em uma única entrega de SMS em massa.

    Este exemplo retorna o número máximo de números de telefone que podem ser enviados para em uma única mensagem SMS em massa para o driver de telefonia associado.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
       return {
       maxSmsNumbers: driver.getMaxSizeForBulkSMS(notifyNumber)
      }       
    }
}

    NotifyJsTelethonyDriver – getPhoneNumber(cadeia de caracteres phoneNumber)

    Retorna o registro do número de telefone do Notify para o número de telefone especificado.

    Retorna nulo se o número de telefone especificado não for encontrado na tabela Número de telefone do Notify [notify_number].

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    NotifyPhoneNumberAPI Registro do número de telefone do Notify associado ao número de telefone especificado.

    Este exemplo obtém o driver de telefonia e retorna o registro de número de telefone Notify associado para um número de telefone especificado.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       phoneNumberRecord: driver.getPhoneNumber(notifyNumber)
      } 
    }
}

    NotifyJsTelephoneDriver - getPhoneNumbers()

    Retorna uma lista de todos os números de telefone do Notify associados ao driver de telefonia atual.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres Lista separada por vírgulas de todos os números de telefone do Notify associados ao driver atual.

    Este exemplo obtém o driver de telefonia e retorna a lista de números de telefone do Notify associados ao driver de telefonia atual.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       phoneNumbers: driver.getPhoneNumbers()
      } 
    }
}

    NotifyJsTelephoneDriver - isActive()

    Verifica se o driver de telefonia atual está ativo.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o driver de telefonia atual está ativo.

    Valores válidos:
    • verdadeiro: o driver está ativo.
    • falso: o driver está inativo.

    Este exemplo obtém o driver de telefonia e retorna se o driver de telefonia atual está ativo.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        active: driver.isActive()
      } 
    }
}

    NotifyJsTelethonyDriver - kick(GlideRecord ParticipantRecord)

    Remove o chamador especificado da chamada em conferência atual do Notify.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    ParticipantRecord GlideRecord - Global Objeto GlideRecord que contém o registro de Participante do Notify [notify_participant] do solicitante a ser removido da chamada em conferência.
    Tabela 14. Retornos
    Tipo Descrição
    Cadeia de caracteres Retornado somente se houver erro. Mensagem de erro que descreve por que o solicitante não foi removido da chamada.

    Este exemplo silencia o solicitante associado na chamada em conferência atual.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.kick(notifyParticipantGr)
    }
}

    NotifyJsTelephoneDriver - mudo (GlideRecord participanteRecord)

    Silencia o solicitante especificado na chamada em conferência atual do Notify.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    ParticipantRecord GlideRecord - Global Objeto GlideRecord que contém o registro do Participante do Notify [notify_participant] do solicitante para silenciar na chamada em conferência.
    Tabela 16. Retornos
    Tipo Descrição
    Cadeia de caracteres Retornado somente se houver erro. Mensagem de erro que descreve por que o solicitante não foi silenciado.

    Este exemplo silencia o solicitante associado na chamada em conferência atual.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.mute(notifyParticipantGr)
    }
}

    NotifyJsTelephoneDriver - sendAutonomousBulkSms (objeto notifyPhoneNumber, matriz toPhoneNumber, mensagem de cadeia de caracteres, origem de GlideRecord)

    Envia a mensagem SMS especificada para a lista especificada de números de telefone.

    Além disso, você pode, opcionalmente, associar o registro de incidente que causou a geração da mensagem SMS com a mensagem SMS.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    message Cadeia de caracteres Mensagem a ser enviada.
    notifyPhoneNumber NotifyPhoneNumber - Global Registro que contém o número de telefone que está enviando a mensagem SMS em massa.
    Fonte GlideRecord - Global Opcional. GlideRecord de incidente a ser armazenado no campo Origem do registro de mensagem SMS associado na tabela Notify Message [notify message]. Isso vincula o registro de incidente que causou a geração da mensagem SMS a essa mensagem SMS.

    Padrão: nenhum. Se este parâmetro não for passado, essas informações não serão rastreadas.
    paraNúmerosDeTelefone Matriz Lista de números de telefone dos dispositivos que receberão a mensagem SMS.
    Tabela 18. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo mostra como enviar um SMS em massa autônomo.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {

    }
}

    NotifyJsTelephoneDriver - sendSMS (NotifyPhoneNumber notifyPhoneNumber, String toPhoneNumber, String messageBody)

    Envia uma mensagem SMS (Short Message Service) especificada para um número de telefone especificado.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    notifyPhoneNumber NotifyPhoneNumber - Global Registro do número de telefone do Notify que contém o número de telefone que está enviando a mensagem SMS.

    Tabela: Número de telefone do Notify [notify_number]
    paraNúmeroDeTelefone Cadeia de caracteres Número de telefone para o qual a mensagem SMS será enviada.

    Formato: compatível com E.164
    mensagem Cadeia de caracteres Texto a ser enviado na mensagem SMS.
    Tabela 20. Retornos
    Tipo Descrição
    Nenhum

    NotifyJsTelethonyDriver - supportAutonomousBulkSms (cadeia de caracteres phoneNumber)

    Verifica se o número de telefone do Notify especificado é capaz de lidar com mensagens SMS autônomas em massa.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 22. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o número de telefone do Notify especificado é compatível com SMS em massa autônomos.

    Valores válidos:
    • verdadeiro: oferece suporte a SMS em massa autônomos.
    • falso: não é compatível com SMS em massa autônomos.

    Este exemplo obtém o driver de telefonia e retorna se o driver é compatível com SMS em massa autônomo.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsBulkSMS: driver.supportsAutonomousBulkSms(notifyNumber)
      } 
    }
}

    NotifyJsTelethonyDriver - supportCall()

    Verifica se o driver de telefonia atual é capaz de lidar com chamadas telefônicas.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o driver de telefonia atual oferece suporte a chamadas telefônicas.

    Valores válidos:
    • verdadeiro: o driver oferece suporte a chamadas telefônicas.
    • falso: o driver não oferece suporte a chamadas telefônicas.

    Este exemplo obtém o driver de telefonia e retorna se o driver oferece suporte a chamadas telefônicas.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsCall: driver.supportsCall()
      } 
    }
}

    NotifyJsTelethonyDriver - supportCallOverWebRtc()

    Verifica se o número de telefone do Notify especificado é capaz de fazer chamadas para um navegador usando WebRTC (Real-Time Communications).

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 26. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o número de telefone do Notify especificado é compatível com chamadas de navegador usando WebRTC.

    Valores válidos:
    • verdadeiro: oferece suporte a WebRTC.
    • falso: não é compatível com WebRTC.

    Este exemplo obtém o driver de telefonia e retorna se o driver é compatível com chamadas de navegador usando WebRTC.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsWebRTC: driver.supportsCallOverWebRtc(notifyNumber)
      } 
    }
}

    NotifyJsTelethonyDriver - suporta SMS ()

    Verifica se o driver de telefonia atual é capaz de lidar com mensagens SMS (Short Message Service).

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 28. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o driver de telefonia atual é compatível com SMS.

    Valores válidos:
    • verdadeiro: o driver é compatível com SMS.
    • falso: o driver não é compatível com SMS.

    Este exemplo obtém o driver de telefonia e retorna se o driver é compatível com SMS.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsSMS: driver.supportsSMS()
      } 
    }
}

    NotifyJsTelethonyDriver - unmute (GlideRecord participanteRecord)

    Reativa o mudo do solicitante especificado na chamada em conferência atual do Notify.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    ParticipantRecord GlideRecord - Global Objeto GlideRecord que contém o registro do Participante do Notify [notify_participant] do solicitante para silenciar na chamada em conferência.
    Tabela 30. Retornos
    Tipo Descrição
    Cadeia de caracteres Retornado somente se houver erro. Mensagem de erro que descreve por que o solicitante não foi silenciado.

    Este exemplo silencia o solicitante associado na chamada em conferência atual.

    getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.unmute(notifyParticipantGr)
    }
}