API de mapeamento de agente

A API de mapeamento de agentes fornece um endpoint para mapear IDs de agente externo dos sistemas da Central de contato como serviço (CCaaS) para IDs de agente interno no Now Platform.

Esta API requer o plug-in External Agent Management Util Pack (sn_external_agent). Para chamar esta API, você deve ter a função interaction_agent.

Para obter mais informações sobre a integração com sistemas CCaaS, consulte Integrating with contact centers.

Mapeamento de agentes - PUT /sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

Mapeia um ID de agente externo de um sistema de Central de contato como serviço (CCaaS) para um ID de agente interno no Now Platform.

Chame este endpoint quando um agente fizer login ou logout do sistema CCaaS para atualizar seu status ativo. Este endpoint cria ou atualiza registros na tabela Mapeamento de agente externo [external_agent_mapping] com os seguintes dados:

• ID do agente de CCaaS externo
• Identidade de canal do provedor associada ao ID de entrada
• Status ativo do agente no sistema CCaaS
• Referência ao registro de usuário [sys_user] do agente

Formato da URL

URL padrão: /api/sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
agentId	Sys_id do agente interno. Tipo de dados: cadeia de caracteres Tabela: usuário [sys_user]
inboundId	ID de entrada do registro de identidade de canal do provedor para o sistema CCaaS. Tipo de dados: cadeia de caracteres Tabela: Identidade de canal do provedor [sys_cs_provider_application] Campo: ID de entrada

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o agente está conectado ao sistema CCaaS. Valores válidos: verdadeiro: o agente está conectado. falso: o agente está desconectado. Padrão: verdadeiro Tipo de dados: booliano
external_agent_id	Obrigatório. ID do agente externo do sistema CCaaS. 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 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a 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	OK. Registro de mapeamento de agente existente atualizado.
201	Criado. Novo registro de mapeamento de agente criado.
400	Solicitação incorreta. O ID do agente ou o ID de entrada fornecido na solicitação é inválido.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
resultado	Objeto de resultado que contém informações sobre a solicitação. Tipo de dados: objeto
result.mappingIds	Sys_ids de todos os registros criados ou atualizados na tabela Mapeamento de agente externo [external_agent_mapping]. Tipo de dados: matriz de cadeias de caracteres
resultado.mensagem	Mensagem explicando o resultado da solicitação. Tipo de dados: cadeia de caracteres
resultado.status	Status da solicitação. Valores possíveis: Êxito Falha Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mapeia um agente interno com sys_id da419c1fc312310015519f2974d3AE15 para o ID correspondente 12345 do sistema CCaaS externo.

curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"external_agent_id\":\"12345\"}" \ 
--user 'username':'password'

Corpo da resposta:

{
  "result": { 
    "message": "Agent Id mapping record inserted", 
    "status": "success", 
    "mappingIds": [ 
      "128b74fcc3931a50325a4ad9d00131c3" 
    ] 
  } 
}

Solicitação de cURL

Este exemplo define o parâmetro active como falso para indicar que o agente está desconectado do sistema CCaaS.

curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{"external_agent_id":"12345", "active":"false"}" \ 
--user 'username':'password'

Corpo da resposta:

{ 
  "result": { 
    "message": "Agent Id mapping record updated", 
    "status": "success", 
    "mappingIds": [ 
      "cea77cebebef9e10a341fc7acad0cdc2" 
    ] 
  } 
}