API de contato

Versão de lançamento: Washingtondc

Atualizado 1 de fev. de 2024

27 min. de leitura

A API de contato fornece endpoints que permitem recuperar e atualizar Customer Service Management (CSM) registros de contato.

Além disso, você pode gerar novos registros de perfil de mídia social ao criar um contato.

A API de contato requer o plug-in Atendimento ao cliente (com.sn_customerservice) e é fornecida no namespace now.

Os usuários precisam da função csm_ws_integration para obter acesso completo à API.

Contato - GET /now/contact

Recupera um conjunto especificado de Customer Service Management (CSM) contatos.

Formato de URL

URL com controle de versões: /api/now/{api_version}/contact

URL padrão: /api/now/contact

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`. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Na resposta, o parâmetro booliano hasMore é retornado. Indica se há mais registros a serem retornados que atendam aos critérios de filtro. Tipo de dados: número Padrão: 10
sysparm_offset	Índice de registro inicial para o qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente paginar todos os registros disponíveis, use `sysparm_offset=sysparm_offset+sysparm_limit`, até chegar ao fim de todos os registros. Não passe um número negativo no parâmetro sysparm_offset. Tipo de dados: número Padrão: 0
sysparm_query	Consulta codificada usada para filtrar o conjunto de resultados. Por exemplo: `sysparm_query=caller_id=javascript:gs.getUserID()^active=true` A consulta codificada oferece suporte à ordenação por. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query. Por exemplo, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filtra todos os registros ativos e ordena os resultados em ordem crescente por número primeiro e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar nenhuma linha em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço Web. Tipo de dados: cadeia de caracteres

Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
Nenhum

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

Códigos de status

Os códigos de status a seguir 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 da REST API.

Tabela 6. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.
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)

O endpoint pode retornar os seguintes elementos JSON ou XML no corpo da resposta. Além da lista de elementos definida abaixo (que define os elementos em um sistema de base), o endpoint também retorna todos os campos personalizados adicionados à tabela Contato [customer_contact]. Para obter informações adicionais sobre esses elementos, consulte a definição de tabela específica [Definição do Sistema > Tabelas].


Elemento	Descrição
conta	Sys_id do registro de conta ao qual o contato está associado; Tabela Conta [customer_account]. Tipo de dados: cadeia de caracteres
ativo	Sinalizador que indica se o contato está ativo no sistema. Valores possíveis: verdadeiro: o contato está ativo falso: o contato está inativo Tipo de dados: booliano Padrão: verdadeiro
agent_status	Status do agente. Valores possíveis: Sem trabalho No intervalo Na rota No site Tipo de dados: cadeia de caracteres Tamanho máximo: 40
construção	Sys_id do registro que descreve o prédio no qual o contato reside; Tabela Edifício [cmn_building]. Tipo de dados: cadeia de caracteres
calendar_integration	Aplicativo de calendário que o contato usa. 1: Outlook Tipo de dados: número (inteiro) Padrão: 1
cidade	Cidade em que o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado; Tabela Empresa [core_company]. Tipo de dados: cadeia de caracteres
centro_custo	Sys_id do centro de custos associado ao contato; Tabela Centro de custos [cmn_cost_center]. Tipo de dados: cadeia de caracteres
país	Código do país no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
data_formato	Formato no qual exibir datas para contatos. Valores válidos: dd/mm/aaaa dd-mm-aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Localizado na tabela Lista de menus [sys_perspective]. Tipo de dados: cadeia de caracteres
departamento	Sys_id do departamento associado ao contato. Localizado na tabela Departamento [cmn_department]. Tipo de dados: cadeia de caracteres
edu_status	Status educacional do contato associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: corpo técnico
e-mail	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
employee_number	Número do funcionário de contato. Tipo de dados: cadeia de caracteres
enable_multifactor_authn	Sinalizador que indica se a autorização multifator é necessária para o contato fazer login no portal de serviços. Valores possíveis: verdadeiro: autorização multifator habilitada falso: autorização multifator desabilitada Tipo de dados: booliano Padrão: falso
falha_attempts	Número de tentativas de login com falha. Tipo de dados: número (inteiro)
first_name	Nome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
gênero	Sexo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
geolocalização_rastreada	Sinalizador que indica se o local do contato é obtido por meio de rastreamento geográfico. Valores possíveis: verdadeiro: local de contato obtido por meio de geotracking falso: local do contato não obtido por meio de geotracking Tipo de dados: booliano Valor padrão: falso
home_phone	Número de telefone residencial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
internal_integration_user	Sinalizador que indica se o contato é um usuário de integração interna. Valores possíveis: verdadeiro: usuário de integração interna falso: outro tipo de usuário Tipo de dados: booliano Padrão: falso
introdução	Introdução Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login	Data em que o contato fez login no sistema pela última vez. Tipo de dados: cadeia de caracteres (data)
last_login_device	Dispositivo que o consumidor usou na última vez em que fez login no sistema. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login_time	Data e hora em que o contato fez login no sistema. Tipo de dados: cadeia de caracteres (data/hora)
last_name	Sobrenome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
última_posição_atualizar	Data e hora em que a última posição foi atualizada. Tipo de dados: cadeia de caracteres (data/hora)
latitude	Coordenada de latitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema; Tabela Servidor LDAP [ldap_server_config]. Tipo de dados: cadeia de caracteres
local	Sys_id do registro que descreve o local do contato; Tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
bloqueado_out	Sinalizador que indica se o contato está bloqueado. Valores possíveis: verdadeiro: contato bloqueado falso: contato não bloqueado Tipo de dados: booliano Padrão: falso
longitude	Coordenada de longitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato; Tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres
middle_name	Nome do meio do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 50
mobile_phone	Número de telefone celular para contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
nome	Nome completo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 151
notificação	Indica se o contato deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: número (inteiro) Padrão: 2
on_schedule	Indica a pontualidade da equipe de serviço enviada. Valores válidos: À frente: à frente da programação. atrás_less30: atrasado, mas menos de 30 minutos. atrás_30to60: atraso entre 30 e 60 minutos. atrás_more60: atrasado mais de 60 minutos. on_time: na programação. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
telefone	Número de telefone comercial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
foto	Imagem de foto do contato. Tipo de dados: imagem
preferred_language	Código do país do idioma principal do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
programação	Sys_id do registro que descreve a programação de trabalho do contato associado; Tabela Programação [cmn_schedule]. Tipo de dados: cadeia de caracteres
origem	Origem do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
state	Estado no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
rua	Endereço do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
sys_class_name	Tabela que contém o registro do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 80
sys_created_by	Usuário que criou originalmente o registro de contato associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_created_on	Data e hora em que o contato associado foi criado originalmente. Tipo de dados: cadeia de caracteres (data/hora)
sys_domain	ServiceNow domínio de instância do registro de contato associado. Tipo de dados: cadeia de caracteres
sys_domain_path	Caminho do domínio de registro de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 Padrão: / (global)
sys_id	Identificador exclusivo do registro de contato associado. Tipo de dados: cadeia de caracteres
sys_mod_count	Número de vezes que o registro de contato associado foi modificado. Tipo de dados: número (inteiro)
sys_tags	Marcadores do sistema. Tipo de dados: cadeia de caracteres
sys_updated_by	Usuário que atualizou pela última vez as informações de contato associadas. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_updated_on	Data e hora em que as informações de contato associadas foram atualizadas. Tipo de dados: cadeia de caracteres (data/hora)
formato_hora	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 horas) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema)
política_planilha_hora	Sys_id do registro que contém a política de planilha de horas para o contato associado; Tabela Política de planilha de horas [time_sheet_policy]. Tipo de dados: cadeia de caracteres
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
título	Entre em contato com o cargo comercial, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: cadeia de caracteres Tamanho máximo: 60
user_name	ID do usuário do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
VIP	Sinalizador que indica se o contato associado tem status VIP. Valores possíveis: verdadeiro: VIP falso: não VIP Tipo de dados: booliano Padrão: falso
web_service_access_only	Sinalizador que indica se o contato só pode acessar serviços pela Web. Valores possíveis: verdadeiro: somente acesso à Web falso: acesso por meio de todos os métodos disponíveis Tipo de dados: booliano Padrão: falso
zip	CEP do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40

Solicitação de cURL

curl "https://instance.servicenow.com/api/now/contact?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "country": "",
      "calendar_integration": "1",
      "last_position_update": "",
      "last_login_time": "2018-03-10 21:48:11",
      "last_login_device": "",
      "source": "",
      "sys_updated_on": "2019-01-03 05:49:34",
      "building": "",
      "web_service_access_only": "false",
      "notification": "2",
      "sys_updated_by": "system",
      "enable_multifactor_authn": "false",
      "sys_created_on": "2018-03-04 20:26:32",
      "sys_domain": "global",
      "agent_status": "",
      "state": "",
      "vip": "false",
      "sys_created_by": "admin",
      "longitude": "",
      "zip": "",
      "home_phone": "",
      "time_format": "",
      "last_login": "",
      "default_perspective": "",
      "geolocation_tracked": "false",
      "active": "true",
      "time_sheet_policy": "",
      "sys_domain_path": "/",
      "phone": "+1 858 287 7834",
      "cost_center": "",
      "name": "George Warren",
      "employee_number": "",
      "gender": "",
      "city": "",
      "user_name": "george.warren",
      "failed_attempts": "",
      "edu_status": "",
      "latitude": "",
      "roles": "",
      "title": "Network Administrator",
      "sys_class_name": "customer_contact",
      "sys_id": "ddce70866f9331003b3c498f5d3ee417",
      "internal_integration_user": "false",
      "ldap_server": "",
      "mobile_phone": "+1 858 867 7857",
      "street": "",
      "company": "86837a386f0331003b3c498f5d3ee4ca",
      "department": "",
      "first_name": "George",
      "preferred_language": "",
      "introduction": "",
      "email": "geo.warren@mailinator.com",
      "manager": "",
      "locked_out": "false",
      "sys_mod_count": "3",
      "last_name": "Warren",
      "photo": "",
      "sys_tags": "",
      "middle_name": "",
      "time_zone": "",
      "schedule": "",
      "on_schedule": "",
      "date_format": "",
      "location": "25ab8e460a0a0bb300857304ff811af5",
      "account": "86837a386f0331003b3c498f5d3ee4ca"
    },
    {
      "country": "",
      "calendar_integration": "1",
      "last_position_update": "",
      "last_login_time": "2019-01-03 15:08:57",
      "last_login_device": "73.71.157.241",
      "source": "",
      "sys_updated_on": "2019-01-03 23:26:12",
      "building": "",
      "web_service_access_only": "false",
      "notification": "2",
      "sys_updated_by": "admin",
      "enable_multifactor_authn": "false",
      "sys_created_on": "2019-01-03 15:07:25",
      "sys_domain": "global",
      "agent_status": "",
      "state": "",
      "vip": "false",
      "sys_created_by": "carl.customer",
      "longitude": "",
      "zip": "",
      "home_phone": "",
      "time_format": "",
      "last_login": "",
      "default_perspective": "",
      "geolocation_tracked": "false",
      "active": "true",
      "time_sheet_policy": "",
      "sys_domain_path": "/",
      "phone": "+16692627777",
      "cost_center": "",
      "name": "Jane Contact",
      "employee_number": "",
      "gender": "",
      "city": "",
      "user_name": "Jane.Contact",
      "failed_attempts": "",
      "edu_status": "faculty",
      "latitude": "",
      "roles": "",
      "title": "",
      "sys_class_name": "customer_contact",
      "sys_id": "0a232a0013691200042ab3173244b075",
      "internal_integration_user": "false",
      "ldap_server": "",
      "mobile_phone": "",
      "street": "",
      "company": "86837a386f0331003b3c498f5d3ee4ca",
      "department": "",
      "first_name": "Jane",
      "preferred_language": "",
      "introduction": "",
      "email": "jane.contact@mailinator.com",
      "manager": "",
      "locked_out": "false",
      "sys_mod_count": "3",
      "last_name": "Contact",
      "photo": "",
      "sys_tags": "",
      "middle_name": "",
      "time_zone": "",
      "schedule": "",
      "on_schedule": "",
      "date_format": "",
      "location": "",
      "account": "86837a386f0331003b3c498f5d3ee4ca"
    }
  ]
}

Contato - GET /now/contact/{id}

Recupera o contato Customer Service Management (CSM) especificado.

Formato de URL

URL com controle de versões: /api/now/{api_version}/contact/{id}

URL padrão: /api/now/contact/{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`. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
id	Sys_id do contato a ser recuperado. Localizado na tabela Contato [customer_contact].

Tabela 8. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
Nenhum

Cabeçalhos

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

Códigos de status

Os códigos de status a seguir 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 da REST API.

Tabela 12. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Indica que a solicitação é inválida. Pode ser devido a um dos seguintes motivos: O caso solicitado não existe. O usuário não tem acesso ao caso.
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)


Elemento	Descrição
conta	Sys_id do registro de conta ao qual o contato está associado; Tabela Conta [customer_account]. Tipo de dados: cadeia de caracteres
ativo	Sinalizador que indica se o contato está ativo no sistema. Valores possíveis: verdadeiro: o contato está ativo falso: o contato está inativo Tipo de dados: booliano Padrão: verdadeiro
agent_status	Status do agente. Valores possíveis: Sem trabalho No intervalo Na rota No site Tipo de dados: cadeia de caracteres Tamanho máximo: 40
construção	Sys_id do registro que descreve o prédio no qual o contato reside; Tabela Edifício [cmn_building]. Tipo de dados: cadeia de caracteres
calendar_integration	Aplicativo de calendário que o contato usa. 1: Outlook Tipo de dados: número (inteiro) Padrão: 1
cidade	Cidade em que o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado; Tabela Empresa [core_company]. Tipo de dados: cadeia de caracteres
centro_custo	Sys_id do centro de custos associado ao contato; Tabela Centro de custos [cmn_cost_center]. Tipo de dados: cadeia de caracteres
país	Código do país no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
data_formato	Formato no qual exibir datas para contatos. Valores válidos: dd/mm/aaaa dd-mm-aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Localizado na tabela Lista de menus [sys_perspective]. Tipo de dados: cadeia de caracteres
departamento	Sys_id do departamento associado ao contato. Localizado na tabela Departamento [cmn_department]. Tipo de dados: cadeia de caracteres
edu_status	Status educacional do contato associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: corpo técnico
e-mail	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
employee_number	Número do funcionário de contato. Tipo de dados: cadeia de caracteres
enable_multifactor_authn	Sinalizador que indica se a autorização multifator é necessária para o contato fazer login no portal de serviços. Valores possíveis: verdadeiro: autorização multifator habilitada falso: autorização multifator desabilitada Tipo de dados: booliano Padrão: falso
falha_attempts	Número de tentativas de login com falha. Tipo de dados: número (inteiro)
first_name	Nome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
gênero	Sexo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
geolocalização_rastreada	Sinalizador que indica se o local do contato é obtido por meio de rastreamento geográfico. Valores possíveis: verdadeiro: local de contato obtido por meio de geotracking falso: local do contato não obtido por meio de geotracking Tipo de dados: booliano Valor padrão: falso
home_phone	Número de telefone residencial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
internal_integration_user	Sinalizador que indica se o contato é um usuário de integração interna. Valores possíveis: verdadeiro: usuário de integração interna falso: outro tipo de usuário Tipo de dados: booliano Padrão: falso
introdução	Introdução Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login	Data em que o contato fez login no sistema pela última vez. Tipo de dados: cadeia de caracteres (data)
last_login_device	Dispositivo que o consumidor usou na última vez em que fez login no sistema. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login_time	Data e hora em que o contato fez login no sistema. Tipo de dados: cadeia de caracteres (data/hora)
last_name	Sobrenome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
última_posição_atualizar	Data e hora em que a última posição foi atualizada. Tipo de dados: cadeia de caracteres (data/hora)
latitude	Coordenada de latitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema; Tabela Servidor LDAP [ldap_server_config]. Tipo de dados: cadeia de caracteres
local	Sys_id do registro que descreve o local do contato; Tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
bloqueado_out	Sinalizador que indica se o contato está bloqueado. Valores possíveis: verdadeiro: contato bloqueado falso: contato não bloqueado Tipo de dados: booliano Padrão: falso
longitude	Coordenada de longitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato; Tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres
middle_name	Nome do meio do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 50
mobile_phone	Número de telefone celular para contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
nome	Nome completo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 151
notificação	Indica se o contato deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: número (inteiro) Padrão: 2
on_schedule	Indica a pontualidade da equipe de serviço enviada. Valores válidos: À frente: à frente da programação. atrás_less30: atrasado, mas menos de 30 minutos. atrás_30to60: atraso entre 30 e 60 minutos. atrás_more60: atrasado mais de 60 minutos. on_time: na programação. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
telefone	Número de telefone comercial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
foto	Imagem de foto do contato. Tipo de dados: imagem
preferred_language	Código do país do idioma principal do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
programação	Sys_id do registro que descreve a programação de trabalho do contato associado; Tabela Programação [cmn_schedule]. Tipo de dados: cadeia de caracteres
origem	Origem do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
state	Estado no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
rua	Endereço do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
sys_class_name	Tabela que contém o registro do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 80
sys_created_by	Usuário que criou originalmente o registro de contato associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_created_on	Data e hora em que o contato associado foi criado originalmente. Tipo de dados: cadeia de caracteres (data/hora)
sys_domain	ServiceNow domínio de instância do registro de contato associado. Tipo de dados: cadeia de caracteres
sys_domain_path	Caminho do domínio de registro de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 Padrão: / (global)
sys_id	Identificador exclusivo do registro de contato associado. Tipo de dados: cadeia de caracteres
sys_mod_count	Número de vezes que o registro de contato associado foi modificado. Tipo de dados: número (inteiro)
sys_updated_by	Usuário que atualizou pela última vez as informações de contato associadas. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_updated_on	Data e hora em que as informações de contato associadas foram atualizadas. Tipo de dados: cadeia de caracteres (data/hora)
formato_hora	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 horas) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema)
política_planilha_hora	Sys_id do registro que contém a política de planilha de horas para o contato associado; Tabela Política de planilha de horas [time_sheet_policy]. Tipo de dados: cadeia de caracteres
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
título	Entre em contato com o cargo comercial, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: cadeia de caracteres Tamanho máximo: 60
user_name	ID do usuário do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
VIP	Sinalizador que indica se o contato associado tem status VIP. Valores possíveis: verdadeiro: VIP falso: não VIP Tipo de dados: booliano Padrão: falso
web_service_access_only	Sinalizador que indica se o contato só pode acessar serviços pela Web. Valores possíveis: verdadeiro: somente acesso à Web falso: acesso por meio de todos os métodos disponíveis Tipo de dados: booliano Padrão: falso
zip	CEP do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40

Solicitação de cURL

curl "https://instance.servicenow.com/api/now/contact/ddce70866f9331003b3c498f5d3ee417 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "country": "",
    "calendar_integration": "1",
    "last_position_update": "",
    "last_login_time": "2018-03-10 21:48:11",
    "last_login_device": "",
    "source": "",
    "sys_updated_on": "2019-01-03 05:49:34",
    "building": "",
    "web_service_access_only": "false",
    "notification": "2",
    "sys_updated_by": "system",
    "enable_multifactor_authn": "false",
    "sys_created_on": "2018-03-04 20:26:32",
    "sys_domain": "global",
    "agent_status": "",
    "state": "",
    "vip": "false",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "",
    "home_phone": "",
    "time_format": "",
    "last_login": "",
    "default_perspective": "",
    "geolocation_tracked": "false",
    "active": "true",
    "time_sheet_policy": "",
    "sys_domain_path": "/",
    "phone": "+1 858 287 7834",
    "cost_center": "",
    "name": "George Warren",
    "employee_number": "",
    "gender": "",
    "city": "",
    "user_name": "george.warren",
    "failed_attempts": "",
    "edu_status": "",
    "latitude": "",
    "roles": "",
    "title": "Network Administrator",
    "sys_class_name": "customer_contact",
    "sys_id": "ddce70866f9331003b3c498f5d3ee417",
    "internal_integration_user": "false",
    "ldap_server": "",
    "mobile_phone": "+1 858 867 7857",
    "street": "",
    "company": "86837a386f0331003b3c498f5d3ee4ca",
    "department": "",
    "first_name": "George",
    "preferred_language": "",
    "introduction": "",
    "email": "geo.warren@mailinator.com",
    "manager": "",
    "locked_out": "false",
    "sys_mod_count": "3",
    "last_name": "Warren",
    "photo": "",
    "sys_tags": "",
    "middle_name": "",
    "time_zone": "",
    "schedule": "",
    "on_schedule": "",
    "date_format": "",
    "location": "25ab8e460a0a0bb300857304ff811af5",
    "account": "86837a386f0331003b3c498f5d3ee4ca"
  }
}

Contato - POST /now/contact

Cria um novo contato Customer Service Management (CSM).

Além disso, você pode criar um perfil de mídia social para o contato usando este endpoint. Para criar o perfil, você deve especificar os seguintes parâmetros no corpo da solicitação:

social_channel
social_handle
social_handle_url

Aviso:

Este endpoint não executa a validação de parâmetro, pois isso pode criar sobrecarga excessiva. Se um parâmetro de solicitação estiver digitado incorretamente, não for válido ou não seja compatível com o endpoint, ele será ignorado sem aviso.

Formato de URL

URL com controle de versões: /api/now/{api_version}/contact

URL padrão: /api/now/contact

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`. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
Elemento	Descrição
conta	Sys_id do registro de conta ao qual o contato está associado; Tabela Conta [customer_account]. Tipo de dados: cadeia de caracteres
ativo	Sinalizador que indica se o contato está ativo no sistema. Valores possíveis: verdadeiro: o contato está ativo falso: o contato está inativo Tipo de dados: booliano Padrão: verdadeiro
agent_status	Status do agente. Valores possíveis: Sem trabalho No intervalo Na rota No site Tipo de dados: cadeia de caracteres Tamanho máximo: 40
construção	Sys_id do registro que descreve o prédio no qual o contato reside; Tabela Edifício [cmn_building]. Tipo de dados: cadeia de caracteres
calendar_integration	Aplicativo de calendário que o contato usa. 1: Outlook Tipo de dados: número (inteiro) Padrão: 1
cidade	Cidade em que o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado; Tabela Empresa [core_company]. Tipo de dados: cadeia de caracteres
centro_custo	Sys_id do centro de custos associado ao contato; Tabela Centro de custos [cmn_cost_center]. Tipo de dados: cadeia de caracteres
país	Código do país no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
data_formato	Formato no qual exibir datas para contatos. Valores válidos: dd/mm/aaaa dd-mm-aaaa dd.mm.aaaa mm-dd-aaaa aaaa-mm-dd Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Localizado na tabela Lista de menus [sys_perspective]. Tipo de dados: cadeia de caracteres
departamento	Sys_id do departamento associado ao contato. Localizado na tabela Departamento [cmn_department]. Tipo de dados: cadeia de caracteres
edu_status	Status educacional do contato associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: corpo técnico
e-mail	Endereço de e-mail do contato. Tipo de dados: cadeia de caracteres
employee_number	Número do funcionário de contato. Tipo de dados: cadeia de caracteres
enable_multifactor_authn	Sinalizador que indica se a autorização multifator é necessária para o contato fazer login no portal de serviços. Valores possíveis: verdadeiro: autorização multifator habilitada falso: autorização multifator desabilitada Tipo de dados: booliano Padrão: falso
falha_attempts	Número de tentativas de login com falha. Tipo de dados: número (inteiro)
first_name	Nome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
gênero	Sexo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
geolocalização_rastreada	Sinalizador que indica se o local do contato é obtido por meio de rastreamento geográfico. Valores possíveis: verdadeiro: local de contato obtido por meio de geotracking falso: local do contato não obtido por meio de geotracking Tipo de dados: booliano Valor padrão: falso
home_phone	Número de telefone residencial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
internal_integration_user	Sinalizador que indica se o contato é um usuário de integração interna. Valores possíveis: verdadeiro: usuário de integração interna falso: outro tipo de usuário Tipo de dados: booliano Padrão: falso
introdução	Introdução Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login_device	Dispositivo que o consumidor usou na última vez em que fez login no sistema. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
last_login_time	Data e hora em que o contato fez login no sistema. Tipo de dados: cadeia de caracteres (data/hora)
last_name	Sobrenome do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
latitude	Coordenada de latitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema; Tabela Servidor LDAP [ldap_server_config]. Tipo de dados: cadeia de caracteres
local	Sys_id do registro que descreve o local do contato; Tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
bloqueado_out	Sinalizador que indica se o contato está bloqueado. Valores possíveis: verdadeiro: contato bloqueado falso: contato não bloqueado Tipo de dados: booliano Padrão: falso
longitude	Coordenada de longitude do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato; Tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres
middle_name	Nome do meio do contato. Tipo de dados: número (ponto flutuante) Tamanho máximo: 50
mobile_phone	Número de telefone celular para contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
nome	Nome completo do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 151
notificação	Indica se o contato deve receber notificações. Valores válidos: 1: Desabilitado 2: Habilitado Tipo de dados: número (inteiro) Padrão: 2
on_schedule	Indica a pontualidade da equipe de serviço enviada. Valores válidos: À frente: à frente da programação. atrás_less30: atrasado, mas menos de 30 minutos. atrás_30to60: atraso entre 30 e 60 minutos. atrás_more60: atrasado mais de 60 minutos. on_time: na programação. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
telefone	Número de telefone comercial de contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
foto	Imagem de foto do contato. Tipo de dados: imagem
preferred_language	Código do país do idioma principal do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
programação	Sys_id do registro que descreve a programação de trabalho do contato associado; Tabela Programação [cmn_schedule]. Tipo de dados: cadeia de caracteres
canal_social	Canal de mídia social ao qual o contato está associado, como Twitter, Facebook ou instagram. Tipo de dados: cadeia de caracteres
social_handle	Identificador do usuário no canal de mídia social. Tipo de dados: cadeia de caracteres
social_handle_url	URL para o perfil do canal social do contato. Tipo de dados: cadeia de caracteres
origem	Origem do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
state	Estado no qual o contato reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
rua	Endereço do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
formato_hora	Formato no qual exibir a hora. Valores válidos: hh.mm.ss a: hh.mm.ss (12 hora) hh:mm:ss a: hh:mm:ss (12 hora) HH.mm.ss: hh.mm.ss (24 horas) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema)
política_planilha_hora	Sys_id do registro que contém a política de planilha de horas para o contato associado; Tabela Política de planilha de horas [time_sheet_policy]. Tipo de dados: cadeia de caracteres
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
título	Entre em contato com o cargo comercial, como gerente, desenvolvedor de software ou prestador de serviço. Tipo de dados: cadeia de caracteres Tamanho máximo: 60
user_name	ID do usuário do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
VIP	Sinalizador que indica se o contato associado tem status VIP. Valores possíveis: verdadeiro: VIP falso: não VIP Tipo de dados: booliano Padrão: falso
web_service_access_only	Sinalizador que indica se o contato só pode acessar serviços pela Web. Valores possíveis: verdadeiro: somente acesso à Web falso: acesso por meio de todos os métodos disponíveis Tipo de dados: booliano Padrão: falso
zip	CEP do contato. Tipo de dados: cadeia de caracteres Tamanho máximo: 40

Cabeçalhos

Tabela 16. 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 17. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir 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 da REST API.

Tabela 18. Códigos de status
Código de status	Descrição
201	Novo registro de contato criado 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 de lógica no código do lado do servidor.

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


Elemento	Descrição
resultado	Sys_id do registro de contato recém-criado. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl -X POST "https://instance.servicenow.com/api/now/contact" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{ \
  "country": "USA", \
  "calendar_integration": "1", \
  "last_login_time": "2018-03-10 21:48:11", \
  "last_login_device": "tablet", \
  "building": "Cardinal West", \
  "web_service_access_only": "false", \
  "notification": "1", \
  "enable_multifactor_authn": "true", \
  "agent_status": "Travelling", \
  "state": "CA", \
  "vip": "false", \
  "longitude": "123.76", \
  "zip": "92069", \
  "home_phone": "(555)555-1234", \
  "time_format": "hh:mm:ss", \
  "geolocation_tracked": "false", \
  "active": "true", \
  "phone": "+1 858 287 7834", \
  "cost_center": "1345", \
  "name": "Dora Warren", \
  "employee_number": "546", \
  "gender": "Female", \
  "city": "Orlando", \
  "user_name": "dora.warren", \
  "failed_attempts": "2", \
  "edu_status": "current", \
  "latitude": "57.6", \
  "title": "Network Administrator", \
  "internal_integration_user": "false", \
  "ldap_server": "10.24.23.123", \
  "mobile_phone": "+1 858 867 7857", \
  "street": "123 Lagume", \
  "company": "86837a386f0331003b3c498f5d3ee4ca", \
  "department": "IT", \
  "first_name": "Dora", \
  "preferred_language": "Spanish", \
  "email": "dora.warren@mailinator.com", \
  "manager": "ddce70866f9331003b3c498f5d3ee417", \
  "locked_out": "false", \
  "last_name": "Warren", \
  "middle_name": "Dell", \
  "time_zone": "PST", \
  "schedule": "9-5", \
  "date_format": "MM/DD/YY", \
  "location": "25ab8e460a0a0bb300857304ff811af5", \
  "account": "86837a386f0331003b3c498f5d3ee4ca" \
}'
--user 'username':'password'

"result": "62fe1c97db76c3006b7a9646db961999"