고객 정보 센터 API
고객 정보 센터 API는 고객 정보 및 구성 상세 정보에 액세스할 수 있는 엔드포인트를 제공합니다.
이 API를 사용하여 이전에 고객 정보 센터 인터페이스를 통해 생성된 정보 기록(카드)을 가져옵니다.
이 API에 액세스하려면 관리자 또는 sn_esm_agent 역할이 있어야 합니다. 또한 인스턴스에서 이 API를 사용하려면 먼저 플러그인을 com.sn_csm_customer_central 활성화해야 합니다.
자세한 내용은 고객 정보 센터를 참조하십시오.
고객 정보 센터 - GET /cust_central/custinfo/{context}/{context_instance}/{target}
특정 고객 컨텍스트에 대한 고객 정보 및 구성 상세 정보를 반환합니다.
고객 컨텍스트는 지정한 고객 컨텐츠 테이블, 즉 소비자 [csm_consumer] 또는 연락처 [customer_contact] 테이블 및 연결된 대상 테이블에 의해 결정됩니다. 이 정보는 고객 정보 컨텍스트[sn_customercentral_cust_info_config] 테이블에 있습니다.
이 엔드포인트는 지정된 고객 컨텍스트에 대한 다음 고객 정보 센터 구성 테이블 내의 모든 활성 기록(카드)을 반환합니다.
- 목록 구성 [sn_customercentral_list_config]
- 기록 구성 [sn_customercentral_record_config]
- 보고서 구성 [sn_customercentral_report_config]
- 보고서 그룹 구성 [sn_customercentral_report_group_config]
고객 정보 센터 인터페이스를 통해 필요한 추가 구성 기록을 정의해야 합니다. 자세한 내용은 고객 정보 센터 구성을 참조하십시오.
URL 형식
버전이 지정된 URL: /api/sn_customercentral/{api_version}/cust_central/custinfo/{context}/{context_instance}/{target}
기본 URL: /api/sn_customercentral/cust_central/custinfo/{context}/{context_instance}/{target}
주:
사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열 |
| 컨텍스트 | 사용할 고객 컨텍스트 테이블의 이름입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| context_instance | 반환할 매개변수에 context 지정된 테이블의 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 대상 | 매개변수에 지정된 고객 컨텍스트 테이블과 연결된 대상 테이블입니다 context . 매개변수와 target 매개변수의 조합은 context 고유한 고객 정보 컨텍스트를 정의합니다. 데이터 유형: 문자열 테이블: 고객 정보 컨텍스트 [sn_customercentral_cust_info_config] |
| 이름 | 설명 |
|---|---|
| 다음 날짜 전 | 지정된 날짜 및 시간 이전에 생성된 모든 구성 기록을 반환합니다. 날짜 유형: 문자열 형식: YYYY-MM-DD 또는 시스템 속성에 glide.sys.date_format 정의된 형식 기본값: 현재 세션 시간 이전에 생성된 모든 구성 기록을 반환합니다. |
| 끝 | 반환할 마지막 기록입니다. 이 값을 사용하여 기록 검색을 페이지 매김하거나 매개변수와 start 함께 사용하여 반환할 특정 기록 세트를 선택합니다. 데이터 유형: 숫자 기본값: 파일의 마지막 기록 |
| 시작 | 기록 검색을 시작할 기록 인덱스를 시작하는 중입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 음수를 전달하지 마십시오. 데이터 유형: 숫자 기본값: 0 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 머리글 | 설명 |
|---|---|
| 안 함 |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 경로 매개변수에 유효한 값이 포함되어 있는지 확인하십시오. |
| 401 | 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| cards_info | 지정된 고객과 연결된 연락처 카드 목록입니다. 데이터 유형: 배열(콘텐츠는 선택한 고객에 따라 다름) |
| cards_info.data_configurations | 구성 정보입니다. 데이터 유형: 객체 |
| cards_info.data_configurations.aggregate_field | 집계할 열 이름입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.aggregate_function | 지정된 테이블 열을 집계하는 데 사용할 함수입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.data_configurations.decimal_precision | 반환할 소수점 오른쪽에 있는 자릿수입니다. 데이터 유형: 숫자 |
| cards_info.data_configurations.filter_query | 보고서에 사용되는 데이터를 구체화하는 데 사용할 쿼리 문자열입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.group_by | 보고서 데이터를 그룹화하는 데 사용할 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.number_of_groups | 보고서에 표시할 최대 그룹 수입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.data_configurations.show_other | 보고서 내에 "기타" 그룹이 표시되는지 여부를 나타내는 플래그입니다. 매개변수에 정의된 number_of_groups 대로 모든 그룹이 표시되지 않으면 표시되지 않는 그룹의 값이 결합되어 "기타"라는 단일 제목 아래에 표시됩니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.data_configurations.source_id | 보고서 소스 정보의 테이블 이름 또는 sys_id입니다. 이는 매개변수의 정보와 상관관계가 있습니다 cards_info.reportGroupConfigurations.data_configurations.source_type . 데이터 유형: 문자열 |
| cards_info.data_configurations.source_type | 소스 테이블을 식별하는 데 사용되는 매개변수의 cards_info.reportGroupConfigurations.data_configurations.source_id 정보 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.data_configurations.stack_by_field | 보고서에서 "스택 정렬 기준"을 구현할 때 사용할 테이블 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.sys_id | 보고서 구성에 사용되는 보고서의 Sys_id입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.trend_field | 추세 분석에 사용할 테이블 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.trend_interval | 추세 정보의 시간 간격입니다. 예를 들어 주, 월, 연도 등이 있습니다. 데이터 유형: 문자열 |
| cards_info.data_configurations.type | 단일 점수, 도넛형, 세로형, 꺾은선형, 누적 가로 막대형 등과 같은 보고서 유형 데이터 유형: 문자열 |
| cards_info.encodedQuery | 보고서에 표시되는 데이터를 구체화하는 데 사용할 인코딩된 쿼리 문자열입니다. 데이터 유형: 문자열 |
| cards_info.fields | 연결된 기록 내에서 필드를 정의하는 이름-값 쌍의 목록입니다. 데이터 유형: 객체 배열 |
| cards_info.fields.label | 필드 레이블입니다. 데이터 유형: 문자열 |
| cards_info.fields.value | 필드 값입니다. 데이터 유형: 문자열 |
| cards_info.listLimit | 페이지 매김 제한입니다. 목록 카드에 표시할 기록 수입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations | 보고서 그룹을 정의하는 객체의 목록입니다. 데이터 유형: 객체 배열 |
| cards_info.reportGroupConfigurations.data_configurations | 구성 정보입니다. 데이터 유형: 객체 |
| cards_info.reportGroupConfigurations.data_configurations.aggregate_field | 집계할 열 이름입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.aggregate_function | 지정된 테이블 열을 집계하는 데 사용할 함수입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.decimal_precision | 반환할 소수점 오른쪽에 있는 자릿수입니다. 데이터 유형: 숫자 |
| cards_info.reportGroupConfigurations.data_configurations.filter_query | 보고서에 사용되는 데이터를 구체화하는 데 사용할 쿼리 문자열입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.group_by | 보고서 데이터를 그룹화하는 데 사용할 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.number_of_groups | 보고서에 표시할 최대 그룹 수입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.show_other | 보고서 내에 "기타" 그룹이 표시되는지 여부를 나타내는 플래그입니다. 매개변수에 정의된 number_of_groups 대로 모든 그룹이 표시되지 않으면 표시되지 않는 그룹의 값이 결합되어 "기타"라는 단일 제목 아래에 표시됩니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.reportGroupConfigurations.data_configurations.source_id | 보고서 소스 정보의 테이블 이름 또는 sys_id입니다. 이는 매개변수의 정보와 상관관계가 있습니다 cards_info.reportGroupConfigurations.data_configurations.source_type . 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.source_type | 소스 테이블을 식별하는 데 사용되는 매개변수의 cards_info.reportGroupConfigurations.data_configurations.source_id 정보 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.stack_by_field | 보고서에서 "스택 정렬 기준"을 구현할 때 사용할 테이블 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.sys_id | 보고서 구성에 사용되는 보고서의 Sys_id입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.trend_field | 추세 분석에 사용할 테이블 열의 이름입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.trend_interval | 추세 정보의 시간 간격입니다. 예를 들어 주, 월, 연도 등이 있습니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.data_configurations.type | 보고서 그룹과 연결된 보고서의 유형입니다(예: 도넛형 또는 single_core). 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.style_configurations | 연결된 보고서 그룹 내에서 사용할 스타일입니다. 데이터 유형: 객체 |
| cards_info.reportGroupConfigurations.style_configurations.colorPalette | 보고서에 사용되는 색상입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.style_configurations.scoreColor | 보고서 내 점수 값의 색상입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.style_configurations.show_zero | 0과 같은 데이터 포인트가 보고서에 표시되는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.reportGroupConfigurations.title | 보고서 그룹의 제목입니다. 데이터 유형: 문자열 |
| cards_info.reportGroupConfigurations.type | 정보가 반환되는 파일 형식입니다. 항상 sn_customercentral_report_config. 데이터 유형: 문자열 |
| cards_info.sourceTableName | 연결된 목록 카드에 사용되는 테이블의 이름입니다. 데이터 유형: 문자열 |
| cards_info.style_configurations | 연결된 보고서 내에서 사용할 스타일입니다. 데이터 유형: 객체 |
| cards_info.style_configurations.colorPalette | 보고서에 사용되는 색상입니다. 데이터 유형: 문자열 |
| cards_info.style_configurations.dataLabelConfig | 보고서에 데이터 레이블을 표시하는 방법을 제어하는 구성 매개변수입니다. 데이터 유형: 객체 |
| cards_info.style_configurations.dataLabelConfig.showTotal | 보고서에 합계를 표시할지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.height | 연결된 보고서의 높이입니다. 데이터 유형: 문자열 단위: 픽셀 또는 "자동" |
| cards_info.style_configurations.hideRegister | 카드에 레지스터를 표시할지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.registerConfig | 레지스터가 보고서에 표시되는 방식을 제어하는 구성 값입니다. 데이터 유형: 객체 |
| cards_info.style_configurations.registerConfig.hideBorder | 레지스터 주위의 테두리를 숨길지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.registerConfig.showPercentages | 등록 백분율을 표시할지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.registerPosition | 카드 내에서 레지스터의 위치입니다. 데이터 유형: 문자열 |
| cards_info.style_configurations.scoreColor | 보고서 내 점수 값의 색상입니다. 데이터 유형: 문자열 |
| cards_info.style_configurations.showDataLabels | 보고서 내에 데이터 레이블을 표시할지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.showTooltip | 보고서 내에 도구 설명을 표시할지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.show_zero | 0과 같은 데이터 포인트가 보고서에 표시되는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| cards_info.style_configurations.width | 관련 보고서의 너비입니다. 데이터 유형: 문자열 단위: 픽셀 또는 "자동" |
| cards_info.subheader_fields | 연결된 카드의 하위 헤더에 표시할 상세 정보입니다. 데이터 유형: 객체 |
| cards_info.subheader_fields.avatar | 연락처의 아바타와 같이 지정됨 context_instance과 연결된 아바타의 파일 이름입니다. 데이터 유형: 문자열 |
| cards_info.subheader_fields.subheader_tags | 에스컬레이션 태그와 같이 기록 하위 헤더와 연결된 태그의 목록입니다. 데이터 유형: 배열(내용은 다름) |
| cards_info.subheader_fields.sys_id | 연결된 고객의 Sys_id입니다. 데이터 유형: 문자열 테이블: 사용자 [sys_user] |
| cards_info.subheader_fields.title | 하위 헤더에 표시할 제목입니다. 데이터 유형: 문자열 |
| cards_info.title | 카드(기록)의 제목입니다. 데이터 유형: 문자열 |
| cards_info.type | 정보가 반환되는 파일 형식입니다. 가능한 값:
데이터 유형: 문자열 |
| cards_info.viewName | 에 cards_info.sourceTableName지정된 테이블에 대해 구성된 뷰의 이름입니다. 데이터 유형: 문자열 |
| has_more_records | 검색할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 레이아웃 | 행당 열 수입니다. 쉼표로 구분된 각 값은 보고서 표시의 열 너비를 정의합니다. 예를 들어 "6,6"은 각각 너비가 6단위인 2개의 열을 나타내며 행당 총 12단위(최대)입니다. "3,6,3" 값은 3개의 열이 있는 행을 나타냅니다. 데이터 유형: 문자열 |
| 상태 | 요청의 HTTP 상태입니다. 데이터 유형: 문자열 |
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"
}
}