API da Central do cliente
A API da Central do cliente fornece endpoints para acessar informações do cliente e detalhes de configuração.
Use esta API para obter registros de informações (cartões) que foram gerados anteriormente por meio da interface da Central do cliente.
Você deve ter a função de administrador ou sn_esm_agent para acessar esta API. Além disso, antes que esta API esteja disponível em sua instância, você deve ativar o plug-in com.sn_csm_customer_central.
Para obter informações adicionais, consulte Central do cliente.
Central do cliente - GET /cust_central/custinfo/{context}/{context_instance}/{target}
Retorna informações do cliente e detalhes de configuração para um contexto de cliente específico.
O contexto do cliente é determinado pela tabela de conteúdo do cliente que você especifica, a tabela Consumidor [csm_consumer] ou Contato [customer_contact] e sua tabela de destino associada. Essas informações estão localizadas na tabela Contexto de informações do cliente [sn_customercentral_cust_info_config].
Este endpoint retorna todos os registros ativos (cartões) nas seguintes tabelas de configuração da Central do cliente para o contexto do cliente especificado:
- Configuração de lista [sn_customercentral_list_config]
- Configuração de registro [sn_customercentral_record_config]
- Configuração de relatório [sn_customercentral_report_config]
- Configuração de grupo de relatórios [sn_customercentral_report_group_config]
Você deve definir todos os registros de configuração adicionais necessários por meio da interface da Central do cliente. Para obter detalhes, consulte Configuração da central do cliente.
Formato de URL
URL com controle de versões: /api/sn_customercentral/{api_version}/cust_central/custinfo/{context}/{context_instance}/{target}
URL padrão: /api/sn_customercentral/cust_central/custinfo/{context}/{context_instance}/{target}
Parâmetros de solicitação compatíveis
| 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 |
| contexto | Nome da tabela de contexto do cliente a ser usada. Valores válidos:
Tipo de dados: cadeia de caracteres |
| context_instance | Sys_id do registro na tabela especificada no parâmetro context a retornar. Tipo de dados: cadeia de caracteres |
| destino | Tabela de destino associada à tabela de contexto do cliente especificada no parâmetro context. A combinação do parâmetro [ context e do parâmetro target define um contexto exclusivo de informações do cliente. Essas informações estão localizadas na tabela Contexto de informações do cliente [sn_customercentral_cust_info_config]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| antes | Retorna todos os registros de configuração criados antes da data e hora especificadas. Tipo de data: cadeia de caracteres Formato: AAAA-MM-DD ou o formato definido na propriedade do sistema glide.sys.date_format Padrão: retorna todos os registros de configuração criados antes da hora da sessão atual. |
| término | Último registro a retornar. Use este valor para paginar a recuperação de registro ou use com o parâmetro start para selecionar um conjunto específico de registros a serem retornados. Tipo de dados: número Padrão: último registro no arquivo |
| início | Í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. Não passe um número negativo. Tipo de dados: número Padrão: 0 |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| 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.
| Código de 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. Certifique-se de que os parâmetros de caminho contenham valores válidos. |
| 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 |
|---|---|
| cartões_info | Lista de cartões de contato associados ao cliente especificado. Tipo de dados: matriz (o conteúdo depende do cliente selecionado) |
| cartões_info.data_configurations | Informações de configuração. Tipo de dados: objeto |
| cartões_info.data_configurations.aggregate_field | Nome da coluna a ser agregada. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.aggregate_function | Função a ser usada para agregar a coluna da tabela especificada. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_informações.data_configurations.decimal_precision | Número de dígitos à direita da vírgula a retornar. Tipo de dados: número |
| cartões_informações.data_configurations.filter_query | Cadeia de caracteres de consulta a ser usada para refinar os dados usados no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.group_by | Nome da coluna a ser usada para agrupar os dados do relatório. Tipo de dados: cadeia de caracteres |
| cartões_informações.data_configurations.number_of_groups | Número máximo de grupos a serem exibidos no relatório. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.show_other | Sinalizador que indica se o grupo "Outro" aparece no relatório. Se nem todos os grupos forem exibidos, conforme definido pelo parâmetro number_of_groups, os valores dos grupos que não são de exibição serão combinados e exibidos em um único título "Outro". Valores possíveis:
Tipo de dados: booliano |
| cartões_info.data_configurations.source_id | Nome da tabela ou sys_id das informações de origem do relatório. Isso está correlacionado às informações no parâmetro cards_info.reportGroupConfigurations.data_configurations.source_type. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.source_type | Tipo de informação no parâmetro cards_info.reportGroupConfigurations.data_configurations.source_id usado para identificar a tabela de origem. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_informações.data_configurations.stack_by_field | Nome da coluna da tabela a ser usada ao implementar "empilhar por" no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.sys_id | Sys_id do relatório usado na configuração do relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.trend_field | Nome da coluna da tabela a ser usada na análise de tendências. Tipo de dados: cadeia de caracteres |
| cartões_info.data_configurations.trend_interval | Intervalo de tempo para as informações de tendência. Por exemplo, semana, mês, ano etc. Tipo de dados: cadeia de caracteres |
| cartões_informações.data_configurations.type | Tipo de relatório, como pontuação única, rosca, vertical, linha, barra empilhada etc. Tipo de dados: cadeia de caracteres |
| cartões_info.encodedQuery | Cadeia de caracteres de consulta codificada a ser usada para refinar os dados que aparecem no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.campos | Lista de pares de nome-valor que definem os campos no registro associado. Tipo de dados: matriz |
| cartões_informações.campos.rótulo | Rótulo do campo. Tipo de dados: cadeia de caracteres |
| cartões_informações.campos.valor | Valor do campo. Tipo de dados: cadeia de caracteres |
| cartões_informações.listaLimite | Limite de paginação. Número de registros a serem mostrados em um cartão de lista. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations | Lista de objetos que definem os grupos de relatórios. Tipo de dados: matriz |
| cartões_info.reportGroupConfigurations.data_configurations | Informações de configuração. Tipo de dados: objeto |
| cartões_info.reportGroupConfigurations.data_configurations.aggregate_field | Nome da coluna a ser agregada. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.aggregate_function | Função a ser usada para agregar a coluna da tabela especificada. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.decimal_precision | Número de dígitos à direita da vírgula a retornar. Tipo de dados: número |
| cartões_info.reportGroupConfigurations.data_configurations.filter_query | Cadeia de caracteres de consulta a ser usada para refinar os dados usados no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.group_by | Nome da coluna a ser usada para agrupar os dados do relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.number_of_groups | Número máximo de grupos a serem exibidos no relatório. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.show_other | Sinalizador que indica se o grupo "Outro" aparece no relatório. Se nem todos os grupos forem exibidos, conforme definido pelo parâmetro number_of_groups, os valores dos grupos que não são de exibição serão combinados e exibidos em um único título "Outro". Valores possíveis:
Tipo de dados: booliano |
| cartões_info.reportGroupConfigurations.data_configurations.source_id | Nome da tabela ou sys_id das informações de origem do relatório. Isso está correlacionado às informações no parâmetro cards_info.reportGroupConfigurations.data_configurations.source_type. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.source_type | Tipo de informação no parâmetro cards_info.reportGroupConfigurations.data_configurations.source_id usado para identificar a tabela de origem. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.stack_by_field | Nome da coluna da tabela a ser usada ao implementar "empilhar por" no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.sys_id | Sys_id do relatório usado na configuração do relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.trend_field | Nome da coluna da tabela a ser usada na análise de tendências. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.trend_interval | Intervalo de tempo para as informações de tendência. Por exemplo, semana, mês, ano etc. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.data_configurations.type | Tipo de relatório associado ao grupo de relatórios, como donut ou single_core. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.style_configurations | Estilos a serem usados no grupo de relatórios associado. Tipo de dados: objeto |
| cartões_info.reportGroupConfigurations.style_configurations.colorPalette | Cores usadas no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.style_configurations.scoreColor | Cor do valor de pontuação no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.style_configurations.show_zero | Sinalizador que indica se os pontos de dados iguais a zero são mostrados no relatório. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.reportGroupConfigurations.title | Título do grupo de relatórios. Tipo de dados: cadeia de caracteres |
| cartões_info.reportGroupConfigurations.type | Tipo de arquivo para o qual as informações estão sendo retornadas. Sempre sn_customercentral_report_config. Tipo de dados: cadeia de caracteres |
| cartões_info.sourceTableName | Nome da tabela usada para o cartão de lista associado. Tipo de dados: cadeia de caracteres |
| cartões_info.style_configurations | Estilos a serem usados no relatório associado. Tipo de dados: objeto |
| cartões_info.style_configurations.colorPalette | Cores usadas no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.style_configurations.dataLabelConfig | Parâmetros de configuração que controlam como os rótulos de dados aparecem no relatório. Tipo de dados: objeto |
| cartões_info.style_configurations.dataLabelConfig.showTotal | Sinalizador que indica se o total deve ser exibido no relatório. Valores possíveis:
Tipo de dados: booliano |
| cartões_informações.estilo_configurações.altura | Altura do relatório associado. Tipo de dados: cadeia de caracteres Unidade: pixels ou "auto" |
| cartões_info.style_configurations.hideRegister | Sinalizador que indica se o registro deve ser exibido no cartão. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.style_configurations.registerConfig | Valores de configuração que controlam como o registro aparece no relatório. Tipo de dados: objeto |
| cartões_info.style_configurations.registerConfig.hideBorder | Sinalizador que indica se a borda ao redor do registro deve ser ocultada. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.style_configurations.registerConfig.showPercentages | Sinalizador que indica se as porcentagens de registro devem ser mostradas. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.style_configurations.registerPosition | Posição do registro em um cartão. Tipo de dados: cadeia de caracteres |
| cartões_info.style_configurations.scoreColor | Cor do valor de pontuação no relatório. Tipo de dados: cadeia de caracteres |
| cartões_info.style_configurations.showDataLabels | Sinalizador que indica se os rótulos de dados devem ser mostrados no relatório. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.style_configurations.showTooltip | Sinalizador que indica se as dicas da ferramenta devem ser mostradas no relatório. Valores possíveis:
Tipo de dados: booliano |
| cartões_info.style_configurations.show_zero | Sinalizador que indica se os pontos de dados iguais a zero são mostrados no relatório. Valores possíveis:
Tipo de dados: booliano |
| cartões_informações.estilo_configurações.largura | Largura do relatório associado. Tipo de dados: cadeia de caracteres Unidade: pixels ou "auto" |
| cartões_informações.subheader_fields | Descreve os detalhes a serem mostrados no subcabeçalho do cartão associado. Tipo de dados: objeto |
| cartões_informações.subheader_fields.avatar | Nome do arquivo do avatar associado ao context_instanceespecificado, como o avatar do contato. Tipo de dados: cadeia de caracteres |
| cartões_informações.subheader_fields.subheader_tags | Lista de marcadores associados ao subcabeçalho do registro, como marcadores de escalação. Tipo de dados: matriz (o conteúdo varia) |
| cartões_info.subheader_fields.sys_id | Sys_id do cliente associado. Localizado na tabela Usuários [sys_user]. Tipo de dados: cadeia de caracteres |
| cartões_informações.subheader_fields.título | Título a ser exibido no subcabeçalho. Tipo de dados: cadeia de caracteres |
| cartões_info.título | Título no cartão (registro). Tipo de dados: cadeia de caracteres |
| cartões_info.tipo | Tipo de arquivo para o qual as informações estão sendo retornadas. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cartões_info.viewName | Nome da exibição configurada para a tabela especificada em cards_info.sourceTableName. Tipo de dados: cadeia de caracteres |
| tem_mais_registros | Sinalizador que indica se há mais registros a serem recuperados. Valores possíveis:
Tipo de dados: booliano |
| layout | Define o número de colunas por linha. Cada valor separado por vírgulas define a largura de uma coluna na exibição do relatório. Por exemplo, "6,6" denota duas colunas, cada uma com seis unidades de largura, para um total de 12 unidades por linha (máximo). Um valor de "3,6,3" denota uma linha com três colunas. Tipo de dados: cadeia de caracteres |
| status | Status HTTP da solicitação. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow/api/sn_customercentral/cust_central/custinfo/csm_consumer/a0488cfbdb1b1200b6075200cf9619db/interaction" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
"result": {
"layout": "6,6",
"cards_info": [
{
"title": "Consumer",
"type": "sn_customercentral_record_config",
"subheader_fields": {
"title": "Sam Collins",
"subheader_tags": [],
"avatar": "",
"sys_id": "64488cfbdb1b1200b6075200cf9619db"
},
"fields": [
{
"label": "Mobile phone",
"value": ""
},
{
"label": "Business phone",
"value": ""
},
{
"label": "Email",
"value": "sam.collins@mailinator.com"
},
{
"label": "Street",
"value": "144 2nd St"
},
{
"label": "City",
"value": "San Francisco"
},
{
"label": "State / Province",
"value": "CA"
}
]
},
{
"title": "High priority cases",
"type": "sn_customercentral_report_group_config",
"reportGroupConfigurations": [
{
"title": "Escalated",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "active=true^active_escalationISNOTEMPTY^EQ^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "c169a0f50f3b0010e6d4fd820b767e2e"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
},
{
"title": "P1",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "active=true^priority=1^EQ^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "cce86cb50f3b0010e6d4fd820b767eba"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
},
{
"title": "SLA breached",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "task_sla",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "task.active=true^task.sys_class_name=sn_customerservice_case^stage!=cancelled^task.closed_atISEMPTY^sla.type=SLA^has_breached=true^EQ^taskIN59b65dc4db952200d75270f5bf96193eccc8cf82db912200d75270f5bf9619de^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "e739a0f50f3b0010e6d4fd820b767e22"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
}
]
},
{
"title": "Case overview",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "donut",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "state",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "d169216c0f770010e6d4fd820b767ea8"
},
"style_configurations": {
"width": "auto",
"height": "auto",
"colorPalette": [
"#278ecf",
"#4bd762",
"#ffca1f",
"#ff9416",
"#d42ae8"
],
"hideRegister": false,
"registerConfig": {
"hideBorder": true,
"showPercentages": false
},
"registerPosition": "right",
"showDataLabels": false,
"dataLabelConfig": {
"showTotal": false
},
"showTooltip": true
}
},
{
"title": "Recent cases",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "sn_customerservice_case"
},
{
"title": "Recent chat interactions",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=false^type=chat^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "interaction"
},
{
"title": "Recent phone calls",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=false^type=phone^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "interaction"
},
{
"title": "Recent viewed articles",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "user=64488cfbdb1b1200b6075200cf9619db^viewed=true^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "kb_use"
},
{
"title": "Contracts",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^state=Active^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "ast_contract"
},
{
"title": "Entitlements",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^end_date=NULL^ORend_date>=2020-05-07 07:00:00^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "service_entitlement"
}
],
"has_more_records": false,
"status": "200"
}
}