---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# NotifyConferenceUtil - com escopo, global

# NotifyConferenceUtil - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 19 min. de leitura

A API NotifyConferenceUtil fornece métodos para gerenciar chamadas em conferência do Notify e mensagens SMS para vários provedores de serviços de telefonia, como Zoom e Webex.

Usando a API NotifyConferenceUtil, você pode:  
* Criar novas chamadas em conferência
* Adicionar participantes por número de telefone ou ID de usuário
* Remover participantes de uma chamada em conferência
* Silenciar participantes em uma chamada em conferência
* Ativar mudo de participantes em uma chamada em conferência
* Obter as capacidades de um provedor de serviço especificado
* Encerrar uma chamada de conferência
{#NotifyConferenceUtils__ul_qvb_kqy_4hb}

Você pode usar esta API em scripts com escopo e globais. Para usar esta API, você deve ativar o plug-in Conference Notify (com.snc.notify), que requer uma assinatura separada. Para obter detalhes sobre como ativar este plug-in, consulte [Ativação do Notify](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

## NotifyConferenceUtils - NotifyConferenceUtils() {#ariaid-title2}

Instancia um objeto NotifyConferenceUtils (construtor).
{#NUtil-NotifyConferenceUtils__table_qy1_cym_d3b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#NUtil-NotifyConferenceUtils__table_qy1_cym_d3b}  

    function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByPhoneNumber("+917799555331", confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils -- addToConferenceByPhoneNumber(String toNumber, GlideRecord confGR) {#ariaid-title3}

Adiciona um participante a uma chamada em conferência especificada usando o número de telefone para identificar o participante.
{#NUtil-addToConferenceByPhoneNumber_S_GR__table_lt1_kth_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| paraNúmero | Cadeia de caracteres | Número de telefone do participante a ser adicionado à chamada em conferência. |
| confGR | GlideRecord | GlideRecord da chamada em conferência à qual o participante especificado será adicionado. Esses registros estão localizados na tabela Chamada em conferência do Notify \[notify_conference_call\]. |
[Tabela 2. Parâmetros]

{#NUtil-addToConferenceByPhoneNumber_S_GR__table_lt1_kth_nhb} {#NUtil-addToConferenceByPhoneNumber_S_GR__table_mt1_kth_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_w5y_hyt_b3b} {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_tht_4yt_b3b} |
[Tabela 3. Retorna]

{#NUtil-addToConferenceByPhoneNumber_S_GR__table_mt1_kth_nhb}  

    function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByPhoneNumber("+917799555331", confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils -- addToConferenceByUserId(cadeia de caracteres userId, GlideRecord confGR) {#ariaid-title4}

Adiciona um participante à chamada em conferência referenciada pelo passado no GlideRecord usando seu identificador de usuário exclusivo.
{#NUtil-addToConferenceByUserId_S_GR__table_xld_mwh_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| userId | Cadeia de caracteres | SYS ID do participante a ser adicionado à chamada em conferência especificada. Essas informações estão localizadas na tabela Usuário \[sys_user\]. |
| confGR | GlideRecord | GlideRecord da chamada em conferência para adicionar o participante especificado. Esses registros estão localizados na tabela Chamada em conferência do Notify \[notify_conference_call\]. |
[Tabela 4. Parâmetros]

{#NUtil-addToConferenceByUserId_S_GR__table_xld_mwh_nhb} {#NUtil-addToConferenceByUserId_S_GR__table_yld_mwh_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-addToConferenceByUserId_S_GR__ul_w5y_hyt_b3b} {#NUtil-addToConferenceByUserId_S_GR__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByUserId_S_GR__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByUserId_S_GR__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-addToConferenceByUserId_S_GR__ul_tht_4yt_b3b} |
[Tabela 5. Retorna]

{#NUtil-addToConferenceByUserId_S_GR__table_yld_mwh_nhb}  

    (function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByUserId(gs.getUserID(), confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils - doConferenceAction(ação de cadeia de caracteres, dados de objeto) {#ariaid-title5}

Executa a ação de chamada em conferência especificada, como iniciar/encerrar uma chamada em conferência ou ingressar, remover, ativar ou desativar 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 para este método ou chamar o método várias vezes para iniciar a chamada e gerenciar os participantes separadamente. Além disso, 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 campo "Anotações de trabalho" 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.
{#NUtil-doConferenceAction_S_O__ul_rqn_z2y_vhb}
{#NUtil-doConferenceAction_S_O__table_qqs_vdv_nhb__entry__3}{#NUtil-doConferenceAction_S_O__data-entry-NConf}{#NUtil-doConferenceAction_S_O__data.addToWorkNotes-p-NConf}{#NUtil-doConferenceAction_S_O__data.allowMulticonference-p-NConf}{#NUtil-doConferenceAction_S_O__data.confId-p-NConf}{#NUtil-doConferenceAction_S_O__data.fromNumber-p-NConf}{#NUtil-doConferenceAction_S_O__data.isNewConference-p-NConf}{#NUtil-doConferenceAction_S_O__data.items-p-NConf}{#NUtil-doConferenceAction_S_O__data.message-p-NConf}{#NUtil-doConferenceAction_S_O__data.serviceProvider-p-NConf}{#NUtil-doConferenceAction_S_O__data.sys_id-p-NConf}{#NUtil-doConferenceAction_S_O__data.table-p-NConf}

| Nome | Tipo | Descrição |
|-|-|-|
| ação | Cadeia de caracteres | Define a ação de chamada em conferência a ser executada. A seguir estão as ações de chamada em conferência disponíveis: * start: inicia a chamada em conferência identificada em data.confId * end: encerra a chamada em conferência identificada em data.confId * ingressar: adiciona o participante especificado na matriz data.items à chamada em conferência identificada em data.confId * multiJoin: adiciona os participantes especificados na matriz data.items à chamada em conferência identificada em data.confId * selfJoin: adiciona o usuário conectado no momento à chamada em conferência (nenhuma entrada em data.items é necessária). * kick: remove o participante especificado na matriz data.items da chamada em conferência identificada em data.confId * multiKck: remove os participantes especificados na matriz data.items da chamada em conferência identificada em data.confId * mudo: silencia o participante especificado na matriz data.items na chamada em conferência identificada em data.confId * multiMute: silencia os participantes especificados na matriz data.items na chamada em conferência identificada em data.confId * reativar mudo: ativa o mudo do participante especificado na matriz data.items da chamada em conferência identificada em data.confId * multiUnmute: cancela o mudo dos participantes especificados na matriz data.items da chamada em conferência identificada em data.confId {#NUtil-doConferenceAction_S_O__ul_pq5_qfv_nhb} |
| dados | Objeto | Objeto que descreve a chamada em conferência. |
| data.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 de anotações de trabalho do registro associado. Para que esta funcionalidade funcione, você também deve especificar valores nos parâmetros data.table e data.sysId. Esses parâmetros identificam o registro ao qual as anotações de trabalho serão adicionadas.{#NUtil-doConferenceAction_S_O__data.addToWorkNotes2-p-NConf} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar * ingressar * junção múltipla * selfJoin {#NUtil-doConferenceAction_S_O__ul_kwg_ktx_vhb} |
| data.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 nos parâmetros data.table e data.sysId. Esses parâmetros identificam o registro que tem permissão para ter várias chamadas em conferência.{#NUtil-doConferenceAction_S_O__data.allowMulticonference2-p-NConf} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar {#NUtil-doConferenceAction_S_O__ul_ay4_mtx_vhb} |
| data.confId | Cadeia de caracteres | SYS ID da chamada em conferência. O SYS ID da conferência está localizado na tabela Chamada em conferência do Notify \[notify_conference_call\].{#NUtil-doConferenceAction_S_O__data.confId2-p-NConf} Ações para as quais este parâmetro é necessário: * terminar * ingressar * junção múltipla * selfJoin {#NUtil-doConferenceAction_S_O__ul_afs_qsx_vhb} Nota: As ações do participante, como ativar mudo, ativar mudo e retirar, não exigem que este parâmetro seja definido, pois o método obtém essas informações da tabela Participante de chamada em conferência do Notify \[notify_participant\]. |
| dados.deNúmero | Cadeia de caracteres | Número do provedor de serviço para o qual ligar 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\].{#NUtil-doConferenceAction_S_O__data.fromNumber2-p-NConf} Ações para as quais este parâmetro é necessário: * iniciar {#NUtil-doConferenceAction_S_O__ul_exs_stx_vhb} |
| data.isNewConference | 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 {#NUtil-doConferenceAction_S_O__ul_q1m_wbv_nhb} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar {#NUtil-doConferenceAction_S_O__ul_d1d_stx_vhb} |
| dados.itens | Matriz | Informações para cada participante incluir na chamada em conferência. Valores de matriz válidos: * id: SYS ID do usuário; localizado na tabela Usuário \[sys_User\].Ações válidas: ingressar, multiJoin, iniciar * notifyParticipantId: SYS ID do participante do Notify; localizado na tabela Participante do Notify \[notify_participant\].Ações válidas: ingressar, retirar, multiJoin, ativar mudo, iniciar, ativar mudo * phoneNumber: número de telefone do participante. Se este valor for passado em conjunto com id ou notifyParticipantId, ele substituirá os números de telefone no registro de usuário/participante e será 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 {#NUtil-doConferenceAction_S_O__ul_qzh_pqt_rhb} |
| mensagem.dados | 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: * iniciar * ingressar * junção múltipla {#NUtil-doConferenceAction_S_O__ul_jnl_ntx_vhb} |
| dados.serviceProvider | Cadeia de caracteres | Obrigatório. Nome do provedor de serviços de conferência, como Zoom ou Webex. Ações para as quais este parâmetro é necessário: * todos {#NUtil-doConferenceAction_S_O__ul_vwb_psx_vhb} |
| dados.sysId | 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 registro de incidente ou problema neste valor. Este SYS ID é armazenado na coluna Origem da tabela NotifyConference Call \[notify_conference_call\] e pode ser rastreado posteriormente. {#NUtil-doConferenceAction_S_O__data.sys_id-p2-NConf} Este parâmetro é usado em conjunto com os parâmetros data.Table, data.addToWorkNotese allowMulticonference.{#NUtil-doConferenceAction_S_O__data.sys_id-p3-NConf} Ações para as quais este parâmetro é válido: * iniciar {#NUtil-doConferenceAction_S_O__ul_h3l_qsx_vhb} |
| dados.tabela | 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 seja 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.{#NUtil-doConferenceAction_S_O__data.table-p2-NConf} Este parâmetro é usado em conjunto com os parâmetros data.sysId, data.addToWorkNotese allowMulticonference.{#NUtil-doConferenceAction_S_O__data.table-p3-NConf} Ações para as quais este parâmetro é válido: * iniciar {#NUtil-doConferenceAction_S_O__ul_mj1_4sx_vhb} |
[Tabela 6. Parâmetros]

{#NUtil-doConferenceAction_S_O__table_qqs_vdv_nhb} {#NUtil-doConferenceAction_S_O__table_rqs_vdv_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-doConferenceAction_S_O__ul_w5y_hyt_b3b} {#NUtil-doConferenceAction_S_O__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-doConferenceAction_S_O__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-doConferenceAction_S_O__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-doConferenceAction_S_O__ul_tht_4yt_b3b} |
[Tabela 7. Retorna]

{#NUtil-doConferenceAction_S_O__table_rqs_vdv_nhb}  

    (function (confId) {
    	var confUtils = new NotifyConferenceUtils();
    	var data = confUtils.getConferenceInputDataTemplate();
    	data.table = 'incident';
    	data.sysId = '1234';
    	data.addToWorkNotes = false;
    	data.confId = confId;
    	data.message = 'p1 incident has been created';
    	data.fromNumber = 'twilio/Telephony driver number';
    	data.items.push({ id: 'user3SysId', phoneNumber: '+917799555332' });
    	data.items.push({ id: 'user4SysId', email: 'yln99518@gmail.com' });

    	var result = confUtils.doConferenceAction('start', data);
    	if (result.status) {
    		gs.info('Start conference action succeeded');
    	} else
    		gs.info('Start conference action failed');

    	result.errorMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.warnMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.successMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    })('activeConfSysId');

## NotifyConferenceUtils -- getConferenceInputDataTemplate() {#ariaid-title6}

Retorna um modelo de dados JSON a ser usado com o método doConferenceAction(). O uso deste modelo estrutura automaticamente o objeto de dados para que você não precise criá-lo manualmente.
Chame este método antes de chamar o método doConferenceAction(). Para a ação de chamada em conferência desejada, defina os parâmetros desejados no modelo e passe o modelo na chamada doConferenceAction(). Para obter informações adicionais sobre os parâmetros válidos para cada ação, consulte [doConferenceAction()](https://servicenow-prod.fluidtopics.net/q45RqOzJxNmQVsC51N9puA#NotifyConferenceUtils "A API NotifyConferenceUtil fornece métodos para gerenciar chamadas em conferência do Notify e mensagens SMS para vários provedores de serviços de telefonia, como Zoom e Webex.").  
Nota:  
Este é um método auxiliar. Você também pode construir manualmente este objeto e passá-lo para o método doConferenceAction() e obter o mesmo resultado.
{#NUtil-getConferenceInputDataTemplate__table_azh_qyg_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 8. Parâmetros]

{#NUtil-getConferenceInputDataTemplate__table_azh_qyg_nhb} {#NUtil-getConferenceInputDataTemplate__table_c2h_cwd_vhb__entry__2}{#NUtil-getConferenceInputDataTemplate__data.addToWorkNotes-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.allowMulticonference-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.confId-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.fromNumber-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.isNewConference-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.items-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.message-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.serviceProvider-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.sys_id-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.table-p-NConf}

| Tipo | Descrição |
|-|-|
| dados | Objeto que descreve a chamada em conferência. |
| data.addToWorkNotes | Sinalizador que indica se informações sobre os participantes que foram incluídos na chamada em conferência devem ser adicionadas no campo de anotações de trabalho do registro associado. Para que esta funcionalidade funcione, você também deve especificar valores nos parâmetros data.table e data.sysId. Esses parâmetros identificam o registro ao qual as anotações de trabalho serão adicionadas.{#NUtil-getConferenceInputDataTemplate__data.addToWorkNotes2-p-NConf} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar * ingressar * junção múltipla * selfJoin {#NUtil-getConferenceInputDataTemplate__ul_kwg_ktx_vhb} |
| dados.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 nos parâmetros data.table e data.sysId. Esses parâmetros identificam o registro que tem permissão para ter várias chamadas em conferência.{#NUtil-getConferenceInputDataTemplate__data.allowMulticonference2-p-NConf} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar {#NUtil-getConferenceInputDataTemplate__ul_ay4_mtx_vhb} |
| data.confId | SYS ID da chamada em conferência. O SYS ID da conferência está localizado na tabela Chamada em conferência do Notify \[notify_conference_call\].{#NUtil-getConferenceInputDataTemplate__data.confId2-p-NConf} Ações para as quais este parâmetro é necessário: * terminar * ingressar * junção múltipla * selfJoin {#NUtil-getConferenceInputDataTemplate__ul_afs_qsx_vhb} Nota: As ações do participante, como ativar mudo, ativar mudo e retirar, não exigem que este parâmetro seja definido, pois o método obtém essas informações da tabela Participante de chamada em conferência do Notify \[notify_participant\]. |
| dados.deNúmero | Número do provedor de serviço para o qual ligar 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\].{#NUtil-getConferenceInputDataTemplate__data.fromNumber2-p-NConf} Ações para as quais este parâmetro é necessário: * iniciar {#NUtil-getConferenceInputDataTemplate__ul_exs_stx_vhb} |
| data.isNewConference | 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 {#NUtil-getConferenceInputDataTemplate__ul_q1m_wbv_nhb} Padrão: falso Ações para as quais este parâmetro é válido: * iniciar {#NUtil-getConferenceInputDataTemplate__ul_d1d_stx_vhb} |
| dados.itens | Informações para cada participante incluir na chamada em conferência. Valores de matriz válidos: * id: SYS ID do usuário; localizado na tabela Usuário \[sys_User\].Ações válidas: ingressar, multiJoin, iniciar * notifyParticipantId: SYS ID do participante do Notify; localizado na tabela Participante do Notify \[notify_participant\].Ações válidas: ingressar, retirar, multiJoin, ativar mudo, iniciar, ativar mudo * phoneNumber: número de telefone do participante. Se este valor for passado em conjunto com id ou notifyParticipantId, ele substituirá os números de telefone no registro de usuário/participante e será 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 {#NUtil-getConferenceInputDataTemplate__ul_qzh_pqt_rhb} |
| mensagem.dados | 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: * iniciar * ingressar * junção múltipla {#NUtil-getConferenceInputDataTemplate__ul_jnl_ntx_vhb} |
| dados.serviceProvider | Obrigatório. Nome do provedor de serviços de conferência, como Zoom ou Webex. Ações para as quais este parâmetro é necessário: * todos {#NUtil-getConferenceInputDataTemplate__ul_vwb_psx_vhb} |
| dados.sysId | 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 registro de incidente ou problema neste valor. Este SYS ID é armazenado na coluna Origem da tabela NotifyConference Call \[notify_conference_call\] e pode ser rastreado posteriormente. {#NUtil-getConferenceInputDataTemplate__data.sys_id-p2-NConf} Este parâmetro é usado em conjunto com os parâmetros data.Table, data.addToWorkNotese allowMulticonference.{#NUtil-getConferenceInputDataTemplate__data.sys_id-p3-NConf} Ações para as quais este parâmetro é válido: * iniciar {#NUtil-getConferenceInputDataTemplate__ul_h3l_qsx_vhb} |
| dados.tabela | 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 seja 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.{#NUtil-getConferenceInputDataTemplate__data.table-p2-NConf} Este parâmetro é usado em conjunto com os parâmetros data.sysId, data.addToWorkNotese allowMulticonference.{#NUtil-getConferenceInputDataTemplate__data.table-p3-NConf} Ações para as quais este parâmetro é válido: * iniciar {#NUtil-getConferenceInputDataTemplate__ul_mj1_4sx_vhb} |
[Tabela 9. Retorna]

{#NUtil-getConferenceInputDataTemplate__table_c2h_cwd_vhb}  

    (function (confId) {
    	var confUtils = new NotifyConferenceUtils();
    	var data = confUtils.getConferenceInputDataTemplate();
    	data.confId = confId;
    	var result = confUtils.doConferenceAction('end', data);
    	if (result.status) {
    		gs.info('Conference call has been ended');
    	} else
    		gs.info('End conference call action failed');

    	result.errorMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.warnMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.successMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    })('activeConfSysId');

## NotifyConferenceUtils -- getServiceProvidersCapabilities() {#ariaid-title7}

Retorna os recursos de todos os drivers do provedor de serviços de telefonia na instância.
As capacidades possíveis incluem:

* arquivar: arquiva a conferência após o término
* beepOnLeave: reproduz um som de "bipe" quando um participante sai da chamada em conferência
* beepOnJoin: reproduz um som de "bipe" quando um participante ingressa na chamada em conferência
* end: encerra a chamada em conferência identificada
* compartilhamento de arquivos: permite o compartilhamento de arquivos entre os participantes
* ingressar: adiciona um participante a uma chamada em conferência
* kick: remove um participante de uma chamada em conferência
* multiJoin: adiciona vários participantes a uma chamada em conferência
* multiKck: remove vários participantes de uma chamada em conferência
* muteOnJoin: silencia um participante quando ele ingressa inicialmente em uma chamada em conferência
* multiUnmute: ativa o mudo de vários participantes de uma chamada em conferência
* registro: registra chamadas em conferência
* gravação: fornece um indicador na tela quando a chamada em conferência está sendo gravada
* Compartilhamento de tela: permite que as telas dos participantes sejam compartilhadas com o grupo
* selfJoin: adiciona o usuário conectado no momento a uma chamada em conferência
* Falando: fornece uma mensagem na tela sobre quem está falando no momento
* iniciar: inicia a chamada em conferência identificada
* reativar mudo: reativa o mudo de um participante em uma chamada em conferência
{#NUtil-getServiceProvidersCapabilities__ul_pq5_qfv_nhb}
{#NUtil-getServiceProvidersCapabilities__table_azh_qyg_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 10. Parâmetros]

{#NUtil-getServiceProvidersCapabilities__table_azh_qyg_nhb} {#NUtil-getServiceProvidersCapabilities__table_bzh_qyg_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Pares de chave-valor do status de cada capacidade do driver. Valores válidos: * isSupported = 0: a capacidade não é compatível * isSupported = 1: a capacidade é compatível {#NUtil-getServiceProvidersCapabilities__ul_jbq_mdt_rhb} |
[Tabela 11. Retorna]

{#NUtil-getServiceProvidersCapabilities__table_bzh_qyg_nhb}  
Listar capacidades de driver para todos os drivers de provedor de serviços de telefonia na instância.

    (function () {
    	var confUtils = new NotifyConferenceUtils();
    	var providerToCapability = confUtils.getServiceProvidersCapabilites();
    	for (var provider in providerToCapability) {
    		gs.info('{0} supported capabilities \n\n', provider);
    		var capabilities = providerToCapability[provider]
    		for (var cap in capabilities)
    			if(confUtils.isActionSupported(capabilities[cap].isSupported))
    				gs.info('"{0}" action supported', cap);
    			else
    				gs.info("'{0}' action is not supported by this conference driver", cap);
    	}
    })();

Saída: o método retorna um nó semelhante ao seguinte para cada provedor de serviços de telefonia ativo na instância.

    {
        "Telephony": {
            "start": {
                "isSupported": 1,
                "meta": {}
            },
            "end": {
                "isSupported": 1,
                "meta": {}
            },
            "selfJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "join": {
                "isSupported": 1,
                "meta": {}
            },
            "multiJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "mute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiMute": {
                "isSupported": 1,
                "meta": {}
            },
            "unmute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiUnmute": {
                "isSupported": 1,
                "meta": {}
            },
            "kick": {
                "isSupported": 1,
                "meta": {}
            },
            "multiKick": {
                "isSupported": 1,
                "meta": {}
            },
            "record": {
                "isSupported": 0,
                "meta": {}
            },
            "speaking": {
                "isSupported": 0,
                "meta": {}
            },
            "recording": {
                "isSupported": 0,
                "meta": {}
            },
            "screenSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "fileSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "archive": {
                "isSupported": 0,
                "meta": {}
            },
            "muteOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnLeave": {
                "isSupported": 0,
                "meta": {}
            }
        }
    }

## NotifyConferenceUtils - isActionSupported (ação numérica) {#ariaid-title8}

Determina se uma ação de conferência do Notify é compatível com um provedor de serviços de telefonia.
Para usar este método, você deve primeiro chamar o método getServiceProviderCapabilities(). Este método retorna um objeto que contém informações sobre a disponibilidade de cada ação de conferência Notify possível para cada provedor de serviço configurado em sua instância.

Por exemplo:  

    {
        "Telephony": {
            "start": {
                "isSupported": 1,
                "meta": {}
            },
            "end": {
                "isSupported": 1,
                "meta": {}
            },
            "selfJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "join": {
                "isSupported": 1,
                "meta": {}
            },
            "multiJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "mute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiMute": {
                "isSupported": 1,
                "meta": {}
            },
            "unmute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiUnmute": {
                "isSupported": 1,
                "meta": {}
            },
            "kick": {
                "isSupported": 1,
                "meta": {}
            },
            "multiKick": {
                "isSupported": 1,
                "meta": {}
            },
            "record": {
                "isSupported": 0,
                "meta": {}
            },
            "speaking": {
                "isSupported": 0,
                "meta": {}
            },
            "recording": {
                "isSupported": 0,
                "meta": {}
            },
            "screenSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "fileSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "archive": {
                "isSupported": 0,
                "meta": {}
            },
            "muteOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnLeave": {
                "isSupported": 0,
                "meta": {}
            }
        }
    }

{#NUtil-isActionSupported_N__table_gsw_vd2_vhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ação | Número | Valor do parâmetro isSupported retornado pelo método getServiceProvidersCapabilities() para uma ação e provedor de serviço específicos. Nota: Embora o valor isSupported possa parecer um booliano, na verdade é um número. Não tente avaliar as capacidades como valores boolianos. Use este método, pois os valores associados podem ser expandidos em versões futuras. |
[Tabela 12. Parâmetros]

{#NUtil-isActionSupported_N__table_gsw_vd2_vhb} {#NUtil-isActionSupported_N__table_hsw_vd2_vhb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o provedor de serviços de telefonia oferece suporte à ação especificada. Valores válidos: * verdadeiro: a ação é compatível com o provedor de serviços * falso: a ação não é compatível com o provedor de serviço {#NUtil-isActionSupported_N__ul_pkt_mf2_vhb} |
[Tabela 13. Retorna]

{#NUtil-isActionSupported_N__table_hsw_vd2_vhb}  

    (function () {
      var confUtils = new NotifyConferenceUtils();
      var providerToCapability = confUtils.getServiceProvidersCapabilites();
        for (var provider in providerToCapability) {
          gs.info('{0} supported capabilities \n\n', provider);
          var capabilities = providerToCapability[provider]
          for (var cap in capabilities)
            if (confUtils.isActionSupported(capabilities[cap].isSupported))
              gs.info('"{0}" action supported', cap);
            else
              gs.info("'{0}' action is not supported by this conference driver", cap);
        }
    })();

## NotifyConferenceUtils - kickByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title9}

Remove o participante associado ao GlideRecord aprovado da chamada em conferência atual.
{#NUtil-kickByParticipantGR_GR__table_inj_thh_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| notifyParticipantGR | GlideRecord | Objeto GlideRecord do participante a ser removido da chamada em conferência. Esses registros estão localizados na tabela Participante do Notify \[notify_participant\]. |
[Tabela 14. Parâmetros]

{#NUtil-kickByParticipantGR_GR__table_inj_thh_nhb} {#NUtil-kickByParticipantGR_GR__table_jnj_thh_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-kickByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-kickByParticipantGR_GR__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-kickByParticipantGR_GR__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-kickByParticipantGR_GR__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-kickByParticipantGR_GR__ul_tht_4yt_b3b} |
[Tabela 15. Retorna]

{#NUtil-kickByParticipantGR_GR__table_jnj_thh_nhb}  

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');  // Participant record contains conf call ID
        participantGR.get('validParticipantSysId');
        var actionResult = confUtils.kickByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been kicked out of conference');
        else {
            gs.info('kick operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })()

## NotifyConferenceUtils -- muteByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title10}

Silencia o participante associado ao aprovado no GlideRecord na chamada em conferência atual.
{#NUtil-muteByParticipantGR_GR__table_vpk_ckh_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| notifyParticipantGR | Objeto | Objeto GlideRecord do participante a ser silenciado. Esses registros estão localizados na tabela Participante do Notify \[notify_participant\]. |
[Tabela 16. Parâmetros]

{#NUtil-muteByParticipantGR_GR__table_vpk_ckh_nhb} {#NUtil-muteByParticipantGR_GR__table_wpk_ckh_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-muteByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-muteByParticipantGR_GR__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-muteByParticipantGR_GR__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-muteByParticipantGR_GR__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-muteByParticipantGR_GR__ul_tht_4yt_b3b} |
[Tabela 17. Retorna]

{#NUtil-muteByParticipantGR_GR__table_wpk_ckh_nhb}  

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');
        participantGR.get('validSysId');
        var actionResult = confUtils.muteByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been muted');
        else {
            gs.info('mute operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })()

## NotifyConferenceUtils -- unmuteByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title11}

Cancela o mudo do participante associado ao aprovado no GlideRecord na chamada em conferência atual.
{#NUtil-unmuteByParticipantGR_GR__table_byp_zqh_nhb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| notifyParticipantGR | GlideRecord | Objeto GlideRecord do participante a ser reativado. Esses registros estão localizados na tabela Participante do Notify \[notify_participant\]. |
[Tabela 18. Parâmetros]

{#NUtil-unmuteByParticipantGR_GR__table_byp_zqh_nhb} {#NUtil-unmuteByParticipantGR_GR__table_cyp_zqh_nhb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Resultados da ação de conferência. \<action`.status`: status da ação de conferência. * Tipo de dados: booliano * Valores válidos: * verdadeiro: ação de conferência bem-sucedida * falso: falha na ação de conferência {#NUtil-unmuteByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-unmuteByParticipantGR_GR__ul_psg_gyt_b3b} \<action`.successMessages`: se o <var class="keyword varname">status</var> for verdadeiro, mensagem(ns) de sucesso, caso contrário, vazio(s). * Tipo de dados: matriz de cadeias de caracteres {#NUtil-unmuteByParticipantGR_GR__ul_qm2_myt_b3b} \<action`.warnMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de aviso serão lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-unmuteByParticipantGR_GR__ul_xbz_nyt_b3b} \<action`.errorMessages`: se o <var class="keyword varname">status</var> for falso, todas as mensagens de erro lançadas durante o processamento. * Tipo de dados: matriz de cadeias de caracteres {#NUtil-unmuteByParticipantGR_GR__ul_tht_4yt_b3b} |
[Tabela 19. Retorna]

{#NUtil-unmuteByParticipantGR_GR__table_cyp_zqh_nhb}  

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');
        participantGR.get('validSysId');
        var actionResult = confUtils.unmuteByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been Unmuted');
        else {
            gs.info('Unmute operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })();