API de encerramento

  • Versão de lançamento: Yokohama
  • Atualizado 19 de fev. de 2025
  • 36 min. de leitura

    • A API de encerramento fornece endpoints para gerenciar a funcionalidade de encerramento para sistemas externos da Central de contato como serviço (CCaaS) ou espaços Now Platform.

    Esta API requer o plug-in Gestão de interações (com.glide.interaction). Para chamar esta API, você deve ter a função interaction_integration_user.

    Quando os agentes encerram uma interação, o recurso de encerramento permite que eles insiram detalhes de encerramento e códigos de encerramento para referência futura. Para obter mais informações sobre a funcionalidade de encerramento, consulte Wrap up overview.

    Para usar a API de encerramento para encerramento segmentado de interações de sistemas externos, você deve implementar o ponto de extensão com script InteractionSegment para criar e recuperar registros de segmento na tabela escolhida. Se você estiver usando o OpenFrame, o ponto de extensão terá uma implementação existente para criar e recuperar registros de segmento na tabela Log de telefone [sn_openframe_phone_log].

    Encerrar - GET /now/wrapup/code/{code_id}

    Recupera detalhes de um código de encerramento especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/code/{code_id}

    URL padrão: /api/now/wrapup/code/{code_id}

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    code_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém informações sobre a solicitação de API e o código de encerramento.

    Tipo de dados: objeto

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    resultado.mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    resultado.result_map Objeto que contém o código de encerramento.

    Tipo de dados: objeto

    "result_map": {
   "wrap_up_code": {Object}
}
    result.result_map.wrap_up_code Objeto com detalhes sobre o código de encerramento.

    Tipo de dados: objeto

    "wrap_up_code": {
   "active": Boolean,
   "code": "String",
   "description": "String",
   "external": Boolean,
   "sys_id": "String",
   "translated_code": "String",
   "translated_description": "String"
}
    result.result_map.wrap_up_code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    result.result_map.wrap_up_code.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.wrap_up_code.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.wrap_up_code.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    result.result_map.wrap_up_code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    result.result_map.wrap_up_code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.wrap_up_code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano

    Solicitação de cURL

    Este exemplo recupera detalhes de um código de encerramento especificado.

    curl "https://instance.service-now.com/api/now/v1/wrapup/code/49c27b679f201210c89656effa0a1cd7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Corpo da resposta.

    {
  "result": {
    "message": "Wrap up code found.",
    "result_map": {
      "wrap_up_code": {
        "code": "Billing Issue",
        "description": "A code for billing issues",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": "Ein code für Abrechnungsprobleme"
      }
    },
    "success": true
  }
}

    Encerrar - GET /now/wrapup/segment/{segment_id}

    Recupera detalhes de um segmento de encerramento especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/segment/{segment_id}

    URL padrão: /api/now/wrapup/segment/{segment_id}

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    segment_id Sys_id do segmento de encerramento na tabela Segmento de encerramento de interação [interaction_wrap_up_segment] ou identificador que representa o segmento de interação no sistema externo.

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    segmento Objeto que contém dados sobre a interação e o segmento de encerramento.

    Tipo de dados: objeto

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segmento.agente Sys_id do agente atribuído à interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    segment.aguardando_confirmação Sinalizador que indica se o segmento de encerramento enviado pelo agente está aguardando a confirmação de que foi processado pelo sistema CCaaS externo.
    Valores válidos:
    • verdadeiro: o segmento de encerramento está aguardando confirmação.
    • falso: o segmento de encerramento foi processado pelo sistema externo.

    Tipo de dados: booliano
    segmento.confirmado_em Data e hora em que o segmento de encerramento enviado é processado no sistema CCaaS externo.

    Tipo de dados: cadeia de caracteres
    segmento.externo Sinalizador que indica se o segmento de interação é de um sistema externo.
    Valores válidos:
    • verdadeiro: o segmento de interação é de um sistema externo.
    • falso: o segmento de interação é interno.

    Tipo de dados: booliano

    Padrão: falso
    segment.interaction Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    segmento.aberto_em A data e hora de início do período de encerramento de acordo com o sistema externo.

    Tipo de dados: cadeia de caracteres
    segment.segmentado Sinalizador que indica se o encerramento é segmentado.
    Valores válidos:
    • verdadeiro: o encerramento é segmentado em várias partes.
    • falso: o encerramento é um segmento completo.

    Tipo de dados: booliano

    Padrão: falso
    segment.segment_id Sys_id do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segment.segment_table Nome da tabela que contém o segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.estado Estado do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.enviado_em Data e hora em que o agente enviou o segmento de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    segment.wrap_up_configuration Objeto que contém detalhes sobre a configuração de encerramento usada para o segmento de encerramento.

    Tipo de dados: objeto

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes Matriz de objetos, cada um representando um código de encerramento que o agente tem permissão para usar.

    Tipo de dados: matriz

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.allowed_codes.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.allowed_codes.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code Objeto que contém o código de encerramento a ser usado como padrão.

    Tipo de dados: objeto

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.default_code.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.default_code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.enable_codes Sinalizador que indica se o agente deve selecionar um código de encerramento.
    Valores válidos:
    • verdadeiro: o agente deve selecionar um código de encerramento.
    • falso: o agente não precisa selecionar um código de encerramento.

    Tipo de dados: booliano

    Padrão: falso
    segment_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    êxito Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano

    Solicitação de cURL

    Este exemplo recupera detalhes de um segmento de encerramento especificado.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/dgajbcef12345678defdbxef123435678" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Corpo da resposta.

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    Encerrar - GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    Recupera detalhes de um segmento de encerramento com base em um agente e interação especificados.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    URL padrão: /api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    agent_id Sys_id do agente atribuído à interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    interaction_id Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    segmento Objeto que contém dados sobre a interação e o segmento de encerramento.

    Tipo de dados: objeto

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segmento.agente Sys_id do agente atribuído à interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    segment.aguardando_confirmação Sinalizador que indica se o segmento de encerramento enviado pelo agente está aguardando a confirmação de que foi processado pelo sistema CCaaS externo.
    Valores válidos:
    • verdadeiro: o segmento de encerramento está aguardando confirmação.
    • falso: o segmento de encerramento foi processado pelo sistema externo.

    Tipo de dados: booliano
    segmento.confirmado_em Data e hora em que o segmento de encerramento enviado é processado no sistema CCaaS externo.

    Tipo de dados: cadeia de caracteres
    segmento.externo Sinalizador que indica se o segmento de interação é de um sistema externo.
    Valores válidos:
    • verdadeiro: o segmento de interação é de um sistema externo.
    • falso: o segmento de interação é interno.

    Tipo de dados: booliano

    Padrão: falso
    segment.interaction Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    segmento.aberto_em A data e hora de início do período de encerramento de acordo com o sistema externo.

    Tipo de dados: cadeia de caracteres
    segment.segmentado Sinalizador que indica se o encerramento é segmentado.
    Valores válidos:
    • verdadeiro: o encerramento é segmentado em várias partes.
    • falso: o encerramento é um segmento completo.

    Tipo de dados: booliano

    Padrão: falso
    segment.segment_id Sys_id do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segment.segment_table Nome da tabela que contém o segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.estado Estado do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.enviado_em Data e hora em que o agente enviou o segmento de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    segment.wrap_up_configuration Objeto que contém detalhes sobre a configuração de encerramento usada para o segmento de encerramento.

    Tipo de dados: objeto

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes Matriz de objetos, cada um representando um código de encerramento que o agente tem permissão para usar.

    Tipo de dados: matriz

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.allowed_codes.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.allowed_codes.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code Objeto que contém o código de encerramento a ser usado como padrão.

    Tipo de dados: objeto

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.default_code.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.default_code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.enable_codes Sinalizador que indica se o agente deve selecionar um código de encerramento.
    Valores válidos:
    • verdadeiro: o agente deve selecionar um código de encerramento.
    • falso: o agente não precisa selecionar um código de encerramento.

    Tipo de dados: booliano

    Padrão: falso
    segment_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    êxito Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano

    Solicitação de cURL

    Este exemplo recupera detalhes de um segmento de encerramento com base em um agente e interação especificados.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/123412345678567890ab90abcdefcdef/interaction/213412345678567890ab90abcdefcdef" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Corpo da resposta.

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    Encerrar - POST /now/wrapup/code

    Cria ou atualiza códigos de encerramento.

    Os códigos de encerramento são criados na tabela Código de encerramento de interação [interaction_wrap_up_code].

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/code

    URL padrão: /api/now/wrapup/code

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    códigos Obrigatório. Matriz de objetos, cada um representando um código de encerramento.

    Tipo de dados: matriz

    "codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "translations": [Array]
   }
]
    códigos.ativo Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    códigos.código Obrigatório. Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    códigos.descrição Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    códigos.traduções Matriz de objetos, cada um representando uma tradução do código de encerramento.

    Tipo de dados: matriz

    "translations": [
   {    
      "code": "Abrechnungsproblem",
      "description": "Ein code für Abrechnungsprobleme",
      "language": "de"
   }
]
    códigos.traduções.código Uma tradução do rótulo do código de encerramento (codes.code). Obrigatório se estiver usando o parâmetro codes.translations.

    Tipo de dados: cadeia de caracteres
    códigos.traduções.descrição Uma tradução da descrição do código de encerramento (codes.description). Obrigatório se estiver usando o parâmetro codes.translations e um valor tiver sido fornecido para codes.description.

    Tipo de dados: cadeia de caracteres
    códigos.traduções.idioma Código de duas letras para o idioma usado na tradução. Obrigatório se estiver usando o parâmetro codes.translations.

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    207 Bem-sucedido. Alguns códigos de encerramento foram criados com sucesso. Ocorreram erros de validação ao criar outros.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém informações sobre a solicitação de API e os códigos de encerramento criados.

    Tipo de dados: objeto

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    resultado.mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    resultado.result_map Objeto que contém uma matriz de códigos de encerramento criados.

    Tipo de dados: objeto

    "result_map": {
   "created_wrap_up_codes": [Array]
}
    result.result_map.created_wrap_up_codes Matriz de objetos, cada um representando um código de encerramento criado.

    Tipo de dados: matriz

    "created_wrap_up_codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "external": Boolean,
      "sys_id": "String",
      "translated_code": "String",
      "translated_description": "String"
   }
]
    result.result_map.created_wrap_up_codes.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    result.result_map.created_wrap_up_codes.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.created_wrap_up_codes.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.created_wrap_up_codes.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    result.result_map.created_wrap_up_codes.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    result.result_map.created_wrap_up_codes.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    result.result_map.created_wrap_up_codes.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    resultado.sucesso Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano

    Solicitação de cURL

    Este exemplo cria um código de encerramento para problemas de cobrança com uma tradução em alemão.

    curl "https://instance.service-now.com/api/now/v1/wrapup/code" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"codes\": [
    {
      \"code\": \"Billing Issue\",
      \"description\": \"A code for billing issues\",
      \"translations\": [
        {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\",
          \"description\": \"Ein code für Abrechnungsprobleme\"
        }
      ]
    }
  ]
}" \
--user 'username':'password'

    Corpo da resposta.

    {
  "result": {
    "message": "All wrap up codes created successfully.",
    "result_map": {
      "created_wrap_up_codes": [
        {
          "code": "Billing Issue",
          "description": "A code for billing issues",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": "Ein code für Abrechnungsprobleme"
        }
      ]
    },
    "success": true
  }
}

    Encerrar - POST /now/wrapup/segment/create

    Abre um segmento de encerramento para uma interação.

    Os encerramentos são criados na tabela Segmento de encerramento de interação [interaction_wrap_up_segment].

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/segment/create

    URL padrão: /api/now/wrapup/segment/create

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    agent_sys_id Obrigatório. Sys_id do agente atribuído à interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    configuração Objeto que contém o código e os detalhes da duração de um encerramento externo. Obrigatório se external for verdadeiro.

    Tipo de dados: objeto

    "configuration": {  
   "allowed_codes": [Array], 
   "default_code": "String", 
   "duration": "String", 
   "enable_codes": Boolean  
}
    configuração.códigos_permitidos Matriz de objetos, cada um representando um código de encerramento que o agente tem permissão para usar. Obrigatório se external e configuration.enable_codes forem verdadeiros.

    Tipo de dados: matriz

    "allowed_codes": [ 
   { 
      "code": "String", 
      "translation": {Object}  
   } 
]
    configuração.códigos_permitidos.código Rótulo do código de encerramento. Necessário se estiver usando o parâmetro configuration.allowed_codes.

    Tipo de dados: cadeia de caracteres
    configuration.allowed_codes.translation Uma tradução do código de encerramento.

    Tipo de dados: objeto

    "translation": {  
   "code": "String",
   "language": "String"  
}
    configuration.allowed_codes.translation.code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    configuration.allowed_codes.translation.language Código de duas letras para o idioma usado na tradução.

    Tipo de dados: cadeia de caracteres
    configuração.código_padrão Rótulo do código de encerramento a ser usado como padrão. Obrigatório se external e configuration.enable_codes forem verdadeiros.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]

    Campo: Código
    configuração.duração Duração máxima permitida do encerramento.

    Tipo de dados: cadeia de caracteres

    Unidade: segundos

    Padrão: cadeia de caracteres vazia (sem limite de tempo).
    configuração.enable_codes Sinalizador que indica se o agente deve selecionar um código de encerramento.
    Valores válidos:
    • verdadeiro: o agente deve selecionar um código de encerramento.
    • falso: o agente não precisa selecionar um código de encerramento.

    Tipo de dados: booliano

    Padrão: falso
    externo Sinalizador que indica se o segmento de interação é de um sistema externo.
    Valores válidos:
    • verdadeiro: o segmento de interação é de um sistema externo.
    • falso: o segmento de interação é interno.

    Tipo de dados: booliano

    Padrão: falso
    external_segment_id Identificador que representa o segmento de interação no sistema externo. Obrigatório se external for verdadeiro.

    Tipo de dados: cadeia de caracteres
    interação_sys_id Obrigatório. Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    opened_on A data e hora de início do período de encerramento de acordo com o sistema externo. Necessário se estiver usando o parâmetro configuration.duration.

    Tipo de dados: cadeia de caracteres
    segmentado Sinalizador que indica se o encerramento é segmentado.
    Valores válidos:
    • verdadeiro: o encerramento é segmentado em várias partes.
    • falso: o encerramento é um segmento completo.

    Tipo de dados: booliano

    Padrão: falso
    segment_id Sys_id do segmento de interação. Obrigatório se external e segmented forem verdadeiros.
    Nota:
    Você deve implementar o ponto de extensão com script InteractionSegment para criar e recuperar registros de segmento na tabela escolhida ou usar a implementação OpenFrame para criar e recuperar registros de segmento na tabela Log de telefone [sn_openframe_phone_log].

    Tipo de dados: cadeia de caracteres
    segment_table Nome da tabela que contém o segmento de interação. Obrigatório se external e segmented forem verdadeiros.

    Tipo de dados: cadeia de caracteres
    wrap_up_configuration_sys_id Sys_id da configuração de encerramento a ser usada. Obrigatório se external for falso.

    Tipo de dados: cadeia de caracteres

    Tabela: configuração de encerramento de interação [interaction_wrap_up_configuration]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    segmento Objeto que contém dados sobre a interação e o segmento de encerramento.

    Tipo de dados: objeto

    "segment": {
  "agent": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segmento.agente Sys_id do agente atribuído ao segmento de interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    segmento.externo Sinalizador que indica se o segmento de interação é de um sistema externo.
    Valores válidos:
    • verdadeiro: o segmento de interação é de um sistema externo.
    • falso: o segmento de interação é interno.

    Tipo de dados: booliano

    Padrão: falso
    segment.interaction Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    segmento.aberto_em A data e hora de início do período de encerramento de acordo com o sistema externo.

    Tipo de dados: cadeia de caracteres
    segment.segmentado Sinalizador que indica se o encerramento é segmentado.
    Valores válidos:
    • verdadeiro: o encerramento é segmentado em várias partes.
    • falso: o encerramento é um segmento completo.

    Tipo de dados: booliano

    Padrão: falso
    segment.segment_id Sys_id do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segment.segment_table Nome da tabela que contém o segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.estado Estado do segmento de interação. Os segmentos de interação que a API de encerramento cria com sucesso estão no estado aberto.

    Tipo de dados: cadeia de caracteres
    segment.sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    segment.wrap_up_configuration Objeto que contém detalhes sobre a configuração de encerramento usada para o segmento de encerramento.

    Tipo de dados: objeto

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes Matriz de objetos, cada um representando um código de encerramento que o agente tem permissão para usar.

    Tipo de dados: matriz

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.allowed_codes.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.allowed_codes.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code Objeto que contém o código de encerramento a ser usado como padrão.

    Tipo de dados: objeto

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.default_code.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.default_code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.enable_codes Sinalizador que indica se o agente deve selecionar um código de encerramento.
    Valores válidos:
    • verdadeiro: o agente deve selecionar um código de encerramento.
    • falso: o agente não precisa selecionar um código de encerramento.

    Tipo de dados: booliano

    Padrão: falso
    êxito Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano
    sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]

    Solicitação de cURL

    Este exemplo abre um segmento de encerramento para uma interação.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"agent_sys_id\": \"123412345678567890ab90abcdefcdef\",
  \"interaction_sys_id\": \"213412345678567890ab90abcdefcdef\",
  \"external\": \"true\",
  \"segmented\": \"true\",
  \"segment_table\": \"sn_openframe_phone_log\",
  \"segment_id\": \"dgajbcef12345678defdbxef123435678\",
  \"external_segment_id\": \"PL_402548\",
  \"configuration\": {
    \"enable_codes\": true,
    \"allowed_codes\": [
      {
        \"code\": \"Billing Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\"
        }
      },
      {
        \"code\": \"Store Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Einkaufsproblem\"
        }
      }
    ],
    \"default_code\": \"Billing Issue\",
    \"duration\": \"30\"
  },
  \"opened_on\": \"2024-09-16 17:52:01\"
}" \
--user 'username':'password'

    Corpo da resposta.

    {
  "success": true,
  "message": "Open wrap-up segment successfully created.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "98769876543254321fed1fedcba0cba0",
    "opened_on": "2024-09-16 17:52:01"
  }
}

    Encerrar - PUT /now/wrapup/segment/update

    Atualiza e fecha um segmento de encerramento de uma interação.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/wrapup/segment/update

    URL padrão: /api/now/wrapup/segment/update

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    agent_sys_id Sys_id do agente atribuído à interação. Necessário junto com interaction_sys_id se nem segment_sys_id nem external_segment_id forem fornecidos.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    external_segment_id Identificador que representa o segmento de interação no sistema externo. Usado para identificar o segmento de encerramento a ser atualizado se segment_sys_id não for fornecido.
    interação_sys_id Sys_id da interação. Necessário junto com agent_sys_id se nem segment_sys_id nem external_segment_id forem fornecidos.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interaction]
    segment_sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    confirmado_em A data e hora de término do período de encerramento de acordo com o sistema externo.

    Tipo de dados: cadeia de caracteres
    anotações Anotações adicionais adicionadas ao encerramento pelo agente.

    Tipo de dados: cadeia de caracteres
    wrap_up_code Rótulo do código de encerramento selecionado pelo agente. Se o agente não selecionar um código, o código padrão configurado será usado.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]

    Campo: Código

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 36. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    mensagem Mensagem que descreve o resultado da solicitação de API.

    Tipo de dados: cadeia de caracteres
    segmento Objeto que contém dados sobre a interação e o segmento de encerramento.

    Tipo de dados: objeto

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "code": {Object},
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "notes": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segmento.agente Sys_id do agente atribuído à interação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    segment.aguardando_confirmação Sinalizador que indica se o segmento de encerramento enviado pelo agente está aguardando a confirmação de que foi processado pelo sistema CCaaS externo.
    Valores válidos:
    • verdadeiro: o segmento de encerramento está aguardando confirmação.
    • falso: o segmento de encerramento foi processado pelo sistema externo.

    Tipo de dados: booliano
    segmento.código Objeto que contém o código de encerramento selecionado pelo agente.

    Tipo de dados: objeto

    "code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segmento.código.código Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segmento.código.descrição Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segmento.código.externo Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segmento.confirmado_em Data e hora em que o segmento de encerramento enviado é processado no sistema CCaaS externo.

    Tipo de dados: cadeia de caracteres
    segmento.externo Sinalizador que indica se o segmento de interação é de um sistema externo.
    Valores válidos:
    • verdadeiro: o segmento de interação é de um sistema externo.
    • falso: o segmento de interação é interno.

    Tipo de dados: booliano

    Padrão: falso
    segment.interaction Sys_id da interação.

    Tipo de dados: cadeia de caracteres

    Tabela: interação [interação]
    segmento.anotações Anotações adicionais adicionadas ao encerramento pelo agente.

    Tipo de dados: cadeia de caracteres
    segmento.aberto_em A data e hora de início do período de encerramento de acordo com o sistema externo.

    Tipo de dados: cadeia de caracteres
    segment.segmentado Sinalizador que indica se o encerramento é segmentado.
    Valores válidos:
    • verdadeiro: o encerramento é segmentado em várias partes.
    • falso: o encerramento é um segmento completo.

    Tipo de dados: booliano

    Padrão: falso
    segment.segment_id Sys_id do segmento de interação.

    Tipo de dados: cadeia de caracteres
    segment.segment_table Nome da tabela que contém o segmento de interação.

    Tipo de dados: cadeia de caracteres
    segmento.estado Estado do segmento de interação. Os segmentos de interação que este endpoint atualiza com sucesso estão no estado fechado.

    Tipo de dados: cadeia de caracteres
    segmento.enviado_em Data e hora em que o agente enviou o segmento de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]
    segment.wrap_up_configuration Objeto que contém detalhes sobre a configuração de encerramento usada para o segmento de encerramento.

    Tipo de dados: objeto

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes Matriz de objetos, cada um representando um código de encerramento que o agente tem permissão para usar.

    Tipo de dados: matriz

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.allowed_codes.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.allowed_codes.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.allowed_codes.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code Objeto que contém o código de encerramento a ser usado como padrão.

    Tipo de dados: objeto

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active Sinalizador que indica se o código de encerramento está ativo.
    Valores válidos:
    • verdadeiro: o código de encerramento está ativo.
    • falso: o código de encerramento não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    segment.wrap_up_configuration.default_code.code Rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.description Descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.external Sinalizador que indica se o código de encerramento é de um sistema externo.
    Valores válidos:
    • verdadeiro: o código de encerramento é de um sistema externo.
    • falso: o código de encerramento é interno.

    Tipo de dados: booliano
    segment.wrap_up_configuration.default_code.sys_id Sys_id do código de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: código de encerramento de interação [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code Uma tradução do rótulo do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.default_code.translated_description Uma tradução da descrição do código de encerramento.

    Tipo de dados: cadeia de caracteres
    segment.wrap_up_configuration.enable_codes Sinalizador que indica se o agente deve selecionar um código de encerramento.
    Valores válidos:
    • verdadeiro: o agente deve selecionar um código de encerramento.
    • falso: o agente não precisa selecionar um código de encerramento.

    Tipo de dados: booliano

    Padrão: falso
    êxito Sinalizador que indica se a solicitação de API foi processada com sucesso.
    Valores válidos:
    • verdadeiro: a solicitação de API foi bem-sucedida.
    • falso: falha na solicitação de API.

    Tipo de dados: booliano
    sys_id Sys_id do segmento de encerramento.

    Tipo de dados: cadeia de caracteres

    Tabela: Segmento de encerramento de interação [interaction_wrap_up_segment]

    Solicitação de cURL

    Este exemplo atualiza e fecha um segmento de encerramento de uma interação.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/update?segment_sys_id=98769876543254321fed1fedcba0cba0&agent_sys_id=123412345678567890ab90abcdefcdef&interaction_sys_id=213412345678567890ab90abcdefcde" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"wrap_up_code\": \"Billing Issue\",
  \"notes\": \"Customer's credit card expired. Had to switch to another one.\",
  \"confirmed_on\": \"2024-09-16 18:52:01\"
}" \
--user 'username':'password'

    Corpo da resposta.

    {
  "success": true,
  "message": "Wrap-up segment updated successfully.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "code": {
      "code": "Billing Issue",
      "description": "",
      "active": true,
      "external": true,
      "sys_id": "49c27b679f201210c89656effa0a1cd7",
      "translated_code": "Abrechnungsproblem",
      "translated_description": ""
    },
    "notes": "Customer's credit card expired. Had to switch to another one.",
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}