API de contato

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

27 min. de leitura

. Contato A API 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.

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

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

Contato - OBTENHA /now/contact

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

Formato de URL

URL com controle de versão: /api/now/api/contact

URL padrão: /api/now/contact

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 sysparm_offsetparâmetro para paginar a recuperação de registro. Na resposta, o parâmetro booliano hasMoreretornado. Indica se há mais registros a serem retornados que atendem aos critérios de filtro. Tipo de dados: Número Padrão: 10
sysparm_offset	Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de 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ê chamar este endpoint, sysparm_offsetdefinido como "0". Para simplesmente percorrer todos os registros disponíveis, use `se você não tiver certeza de que você está usando o sysparm_offset` até chegar ao final de todos os registros. Não passe um número negativo em sysparm_offsetparâmetro. Tipo de dados: Número Padrão: 0
sysparm_query	Consulta codificada usada para filtrar o conjunto de resultados. Por exemplo: `Se você estiver usando o nome de usuário, o nome de usuário será usado para o nome de usuário` A consulta codificada é compatível ordenar por . Para classificar respostas com base em determinados campos, use ORDERBY e. ORDERBYDESC cláusulas em sysparm_query. Por exemplo, `SYsparm_query` 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, como especificar 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 linhas em uma consulta inválida. Nota: . glide.invalid_query.returns_no_rowsa propriedade 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. Solicitar parâmetros do corpo (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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status
Código do 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 definem 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 da conta ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account]
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 Comprimento máximo: 40
construção	Sys_id do registro que descreve o edifício no qual o contato reside. Tipo de dados: Cadeia de caracteres Tabela: Edifício [cmn_building]
calendar_integration	Aplicação de calendário que o contato usa. 1: Outlook Tipo de dados: Número (inteiro) Padrão: 1
cidade	Cidade na qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Empresa [core_company]
cost_center	Sys_id do centro de custos associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Centro de custos [cmn_cost_center]
país	Código do país no qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
date_format	Formato no qual exibir datas para os 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 Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Tipo de dados: Cadeia de caracteres Lista de menus [sys_perspective]
departamento	Sys_id do departamento associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Departamento [cmn_department]
edu_status	Status educacional do contato associado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: corpo docente
e-mail	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
employee_number	Contato com o número do funcionário. Tipo de dados: Cadeia de caracteres
enable_multifator_authn	Sinalizador que indica se a autorização multifator é necessária para que o contato faça 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
failed_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 Comprimento máximo: 50
sexo	Sexo do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
geolocation_tracked	Sinalizador que indica se o local do contato é obtido por meio do rastreamento geográfico. Valores possíveis: Local do contato obtido por meio do rastreamento geográfico Local do contato não obtido por meio do rastreamento geográfico Tipo de dados: Booliano Valor padrão: falso
home_phone	Número de telefone residencial do contato. Tipo de dados: Cadeia de caracteres Comprimento 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 Comprimento máximo: 40
last_login	Data em que o contato fez login pela última vez no sistema. 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 Comprimento 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 Comprimento máximo: 50
last_position_update	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) Comprimento máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema. Tipo de dados: Cadeia de caracteres Tabela: Servidor LDAP [ldap_server_config]
local	Sys_id do registro que descreve o local do contato Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
locked_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) Comprimento máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
middle_name	Nome do meio do contato. Tipo de dados: Número (ponto flutuante) Comprimento máximo: 50
mobile_phone	Número de telefone celular do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do contato. Tipo de dados: Cadeia de caracteres Comprimento 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
_schedule	Indica a pontualidade da equipe de serviço expedida. Valores válidos: À frente: À frente da programação. Behind_less30: Atrasado, mas menos de 30 minutos. Behind_30to60: Atraso entre 30 e 60 minutos. Behind_more60: Atraso na programação de mais de 60 minutos. On_time: Na programação. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
telefone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
foto	Imagem da foto do contato. Tipo de dados: Cadeia de caracteres
preferred_language	Código do país do idioma primário do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
agendamento	Sys_id do registro que descreve a programação de trabalho do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Programação [cmn_schedule]
origem	Origem do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
estado	Estado em que o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
rua	Endereço do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sys_class_name	Tabela que contém o registro do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 80
sys_created_by	Usuário que criou originalmente o registro de contato associado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_created_on	Dados e hora em que o contato associado foi criado originalmente. Tipo de dados: Cadeia de caracteres (data/hora)
sys_domain	ServiceNow domínio da instância do registro de contato associado. Tipo de dados: Cadeia de caracteres
sys_domain_path	Caminho do domínio do registro de contato. Tipo de dados: Cadeia de caracteres Comprimento 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 as informações de contato associadas pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_updated_on	Dados e hora em que as informações de contato associadas foram atualizadas. Tipo de dados: Cadeia de caracteres (data/hora)
time_format	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 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_sheet_policy	Sys_id do registro que contém a política de planilha de horas do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Política de planilha de horas [time_sheet_policy]
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do contato, como Gerente, Desenvolvedor de software ou Prestador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
user_name	ID do usuário do contato. Tipo de dados: Cadeia de caracteres Comprimento 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: Acesse por todos os métodos disponíveis Tipo de dados: Booliano Padrão: falso
zip	CEP do contato. Tipo de dados: Cadeia de caracteres Comprimento 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 - OBTENHA /now/contact/

Recupera o especificado Customer Service Management (CSM) contato.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/contact/

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Contato [customer_contact]

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

Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Nenhum(a)

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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do 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 da conta ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account]
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 Comprimento máximo: 40
construção	Sys_id do registro que descreve o edifício no qual o contato reside. Tipo de dados: Cadeia de caracteres Tabela: Edifício [cmn_building]
calendar_integration	Aplicação de calendário que o contato usa. 1: Outlook Tipo de dados: Número (inteiro) Padrão: 1
cidade	Cidade na qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Empresa [core_company]
cost_center	Sys_id do centro de custos associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Centro de custos [cmn_cost_center]
país	Código do país no qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
date_format	Formato no qual exibir datas para os 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 Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Tipo de dados: Cadeia de caracteres Lista de menus [sys_perspective]
departamento	Sys_id do departamento associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Departamento [cmn_department]
edu_status	Status educacional do contato associado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: corpo docente
e-mail	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
employee_number	Contato com o número do funcionário. Tipo de dados: Cadeia de caracteres
enable_multifator_authn	Sinalizador que indica se a autorização multifator é necessária para que o contato faça 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
failed_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 Comprimento máximo: 50
sexo	Sexo do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
geolocation_tracked	Sinalizador que indica se o local do contato é obtido por meio do rastreamento geográfico. Valores possíveis: Local do contato obtido por meio do rastreamento geográfico Local do contato não obtido por meio do rastreamento geográfico Tipo de dados: Booliano Valor padrão: falso
home_phone	Número de telefone residencial do contato. Tipo de dados: Cadeia de caracteres Comprimento 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 Comprimento máximo: 40
last_login	Data em que o contato fez login pela última vez no sistema. 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 Comprimento 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 Comprimento máximo: 50
last_position_update	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) Comprimento máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema. Tipo de dados: Cadeia de caracteres Tabela: Servidor LDAP [ldap_server_config]
local	Sys_id do registro que descreve o local do contato Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
locked_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) Comprimento máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
middle_name	Nome do meio do contato. Tipo de dados: Número (ponto flutuante) Comprimento máximo: 50
mobile_phone	Número de telefone celular do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do contato. Tipo de dados: Cadeia de caracteres Comprimento 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
_schedule	Indica a pontualidade da equipe de serviço expedida. Valores válidos: À frente: À frente da programação. Behind_less30: Atrasado, mas menos de 30 minutos. Behind_30to60: Atraso entre 30 e 60 minutos. Behind_more60: Atraso na programação de mais de 60 minutos. On_time: Na programação. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
telefone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
foto	Imagem da foto do contato. Tipo de dados: Cadeia de caracteres
preferred_language	Código do país do idioma primário do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
agendamento	Sys_id do registro que descreve a programação de trabalho do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Programação [cmn_schedule]
origem	Origem do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
estado	Estado em que o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
rua	Endereço do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
sys_class_name	Tabela que contém o registro do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 80
sys_created_by	Usuário que criou originalmente o registro de contato associado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_created_on	Dados e hora em que o contato associado foi criado originalmente. Tipo de dados: Cadeia de caracteres (data/hora)
sys_domain	ServiceNow domínio da instância do registro de contato associado. Tipo de dados: Cadeia de caracteres
sys_domain_path	Caminho do domínio do registro de contato. Tipo de dados: Cadeia de caracteres Comprimento 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 as informações de contato associadas pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
sys_updated_on	Dados e hora em que as informações de contato associadas foram atualizadas. Tipo de dados: Cadeia de caracteres (data/hora)
time_format	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 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_sheet_policy	Sys_id do registro que contém a política de planilha de horas do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Política de planilha de horas [time_sheet_policy]
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do contato, como Gerente, Desenvolvedor de software ou Prestador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
user_name	ID do usuário do contato. Tipo de dados: Cadeia de caracteres Comprimento 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: Acesse por todos os métodos disponíveis Tipo de dados: Booliano Padrão: falso
zip	CEP do contato. Tipo de dados: Cadeia de caracteres Comprimento 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 - PUBLICAR /now/contact

Cria um novo Customer Service Management (CSM) contato.

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 incorreto, não for válido ou não for compatível com o endpoint, ele será ignorado sem aviso.

Formato de URL

URL com controle de versão: /api/now/api/contact

URL padrão: /api/now/contact

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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(a)

Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
Elemento	Descrição
conta	Sys_id do registro da conta ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account]
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 Comprimento máximo: 40
construção	Sys_id do registro que descreve o edifício no qual o contato reside. Tipo de dados: Cadeia de caracteres Tabela: Edifício [cmn_building]
calendar_integration	Aplicação de calendário que o contato usa. 1: Outlook Tipo de dados: Número (inteiro) Padrão: 1
cidade	Cidade na qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
empresa	Sys_id do registro da empresa ao qual o contato está associado. Tipo de dados: Cadeia de caracteres Tabela: Empresa [core_company]
cost_center	Sys_id do centro de custos associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Centro de custos [cmn_cost_center]
país	Código do país no qual o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
date_format	Formato no qual exibir datas para os 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 Comprimento máximo: 40 Padrão: Em branco (formato de data do sistema)
default_perspective	Sys_id da perspectiva padrão do contato. Tipo de dados: Cadeia de caracteres Lista de menus [sys_perspective]
departamento	Sys_id do departamento associado ao contato. Tipo de dados: Cadeia de caracteres Tabela: Departamento [cmn_department]
edu_status	Status educacional do contato associado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: corpo docente
e-mail	Endereço de e-mail do contato. Tipo de dados: Cadeia de caracteres
employee_number	Contato com o número do funcionário. Tipo de dados: Cadeia de caracteres
enable_multifator_authn	Sinalizador que indica se a autorização multifator é necessária para que o contato faça 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
failed_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 Comprimento máximo: 50
sexo	Sexo do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
geolocation_tracked	Sinalizador que indica se o local do contato é obtido por meio do rastreamento geográfico. Valores possíveis: Local do contato obtido por meio do rastreamento geográfico Local do contato não obtido por meio do rastreamento geográfico Tipo de dados: Booliano Valor padrão: falso
home_phone	Número de telefone residencial do contato. Tipo de dados: Cadeia de caracteres Comprimento 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 Comprimento 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 Comprimento 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 Comprimento máximo: 50
latitude	Coordenada de latitude do contato. Tipo de dados: Número (ponto flutuante) Comprimento máximo: 40
ldap_server	Sys_id do servidor LDAP usado pelo contato para fazer o último login no sistema. Tipo de dados: Cadeia de caracteres Tabela: Servidor LDAP [ldap_server_config]
local	Sys_id do registro que descreve o local do contato Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
locked_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) Comprimento máximo: 40
gerente	Sys_id do registro que descreve o supervisor direto do contato. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]
middle_name	Nome do meio do contato. Tipo de dados: Número (ponto flutuante) Comprimento máximo: 50
mobile_phone	Número de telefone celular do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
nome	Nome completo do contato. Tipo de dados: Cadeia de caracteres Comprimento 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
_schedule	Indica a pontualidade da equipe de serviço expedida. Valores válidos: À frente: À frente da programação. Behind_less30: Atrasado, mas menos de 30 minutos. Behind_30to60: Atraso entre 30 e 60 minutos. Behind_more60: Atraso na programação de mais de 60 minutos. On_time: Na programação. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
telefone	Número de telefone comercial do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
foto	Imagem da foto do contato. Tipo de dados: Cadeia de caracteres
preferred_language	Código do país do idioma primário do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 3
funções	Lista de funções de usuário associadas ao contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
agendamento	Sys_id do registro que descreve a programação de trabalho do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Programação [cmn_schedule]
social_channel	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 Comprimento máximo: 255
estado	Estado em que o contato reside. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
rua	Endereço do contato. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255
time_format	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 hora) HH:mm:ss: hh:mm:ss (24 hora) Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Em branco (formato de hora do sistema)
time_sheet_policy	Sys_id do registro que contém a política de planilha de horas do contato associado. Tipo de dados: Cadeia de caracteres Tabela: Política de planilha de horas [time_sheet_policy]
time_zone	Fuso horário no qual o contato reside, como Canadá/Central ou EUA/Leste. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
título	Cargo comercial do contato, como Gerente, Desenvolvedor de software ou Prestador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 60
user_name	ID do usuário do contato. Tipo de dados: Cadeia de caracteres Comprimento 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: Acesse por todos os métodos disponíveis Tipo de dados: Booliano Padrão: falso
zip	CEP do contato. Tipo de dados: Cadeia de caracteres Comprimento 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(a)

Códigos de status

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

Tabela 18. Códigos de status
Código do status	Descrição
201	O novo registro de contato foi criado com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
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"