NotifyOnTaskClient - Cliente

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 17 min. de leitura

    • . NotifyOnTaskClient A API fornece métodos para enviar mensagens SMS ou iniciar/gerenciar uma chamada em conferência para vários provedores de serviços de telefonia, como Zoom e. Webex.

    Qualquer IU pode consumir o. NotifyOnTaskClient Incluindo explicitamente o script de IU NotifyOnTaskClient.

    Usando o. NotifyOnTaskClient API Você pode:

    • Como iniciar uma chamada em conferência
    • Encerrar uma chamada de conferência
    • Adicionar participantes
    • Execute ações que estão disponíveis por meio do driver de telefonia, como:
      • ativar/desativar o mudo dos participantes
      • remover participantes de uma chamada em conferência
      • adicione participantes a uma chamada em conferência
      • iniciar uma chamada em conferência
      • encerrar uma chamada em conferência

    O plug-in Notify (com.snc.notify) requer uma assinatura separada. Para obter informações adicionais sobre como ativar o plug-in Notify, consulte Ativar Notify .

    NotifyOnTaskClient - addParticidents(Dados do objeto)

    Adiciona os participantes especificados a uma chamada em conferência especificada.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    dados Objeto Objeto que descreve a chamada em conferência.
    AddToWorkNotes Booliano Sinalizador que indica se informações sobre os participantes que foram incluídos na chamada em conferência devem ser adicionadas no campo Anotações de trabalho do registro associado.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro no qual as anotações de trabalho serão adicionadas.

    Padrão: falso
    Data.confId Cadeia de caracteres Sys_id da chamada em conferência. Chamada em conferência do Notify [notify_conference_call]
    data.items Matriz Informações para cada participante incluir na chamada em conferência. 
    "items": [
  "email": "String",
  "id": "String",
  "notifyParticipantId": "String",
  "phoneNumber": "String"
]
    data.items.email Cadeia de caracteres Endereço de e-mail do participante.
    data.items.id Cadeia de caracteres Sys_id do usuário.

    Tabela: Usuário [sys_User]
    data.items.notifyParticipantId Cadeia de caracteres Sys_id do participante.

    Tabela: Participante do Notify [notify_participant]
    data.items.phoneNumber Cadeia de caracteres Número de telefone do participante. Se este valor for passado em conjunto com idou notifyParticipantIdeste valor substitui os números de telefone no registro de usuário/participante e é usado para fazer a chamada.
    data.message Cadeia de caracteres Mensagem que é lida em voz alta quando um usuário atende à chamada, como "O incidente P1 foi criado, faça login na instância".
    data.serviceProvider Cadeia de caracteres Obrigatório. Nome do provedor de serviço de conferência, como Zoom ou Webex.
    SYSID.data Cadeia de caracteres Sys_id do registro de origem a ser associado à chamada em conferência.

    Por exemplo, se uma chamada em conferência for realizada para discutir um incidente ou problema específico, coloque o sys_id do incidente ou registro de problema neste valor. Este sys_id é armazenado na coluna Origem da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado posteriormente.

    Este parâmetro é usado em conjunto com data.Table, data.addToWorkNotese allowMulticonferenceparâmetros.

    Você deve configurar este valor quando a chamada em conferência for criada inicialmente por meio de uma ação "iniciar". Se necessário, você também pode definir esse valor por meio deste método.
    data.table Cadeia de caracteres Tabela que contém o registro de origem a ser associado à chamada em conferência. Um registro de origem pode ser qualquer registro, como um "incidente" ou "problema", que é o tópico de discussão na chamada em conferência.

    Este nome de tabela é armazenado na coluna Tabela da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado.

    Este parâmetro é usado em conjunto com data.sysId, data.addToWorkNotese allowMulticonferenceparâmetros.

    Você deve configurar este valor quando a chamada em conferência for criada inicialmente por meio de uma ação "iniciar". Se necessário, você também pode definir esse valor por meio deste método.
    Tabela 2. Retornos
    Tipo Descrição
    Objeto Resultados da ação da conferência.

    <action>.status Status da ação de conferência.

    • Tipo de dados: Booliano
    • Valores possíveis:
      • Verdadeiro: Ação de conferência bem-sucedida
      • Falso: Falha na ação de conferência

    Mensagens.successMessages <action> : Se status é verdadeiro, mensagem(ns) de sucesso, caso contrário vazia.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.warnMessages <action> : Se status é falso, todas as mensagens de aviso lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.errorMessages <action> : Se status é falso, todas as mensagens de erro lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    O exemplo de código a seguir mostra como chamar este método.

    function addToConferenceCall() {
    var data = NotifyOnTaskClient.getNotifyActionTemplate();
    data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
    data.confId = 'Active conference sysId';
    data.items.push({ id: 'userSysId' });
    data.items.push({ phoneNumber: '+917799555331' });
    data.items.push({ email: 'yln99518@gmail.com' });

    NotifyOnTaskClient.addParticipants(data).then(function (result) {
        var joinActionResult = result[0];
        if(joinActionResult.status) {
            joinActionResult.successMessages.forEach(function(msg) {
                console.log(msg);
            });
            return;
        }

        joinActionResult.warnMessages.forEach(function(msg) {
            console.warn(msg);
        });
        joinActionResult.errorMessages.forEach(function(msg) {
            console.error(msg);
        });
    }, function (errMsg) {
        console.log(errMsg);
    });
}

    NotifyOnTaskClient - doConferenceAction(ação de cadeia de caracteres, dados do objeto)

    Executa a ação de chamada em conferência especificada, como iniciar/encerrar uma chamada em conferência ou ingressar, remover, silenciar ou ativar o mudo de participantes de uma chamada em conferência.

    Você pode iniciar uma nova chamada em conferência e adicionar participantes em uma única chamada a este método ou chamar o método várias vezes para iniciar a chamada e gerenciar os participantes separadamente. Por meio do objeto de dados Passado, você pode configurar o método para:
    • Salve ponteiros no registro de chamada em conferência para o registro específico (registro de origem), como um incidente ou problema, que é o tópico de discussão da chamada em conferência.
    • Permitir/proibir várias chamadas em conferência para um registro de origem.
    • Registre automaticamente os participantes que estavam na chamada em conferência no Anotações de trabalho campo do registro de origem.
    • Faça com que uma mensagem seja lida em voz alta quando um participante atender a uma chamada de saída da conferência.
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    ação Cadeia de caracteres Define a ação de chamada em conferência a ser executada.
    Estas são as ações de chamada em conferência disponíveis:
    • Encerrar: Encerra a chamada em conferência identificada em data.confId.
    • Ingressar: Adiciona o participante especificado em data.itemsmatriz para a chamada em conferência identificada em data.confId.
    • Chutar: Remove o participante especificado em data.itemsmatriz da chamada em conferência identificada em data.confId.
    • MultiJoin: Adiciona os participantes especificados em data.itemsmatriz para a chamada em conferência identificada em data.confId
    • MultiKick: Remove os participantes especificados em data.itemsmatriz da chamada em conferência identificada em data.confId.
    • MultiMudo: Silencia os participantes especificados em data.itemsmatriz na chamada em conferência identificada em data.confId.
    • MultiUnmudo: Desativa o mudo dos participantes especificados em data.itemsmatriz da chamada em conferência identificada em data.confId.
    • Mudo: Silencia o participante especificado em data.itemsmatriz na chamada em conferência identificada em data.confId.
    • SelfJoin: Adiciona o usuário conectado no momento à chamada em conferência (sem entrada em data.itemsnecessário.)
    • Iniciar: Inicia a chamada em conferência identificada em data.confId.
    • Ativar mudo: Ativa o participante especificado em data.itemsmatriz da chamada em conferência identificada em data.confId.
    dados Objeto Objeto que descreve a chamada em conferência.
    AddToWorkNotes Booliano Sinalizador que indica se informações sobre os participantes que foram incluídos na chamada em conferência devem ser adicionadas no campo Anotações de trabalho do registro associado.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro no qual as anotações de trabalho serão adicionadas.

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • ingressar
    • MultiJoin
    • SelfJoin
    • início
    AllowMulticonference Booliano Sinalizador que indica se várias chamadas em conferência devem ser permitidas para um registro específico de uma só vez.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro que tem permissão para ter várias chamadas em conferência.

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • início
    Data.confId Cadeia de caracteres Sys_id da chamada em conferência.

    Chamada em conferência do Notify [notify_conference_call]

    Ações para as quais este parâmetro é necessário:

    • término
    • ingressar
    • MultiJoin
    • SelfJoin
    Nota:
    As ações do participante, como silenciar, desativar mudo e desligar, não exigem que este parâmetro seja definido, pois o método obtém essas informações da tabela Participante da chamada em conferência do Notify [notify_participant].
    data.fromNumber Cadeia de caracteres Número do provedor de serviço para chamar para a chamada em conferência.

    Localize este valor na coluna Número ou Número de telefone da tabela Número de telefone do Notify [notify_number].

    Ações para as quais este parâmetro é necessário:

    • início
    Nova Conferência Booliano Sinalizador que indica se esta é uma chamada em conferência nova ou existente.

    Valores válidos:

    • Verdadeiro: Nova chamada em conferência
    • Falso: Chamada em conferência existente

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • início
    data.message Cadeia de caracteres Mensagem que é lida em voz alta quando um usuário atende à chamada, como "O incidente P1 foi criado, faça login na instância".

    Ações para as quais este parâmetro é válido:

    • ingressar
    • MultiJoin
    • início
    data.items Matriz Informações para cada participante incluir na chamada em conferência.

    Valores de matriz válidos:

    • Sys_id do usuário; localizado na tabela Usuário [sys_User].

      Ações válidas: Ingressar, multiJoin, iniciar

    • NotifyParticidentId: Sys ID do participante do Notify; localizado na tabela Participante do Notify [notify_participant].

      Ações válidas: Ingressar, kick, multiJoin, mudo, iniciar, desativar mudo

    • PhonNumber: Número de telefone do participante. Se este valor for passado em conjunto com idou notifyParticipantIdeste valor substitui os números de telefone no registro de usuário/participante e é usado para fazer a chamada.

      Ações válidas: Ingressar, multiJoin, iniciar

    • E-mail: Endereço de e-mail do participante.

      Ações válidas: Ingressar, multiJoin, iniciar
    data.serviceProvider Cadeia de caracteres Obrigatório. Nome do provedor de serviço de conferência, como Zoom ou Webex.

    Ações para as quais este parâmetro é necessário:

    • tudo
    SYSID.data Cadeia de caracteres Sys_id do registro de origem a ser associado à chamada em conferência.

    Por exemplo, se uma chamada em conferência for realizada para discutir um incidente ou problema específico, coloque o sys_id do incidente ou registro de problema neste valor. Este sys_id é armazenado na coluna Origem da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado posteriormente.

    Este parâmetro é usado em conjunto com data.Table, data.addToWorkNotese allowMulticonferenceparâmetros.

    Ações para as quais este parâmetro é válido:

    • início
    data.table Cadeia de caracteres Tabela que contém o registro de origem a ser associado à chamada em conferência. Um registro de origem pode ser qualquer registro, como um "incidente" ou "problema", que é o tópico de discussão na chamada em conferência.

    Este nome de tabela é armazenado na coluna Tabela da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado.

    Este parâmetro é usado em conjunto com data.sysId, data.addToWorkNotese allowMulticonferenceparâmetros.

    Ações para as quais este parâmetro é válido:

    • início
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Resultados da ação da conferência.

    <action>.status Status da ação de conferência.

    • Tipo de dados: Booliano
    • Valores possíveis:
      • Verdadeiro: Ação de conferência bem-sucedida
      • Falso: Falha na ação de conferência

    Mensagens.successMessages <action> : Se status é verdadeiro, mensagem(ns) de sucesso, caso contrário vazia.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.warnMessages <action> : Se status é falso, todas as mensagens de aviso lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.errorMessages <action> : Se status é falso, todas as mensagens de erro lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    O exemplo a seguir mostra como criar uma função para chamar doConferenceAction() para manipular os participantes em uma chamada em conferência, passando a ação e os participantes.

    
/**
 * 
 * @param {string} action - action to perform on the conference object or participant object
 * @param {Array} participants;
 */
function doConferenceAction(action, participants) {
    var data = NotifyOnTaskClient.getNotifyActionTemplate();
    data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
    data.confId = 'Active conference sysId';
    data.items = participants;

    NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
        var kickActionResult = result[0];
        if (kickActionResult.status)
            console.log(action + ' succeeded');
        else {
            kickActionResult.warnMessages.forEach(function (msg) {
                console.warn(msg);
            });
            kickActionResult.errorMessages.forEach(function (msg) {
                console.error(msg);
            });
        }
    }, function (errMsg) {
            console.log(errMsg)
    });
}

// kick participants

doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);

// kick multiple participants

doConferenceAction('multiKick',
    [{notifyParticipantId: 'notifyParticipantSysId'},
    {notifyParticipantId: 'notifyParticipantSysId'}]);

// Mute participants
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);

doConferenceAction('multiMute',
    [{notifyParticipantId: 'notifyParticipantSysId'},
    {notifyParticipantId: 'notifyParticipantSysId'}]);

// self join to any confernece. 
doConferenceAction('selfJoin', [{id: 'logged in userId'}]);

    NotifyOnTaskClient - endConference(Dados do objeto)

    Encerra a chamada em conferência especificada.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    dados Objeto Objeto que descreve a chamada em conferência.
    Data.confId Cadeia de caracteres Sys_id da chamada em conferência.
    data.serviceProvider Cadeia de caracteres Obrigatório. Nome do provedor de serviço de conferência, como Zoom ou Webex.
    Tabela 6. Retornos
    Tipo Descrição
    Objeto Resultados da ação da conferência.

    <action>.status Status da ação de conferência.

    • Tipo de dados: Booliano
    • Valores possíveis:
      • Verdadeiro: Ação de conferência bem-sucedida
      • Falso: Falha na ação de conferência

    Mensagens.successMessages <action> : Se status é verdadeiro, mensagem(ns) de sucesso, caso contrário vazia.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.warnMessages <action> : Se status é falso, todas as mensagens de aviso lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.errorMessages <action> : Se status é falso, todas as mensagens de erro lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres
    		 
    function endConferenceCall() {
    var data = NotifyOnTaskClient.getNotifyActionTemplate();
    data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
    data.confId = 'Active conference sysId';

    NotifyOnTaskClient.endConference(data).then(function (result) {
        var endActionResult = result[0];
        if (endActionResult.status)
            console.log('Conference has been ended');
        else {
            endActionResult.warnMessages.forEach(function (msg) {
                console.warn(msg);
            });
            endActionResult.errorMessages.forEach(function (msg) {
                console.error(msg);
            });
        }
    }, function (errMsg) {
        console.log(errMsg);
    });
}

    NotifyOnTaskClient - getNotifyActionTemplate()

    Retorna um modelo de dados JSON a ser usado com DoConferenceAction() método. Usar este modelo estrutura automaticamente o objeto de dados para que você não precise criá-lo manualmente.

    Chame este método antes de chamar DoConferenceAction() método. Para a ação de chamada em conferência desejada, defina os parâmetros desejados no modelo e passe o modelo no DoConferenceAction() chamada. Para obter informações adicionais sobre os parâmetros válidos para cada ação, consulte DoConferenceAction() .

    Nota:
    Este é um método auxiliar. Você também pode construir manualmente este objeto e passá-lo para DoConferenceAction() e têm o mesmo resultado.
    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    dados Objeto que descreve a chamada em conferência.
    AddToWorkNotes Sinalizador que indica se informações sobre os participantes que foram incluídos na chamada em conferência devem ser adicionadas no campo Anotações de trabalho do registro associado.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro no qual as anotações de trabalho serão adicionadas.

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • ingressar
    • MultiJoin
    • SelfJoin
    • início
    Data.allowMultconference Sinalizador que indica se várias chamadas em conferência devem ser permitidas para um registro específico de uma só vez.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro que tem permissão para ter várias chamadas em conferência.

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • início
    Data.confId Sys_id da chamada em conferência.

    Chamada em conferência do Notify [notify_conference_call]

    Ações para as quais este parâmetro é necessário:

    • término
    • ingressar
    • MultiJoin
    • SelfJoin
    Nota:
    As ações do participante, como silenciar, desativar mudo e desligar, não exigem que este parâmetro seja definido, pois o método obtém essas informações da tabela Participante da chamada em conferência do Notify [notify_participant].
    data.fromNumber Número do provedor de serviço para chamar para a chamada em conferência.

    Localize este valor na coluna Número ou Número de telefone da tabela Número de telefone do Notify [notify_number].

    Ações para as quais este parâmetro é necessário:

    • início
    Nova Conferência Sinalizador que indica se esta é uma chamada em conferência nova ou existente.

    Valores válidos:

    • Verdadeiro: Nova chamada em conferência
    • Falso: Chamada em conferência existente

    Padrão: falso

    Ações para as quais este parâmetro é válido:

    • início
    data.items Informações para cada participante incluir na chamada em conferência.

    Valores de matriz válidos:

    • Sys_id do usuário; localizado na tabela Usuário [sys_User].

      Ações válidas: Ingressar, multiJoin, iniciar

    • NotifyParticidentId: Sys ID do participante do Notify; localizado na tabela Participante do Notify [notify_participant].

      Ações válidas: Ingressar, kick, multiJoin, mudo, iniciar, desativar mudo

    • PhonNumber: Número de telefone do participante. Se este valor for passado em conjunto com idou notifyParticipantIdeste valor substitui os números de telefone no registro de usuário/participante e é usado para fazer a chamada.

      Ações válidas: Ingressar, multiJoin, iniciar

    • E-mail: Endereço de e-mail do participante.

      Ações válidas: Ingressar, multiJoin, iniciar
    data.message Mensagem que é lida em voz alta quando um usuário atende à chamada, como "O incidente P1 foi criado, faça login na instância".

    Ações para as quais este parâmetro é válido:

    • ingressar
    • MultiJoin
    • início
    data.serviceProvider Obrigatório. Nome do provedor de serviço de conferência, como Zoom ou Webex.

    Ações para as quais este parâmetro é necessário:

    • tudo
    SYSID.data Sys_id do registro de origem a ser associado à chamada em conferência.

    Por exemplo, se uma chamada em conferência for realizada para discutir um incidente ou problema específico, coloque o sys_id do incidente ou registro de problema neste valor. Este sys_id é armazenado na coluna Origem da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado posteriormente.

    Este parâmetro é usado em conjunto com data.Table, data.addToWorkNotese allowMulticonferenceparâmetros.

    Ações para as quais este parâmetro é válido:

    • início
    data.table Tabela que contém o registro de origem a ser associado à chamada em conferência. Um registro de origem pode ser qualquer registro, como um "incidente" ou "problema", que é o tópico de discussão na chamada em conferência.

    Este nome de tabela é armazenado na coluna Tabela da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado.

    Este parâmetro é usado em conjunto com data.sysId, data.addToWorkNotese allowMulticonferenceparâmetros.

    Ações para as quais este parâmetro é válido:

    • início

    O exemplo a seguir mostra como chamar getNotifyActionTemplate() para obter o modelo de dados necessário para definir as ações para doConferenceAction().

    
/**
 * 
 * @param {string} action - action to perform on the conference object or participant object
 * @param {Array} participants;
 */
function doConferenceAction(action, participants) {
    var data = NotifyOnTaskClient.getNotifyActionTemplate();
    data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
    data.confId = 'Active conference sysId';
    data.items = participants;

    NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
        var kickActionResult = result[0];
        if (kickActionResult.status)
            console.log(action + ' succeeded');
        else {
            kickActionResult.warnMessages.forEach(function (msg) {
                console.warn(msg);
            });
            kickActionResult.errorMessages.forEach(function (msg) {
                console.error(msg);
            });
        }
    }, function (errMsg) {
            console.log(errMsg)
    });
}

// kick participants

doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);

// kick multiple participants

doConferenceAction('multiKick',
    [{notifyParticipantId: 'notifyParticipantSysId'},
    {notifyParticipantId: 'notifyParticipantSysId'}]);

// Mute participants
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);

doConferenceAction('multiMute',
    [{notifyParticipantId: 'notifyParticipantSysId'},
    {notifyParticipantId: 'notifyParticipantSysId'}]);

// self join to any confernece. 
doConferenceAction('selfJoin', [{id: 'logged in userId'}]);

    NotifyOnTaskClient - start(Dados do objeto)

    Inicia uma nova chamada em conferência.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    dados Objeto Objeto que descreve a chamada em conferência.
    AddToWorkNotes Booliano Opcional.Sinalizador que indica se informações sobre os participantes que foram incluídos na chamada em conferência devem ser adicionadas no campo Anotações de trabalho do registro associado.

    Para que esta funcionalidade funcione, você também deve especificar valores para data.tablee. data.sysIdparâmetros para identificar o registro no qual as anotações de trabalho serão adicionadas.

    Padrão: falso
    AllowMulticonference Booliano Opcional. Sinalizador que indica se várias chamadas em conferência devem ser permitidas para um registro específico de uma só vez.

    Para que esta funcionalidade funcione, você também deve especificar valores em data.tablee. data.sysIdparâmetros. Esses parâmetros identificam o registro que tem permissão para ter várias chamadas em conferência.

    Padrão: falso
    data.fromNumber Cadeia de caracteres Obrigatório. Número do provedor de serviço para chamar para a chamada em conferência.

    Localize este valor na coluna Número ou Número de telefone da tabela Número de telefone do Notify [notify_number].
    data.items Matriz Opcional. Informações para cada participante incluir na chamada em conferência. 
    "items": [
  "email": "String",
  "id": "String",
  "notifyParticipantId": "String",
  "phoneNumber": "String"
]
    data.items.email Cadeia de caracteres Endereço de e-mail do participante.
    data.items.id Cadeia de caracteres Sys_id do usuário.

    Tabela: Usuário [sys_User]
    data.items.notifyParticipantId Cadeia de caracteres Sys_id do participante.

    Tabela: Participante do Notify [notify_participant]
    data.items.phoneNumber Cadeia de caracteres Número de telefone do participante. Se este valor for passado em conjunto com idou notifyParticipantIdeste valor substitui os números de telefone no registro de usuário/participante e é usado para fazer a chamada.
    data.message Cadeia de caracteres Opcional. Mensagem que é lida em voz alta quando um usuário atende à chamada, como "O incidente P1 foi criado, faça login na instância".
    data.serviceProvider Cadeia de caracteres Obrigatório. Nome do provedor de serviço de conferência, como Zoom ou Webex.
    SYSID.data Cadeia de caracteres Opcional. Sys_id do registro de origem a ser associado à chamada em conferência.

    Por exemplo, se uma chamada em conferência for realizada para discutir um incidente ou problema específico, coloque o sys_id do incidente ou registro de problema neste valor. Este sys_id é armazenado na coluna Origem da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado posteriormente.

    Este parâmetro é usado em conjunto com data.Table, data.addToWorkNotese allowMulticonferenceparâmetros.

    data.table Cadeia de caracteres Opcional. Tabela que contém o registro de origem a ser associado à chamada em conferência. Um registro de origem pode ser qualquer registro, como um "incidente" ou "problema", que é o tópico de discussão na chamada em conferência.

    Este nome de tabela é armazenado na coluna Tabela da tabela NotifyConference Call [notify_conference_call] e pode ser rastreado.

    Este parâmetro é usado em conjunto com data.sysId, data.addToWorkNotese allowMulticonferenceparâmetros.
    Tabela 10. Retornos
    Tipo Descrição
    Objeto Resultados da ação da conferência.

    <action>.status Status da ação de conferência.

    • Tipo de dados: Booliano
    • Valores possíveis:
      • Verdadeiro: Ação de conferência bem-sucedida
      • Falso: Falha na ação de conferência

    Mensagens.successMessages <action> : Se status é verdadeiro, mensagem(ns) de sucesso, caso contrário vazia.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.warnMessages <action> : Se status é falso, todas as mensagens de aviso lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    Mensagens.errorMessages <action> : Se status é falso, todas as mensagens de erro lançadas durante o processamento.

    • Tipo de dados: Matriz de cadeias de caracteres

    O exemplo de código a seguir mostra como chamar este método.

    function startConferenceCall() {
    var data = NotifyOnTaskClient.getNotifyActionTemplate();
    data.table = 'incident';
    data.sysId = '1234';
    data.serviceProvider = serviceProvider;
    data.addToWorkNotes = true;
    data.fromNumber = 'Telephony Number';
    data.items.push({ id: 'userSysId' });
    data.items.push({ phoneNumber: '+917799555332' });
    data.items.push({ email: 'yln99517@gmail.com' });

    NotifyOnTaskClient.start(data).then(function (result) {
        var startActionResult = result[0];
        if(startActionResult.status) {
            startActionResult.successMessages.forEach(function(msg) {
                console.log(msg);
            });
            return;
        }

        startActionResult.warnMessages.forEach(function(msg) {
            console.warn(msg);
        });
        startActionResult.errorMessages.forEach(function(msg) {
            console.error(msg);
        });
    }, function (errMsg) {
        console.log(errMsg);
    });
}