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


---

# OnCallContactPrefTemplate - global

# OnCallContactPrefTemplate - global {#ariaid-title1}

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

A inclusão de script OnCallContactPrefTemplate fornece métodos para aplicar modelos de preferência de contato a conjuntos de escalação.

Para obter mais informações sobre o processo de escalação, consulte [Defining On-Call Scheduling escalation process](https://www.servicenow.com/docs/access?context=defining-escalation-process-and-template&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).

Esta inclusão de script requer o plug-in Agendamento de plantão (com.snc.on_call_rotation).

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

Instancia um objeto OnCallContactPrefTemplate.
{#OnCallCtPrefTemp-OnCallCtPrefTemp__table_b1n_q5c_kxb__entry__3}

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

{#OnCallCtPrefTemp-OnCallCtPrefTemp__table_b1n_q5c_kxb}  
Este exemplo instancia um objeto OnCallContactPrefTemplate.

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

## OnCallContactPrefTemplate - copyContactPreferences(cadeia de caracteres templateSysId, cadeia de caracteres escalationSetSysId) {#ariaid-title3}

Aplica um modelo de preferência de contato a um conjunto de escalação.
Quando o modelo é aplicado ao conjunto de escalação, os registros de tentativa de contato são criados na tabela Preferência de contato do turno \[cmn_rota_contact_preference\].

Antes de chamar este método, chame o método deleteContactPreferenceAttempts() para excluir registros de tentativa de contato existentes. Se os registros existentes não forem excluídos primeiro, este método retornará um erro.
{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_cgl_2rd_3xb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| templateSysId | Cadeia de caracteres | Sys_id do modelo de preferência de contato na tabela Modelo de preferência de contato de plantão \[on_call_template_contact_preference\]. |
| escalationSetSysId | Cadeia de caracteres | Sys_id do conjunto de escalação na tabela Conjunto de escalação de turno \[cmn_rota_escalation_set\]. |
[Tabela 2. Parâmetros]

{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_cgl_2rd_3xb} {#OnCallCtPrefTemp-copyCtPrefs_S_S__table_dgl_2rd_3xb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém mensagens de erro e aviso. Se a operação foi bem-sucedida, este objeto está vazio. Nota: Se ocorrer um erro, a operação será interrompida e o modelo não será aplicado. Se ocorrer um aviso, a operação continuará e alguns registros ainda serão criados. { "error": "String", "warning": "String" } |
| \<Object\>.erro | Mensagens de erro Valores possíveis: * O sys_id do modelo de preferência de contato não está correto * O sys_id do conjunto de escalação não está correto * Já existem tentativas de contato {#OnCallCtPrefTemp-copyCtPrefs_S_S__ul_dmh_3tc_kxb} Tipo de dados: cadeia de caracteres |
| \<Object\>.aviso | Mensagem de aviso. Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_dgl_2rd_3xb}  
Este exemplo aplica um modelo de preferência de contato ao conjunto de escalação Central de serviços - Padrão. O objeto de retorno está vazio porque não há erros ou avisos.

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var templateSysId = "f8dac9ebeb5a6110249e8d835d522873";

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    // delete existing contact attempt records before applying the template
    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId); 

    var result = contactPrefTemp.copyContactPreferences(templateSysId, escSetSysId);
    gs.info(JSON.stringify(result));

Saída:

    {}

## OnCallContactPrefTemplate - deleteContactPreferenceAttempts(cadeia de caracteres escalationSetSysId) {#ariaid-title4}

Exclui todas as preferências de contato associadas a um conjunto de escalação.
Todos os registros de tentativa de contato do conjunto de escalação são excluídos da tabela Preferência de contato do turno \[cmn_rota_contact_preference\].
{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_zlg_zqd_3xb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| escalationSetSysId | Cadeia de caracteres | Sys_id do conjunto de escalação na tabela Conjunto de escalação de turno \[cmn_rota_escalation_set\]. |
[Tabela 4. Parâmetros]

{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_zlg_zqd_3xb} {#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_amg_zqd_3xb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Retorna]

{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_amg_zqd_3xb}  
Este exemplo exclui todas as preferências de contato associadas ao conjunto de escalação Central de serviços - Padrão.

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);