연락처 API

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기41분

연락처 API는 연락처 레코드를 검색하고 업데이트할 고객 서비스 관리(CSM) 수 있는 엔드포인트를 제공합니다.

또한 접촉 창구를 만들 때 새 소셜 미디어 프로필 기록을 생성할 수 있습니다.

연락처 API에는 Customer Service 플러그인(com.sn_customerservice)이 필요하며 now 네임스페이스 내에서 제공됩니다.

사용자는 전체 API 액세스를 위해 csm_ws_integration 역할이 필요합니다.

연락처 - GET /now/contact

지정된 연락처 집합을 고객 서비스 관리(CSM) 조회합니다.

URL 형식

버전이 지정된 URL: / api/now/{api_version}/contact

기본 URL: / api/now/contact

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
sysparm_limit	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 응답에서 boolean 매개 변수가 hasMore 반환됩니다. 이는 필터 기준을 충족하는 반환할 기록이 더 있는지 여부를 나타냅니다. 데이터 유형: 숫자 기본값: 10
sysparm_offset	기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다. sysparm_offset 매개변수에 음수를 전달하지 마십시오. 데이터 유형: 숫자 기본값: 0
sysparm_query	결과 세트를 필터링하는 데 사용되는 인코딩된 쿼리입니다. 예: `sysparm_query=caller_id=javascript:gs.getUserID()^active=true` 인코딩된 쿼리는 정렬 기준을 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 ORDERBY 및 ORDERBYDESC 절을 사용합니다. 예를 들어, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` 는 모든 활성 기록을 필터링하고 결과를 먼저 번호별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

엔드포인트는 응답 본문에 다음 JSON 또는 XML 요소를 반환할 수 있습니다. 기본 시스템의 요소를 정의하는 아래에 정의된 요소 목록 외에도 엔드포인트는 연락처 [customer_contact] 테이블에 추가된 사용자 지정 필드를 반환합니다. 이러한 요소에 대한 자세한 내용은 특정 테이블 정의 [시스템 정의 > 테이블].


요소	설명
계정	연락처가 연결된 계정 기록의 Sys_id. 계정 [customer_account] 테이블 데이터 유형: 문자열
활성	연락처가 시스템 내에서 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: true: 접촉 창구가 활성 상태입니다. false: 연락처가 비활성 상태입니다. 데이터 유형: 부울 기본값: true
agent_status	에이전트의 상태입니다. 가능한 값: 퇴근 휴식 중 이동 중 현장 데이터 유형: 문자열 최대 길이: 40
빌드 중	연락처가 거주하는 건물을 설명하는 기록의 Sys_id입니다. 건물 [cmn_building] 테이블. 데이터 유형: 문자열
calendar_integration	접촉 창구가 사용하는 달력 애플리케이션입니다. 1: 전망 데이터 유형: 숫자(정수) 기본값: 1
구/군/시	연락처가 거주하는 구/군/시입니다. 데이터 유형: 문자열 최대 길이: 40
회사	연락처가 연결된 회사 기록의 Sys_id. 회사 [core_company] 테이블입니다. 데이터 유형: 문자열
cost_center	접촉 창구와 연결된 비용 센터의 Sys_id입니다. 비용 센터 [cmn_cost_center] 테이블입니다. 데이터 유형: 문자열
국가	연락처가 위치한 국가의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
date_format	연락처에 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd 데이터 유형: 문자열 최대 길이: 40 기본값: 비어 있음(시스템 날짜 형식)
default_perspective	연락처에 대한 기본 관점의 Sys_id입니다. 메뉴 목록 [sys_perspective] 테이블에 있습니다. 데이터 유형: 문자열
부서	접촉 창구와 관련된 부서의 Sys_id입니다. 부서 [cmn_department] 테이블에 있습니다. 데이터 유형: 문자열
edu_status	연결된 접촉 창구의 학력 상태입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 교수진
이메일	담당자 이메일 주소입니다. 데이터 유형: 문자열
employee_number	연락처 직원 번호입니다. 데이터 유형: 문자열
enable_multifactor_authn	연락처가 Service Portal에 로그인하는 데 다단계 인증이 필요한지 여부를 나타내는 플래그입니다. 가능한 값: true: Multifactor Authorization 사용 false: 다단계 인증이 비활성화됨 데이터 유형: 부울 기본값: false
failed_attempts	실패한 로그인 시도 횟수입니다. 데이터 유형: 숫자(정수)
first_name	연락처 이름. 데이터 유형: 문자열 최대 길이: 50
성별	성별에 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
geolocation_tracked	지오트래킹을 통해 연락처 위치를 가져올지 여부를 나타내는 플래그입니다. 가능한 값: true: 지오트래킹을 통해 얻은 연락처 위치 false: 지오트래킹을 통해 연락처 위치를 얻지 못했습니다. 데이터 유형: 부울 기본값: False
home_phone	집 전화 번호로 연락하십시오. 데이터 유형: 문자열 최대 길이: 40
internal_integration_user	연락처가 내부 통합 사용자인지 여부를 나타내는 플래그입니다. 가능한 값: true: 내부 통합 사용자 false: 기타 유형의 사용자 데이터 유형: 부울 기본값: false
소개	소개 데이터 유형: 문자열 최대 길이: 40
last_login	접촉 창구가 마지막으로 시스템에 로그인한 날짜입니다. 데이터 유형: 문자열(날짜)
last_login_device	소비자가 시스템에 마지막으로 로그인할 때 사용한 장치입니다. 데이터 유형: 문자열 최대 길이: 40
last_login_time	접촉 창구가 시스템에 로그인한 날짜와 시간입니다. 데이터 유형: 문자열(날짜/시간)
last_name	연락처 성입니다. 데이터 유형: 문자열 최대 길이: 50
last_position_update	마지막 위치가 업데이트된 날짜와 시간입니다. 데이터 유형: 문자열(날짜/시간)
위도	접촉의 위도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
ldap_server	접촉 창구가 시스템에 마지막으로 로그인하기 위해 사용하는 LDAP 서버의 Sys_id. LDAP 서버 [ldap_server_config] 테이블입니다. 데이터 유형: 문자열
위치	연락처의 위치를 설명하는 기록의 Sys_id. 위치 [cmn_location] 테이블입니다. 데이터 유형: 문자열
locked_out	연락처가 잠겨 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 연락처가 잠겨 있음 false: 연락처가 잠겨 있지 않음 데이터 유형: 부울 기본값: false
경도	접촉 창구의 경도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
매니저	접촉자의 직속 상사를 설명하는 기록의 Sys_id입니다. 사용자 [sys_user] 테이블입니다. 데이터 유형: 문자열
middle_name	연락처 중간 이름. 데이터 유형: 숫자(부동 소수점) 최대 길이: 50
mobile_phone	연락처 휴대 전화 번호. 데이터 유형: 문자열 최대 길이: 40
이름	연락처 성명. 데이터 유형: 문자열 최대 길이: 151
알림	접촉 창구가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. 1: 사용 안 함 2: 사용 데이터 유형: 숫자(정수) 기본값: 2
on_schedule	파견된 서비스 담당자의 적시성을 나타냅니다. 유효한 값은 다음과 같습니다. 앞서: 일정보다 앞서. behind_less30: 일정보다 늦었지만 30분 미만입니다. behind_30to60: 일정보다 늦게 30분에서 60분 사이입니다. behind_more60: 일정보다 60분 이상 지연되었습니다. on_time: 일정대로. 데이터 유형: 문자열 최대 길이: 40
전화	회사 전화번호로 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
사진	접촉 창구의 사진 이미지입니다. 데이터 유형: 이미지
preferred_language	연락처 기본 언어의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
역할	접촉 창구와 연결된 사용자 역할의 목록입니다. 데이터 유형: 문자열 최대 길이: 40
일정	관련 연락처에 대한 작업 일정을 설명하는 기록의 Sys_id. 일정 [cmn_schedule] 테이블 데이터 유형: 문자열
source	연락처의 소스입니다. 데이터 유형: 문자열 최대 길이: 255
상태	연락처가 있는 시/도입니다. 데이터 유형: 문자열 최대 길이: 40
거리	연락처 주소. 데이터 유형: 문자열 최대 길이: 255
sys_class_name	연락처 기록이 들어 있는 테이블입니다. 데이터 유형: 문자열 최대 길이: 80
sys_created_by	연결된 연락처 기록을 원래 만든 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_created_on	연결된 연락처가 원래 생성된 데이터 및 시간입니다. 데이터 유형: 문자열(날짜/시간)
sys_domain	ServiceNow 연결된 연락처 기록의 인스턴스 도메인입니다. 데이터 유형: 문자열
sys_domain_path	연락처 기록 도메인 경로입니다. 데이터 유형: 문자열 최대 길이: 255 기본값: / (전역)
sys_id	연결된 연락처 기록의 고유 식별자입니다. 데이터 유형: 문자열
sys_mod_count	연결된 연락처 레코드가 수정된 횟수입니다. 데이터 유형: 숫자(정수)
sys_tags	시스템 태그. 데이터 유형: 문자열
sys_updated_by	연결된 연락처 정보를 마지막으로 업데이트한 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_updated_on	관련 연락처 정보가 업데이트된 데이터와 시간입니다. 데이터 유형: 문자열(날짜/시간)
time_format	시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. hh.mm.ss: hh.mm.ss(12시간) hh:mm:ss a: hh:mm:ss(12시간) HH.mm.ss: hh.mm.ss(24시간) HH:mm:ss: hh:mm:ss(24시간) 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식)
time_sheet_policy	연결된 연락처에 대한 타임시트 정책이 포함된 기록의 Sys_id. 타임시트 정책[time_sheet_policy] 테이블입니다. 데이터 유형: 문자열
time_zone	연락처가 있는 시간대(예: 캐나다/중부 또는 미국/동부)입니다. 데이터 유형: 문자열 최대 길이: 40
제목	관리자, 소프트웨어 개발자 또는 계약자와 같은 비즈니스 직위를 문의합니다. 데이터 유형: 문자열 최대 길이: 60
user_name	연락처 사용자 ID입니다. 데이터 유형: 문자열 최대 길이: 40
Vip	연결된 연락처의 VIP 상태 여부를 나타내는 플래그입니다. 가능한 값: true: VIP false: VIP 아님 데이터 유형: 부울 기본값: false
web_service_access_only	연락처가 웹을 통해서만 서비스에 액세스할 수 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 웹 액세스만 false: 사용 가능한 모든 방법을 통해 액세스 데이터 유형: 부울 기본값: false
우편번호	연락처 우편 번호. 데이터 유형: 문자열 최대 길이: 40

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"
    }
  ]
}

연락처 - GET /now/contact/{id}

지정된 고객 서비스 관리(CSM) 연락처를 조회합니다.

URL 형식

버전이 지정된 URL: /api/now/{api_version}/ contact/{id}

기본 URL: / api/now/contact/{id}

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
ID	검색할 연락처의 Sys_id입니다. 연락처 [customer_contact] 테이블에 있습니다.

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
없음

헤더

표 10. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	요청이 잘못되었음을 나타냅니다. 다음 이유 중 하나 때문일 수 있습니다. 요청한 케이스가 없습니다. 사용자는 케이스에 접근할 수 있는 권한이 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


요소	설명
계정	연락처가 연결된 계정 기록의 Sys_id. 계정 [customer_account] 테이블 데이터 유형: 문자열
활성	연락처가 시스템 내에서 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: true: 접촉 창구가 활성 상태입니다. false: 연락처가 비활성 상태입니다. 데이터 유형: 부울 기본값: true
agent_status	에이전트의 상태입니다. 가능한 값: 퇴근 휴식 중 이동 중 현장 데이터 유형: 문자열 최대 길이: 40
빌드 중	연락처가 거주하는 건물을 설명하는 기록의 Sys_id입니다. 건물 [cmn_building] 테이블. 데이터 유형: 문자열
calendar_integration	접촉 창구가 사용하는 달력 애플리케이션입니다. 1: 전망 데이터 유형: 숫자(정수) 기본값: 1
구/군/시	연락처가 거주하는 구/군/시입니다. 데이터 유형: 문자열 최대 길이: 40
회사	연락처가 연결된 회사 기록의 Sys_id. 회사 [core_company] 테이블입니다. 데이터 유형: 문자열
cost_center	접촉 창구와 연결된 비용 센터의 Sys_id입니다. 비용 센터 [cmn_cost_center] 테이블입니다. 데이터 유형: 문자열
국가	연락처가 위치한 국가의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
date_format	연락처에 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd 데이터 유형: 문자열 최대 길이: 40 기본값: 비어 있음(시스템 날짜 형식)
default_perspective	연락처에 대한 기본 관점의 Sys_id입니다. 메뉴 목록 [sys_perspective] 테이블에 있습니다. 데이터 유형: 문자열
부서	접촉 창구와 관련된 부서의 Sys_id입니다. 부서 [cmn_department] 테이블에 있습니다. 데이터 유형: 문자열
edu_status	연결된 접촉 창구의 학력 상태입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 교수진
이메일	담당자 이메일 주소입니다. 데이터 유형: 문자열
employee_number	연락처 직원 번호입니다. 데이터 유형: 문자열
enable_multifactor_authn	연락처가 Service Portal에 로그인하는 데 다단계 인증이 필요한지 여부를 나타내는 플래그입니다. 가능한 값: true: Multifactor Authorization 사용 false: 다단계 인증이 비활성화됨 데이터 유형: 부울 기본값: false
failed_attempts	실패한 로그인 시도 횟수입니다. 데이터 유형: 숫자(정수)
first_name	연락처 이름. 데이터 유형: 문자열 최대 길이: 50
성별	성별에 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
geolocation_tracked	지오트래킹을 통해 연락처 위치를 가져올지 여부를 나타내는 플래그입니다. 가능한 값: true: 지오트래킹을 통해 얻은 연락처 위치 false: 지오트래킹을 통해 연락처 위치를 얻지 못했습니다. 데이터 유형: 부울 기본값: False
home_phone	집 전화 번호로 연락하십시오. 데이터 유형: 문자열 최대 길이: 40
internal_integration_user	연락처가 내부 통합 사용자인지 여부를 나타내는 플래그입니다. 가능한 값: true: 내부 통합 사용자 false: 기타 유형의 사용자 데이터 유형: 부울 기본값: false
소개	소개 데이터 유형: 문자열 최대 길이: 40
last_login	접촉 창구가 마지막으로 시스템에 로그인한 날짜입니다. 데이터 유형: 문자열(날짜)
last_login_device	소비자가 시스템에 마지막으로 로그인할 때 사용한 장치입니다. 데이터 유형: 문자열 최대 길이: 40
last_login_time	접촉 창구가 시스템에 로그인한 날짜와 시간입니다. 데이터 유형: 문자열(날짜/시간)
last_name	연락처 성입니다. 데이터 유형: 문자열 최대 길이: 50
last_position_update	마지막 위치가 업데이트된 날짜와 시간입니다. 데이터 유형: 문자열(날짜/시간)
위도	접촉의 위도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
ldap_server	접촉 창구가 시스템에 마지막으로 로그인하기 위해 사용하는 LDAP 서버의 Sys_id. LDAP 서버 [ldap_server_config] 테이블입니다. 데이터 유형: 문자열
위치	연락처의 위치를 설명하는 기록의 Sys_id. 위치 [cmn_location] 테이블입니다. 데이터 유형: 문자열
locked_out	연락처가 잠겨 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 연락처가 잠겨 있음 false: 연락처가 잠겨 있지 않음 데이터 유형: 부울 기본값: false
경도	접촉 창구의 경도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
매니저	접촉자의 직속 상사를 설명하는 기록의 Sys_id입니다. 사용자 [sys_user] 테이블입니다. 데이터 유형: 문자열
middle_name	연락처 중간 이름. 데이터 유형: 숫자(부동 소수점) 최대 길이: 50
mobile_phone	연락처 휴대 전화 번호. 데이터 유형: 문자열 최대 길이: 40
이름	연락처 성명. 데이터 유형: 문자열 최대 길이: 151
알림	접촉 창구가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. 1: 사용 안 함 2: 사용 데이터 유형: 숫자(정수) 기본값: 2
on_schedule	파견된 서비스 담당자의 적시성을 나타냅니다. 유효한 값은 다음과 같습니다. 앞서: 일정보다 앞서. behind_less30: 일정보다 늦었지만 30분 미만입니다. behind_30to60: 일정보다 늦게 30분에서 60분 사이입니다. behind_more60: 일정보다 60분 이상 지연되었습니다. on_time: 일정대로. 데이터 유형: 문자열 최대 길이: 40
전화	회사 전화번호로 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
사진	접촉 창구의 사진 이미지입니다. 데이터 유형: 이미지
preferred_language	연락처 기본 언어의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
역할	접촉 창구와 연결된 사용자 역할의 목록입니다. 데이터 유형: 문자열 최대 길이: 40
일정	관련 연락처에 대한 작업 일정을 설명하는 기록의 Sys_id. 일정 [cmn_schedule] 테이블 데이터 유형: 문자열
source	연락처의 소스입니다. 데이터 유형: 문자열 최대 길이: 255
상태	연락처가 있는 시/도입니다. 데이터 유형: 문자열 최대 길이: 40
거리	연락처 주소. 데이터 유형: 문자열 최대 길이: 255
sys_class_name	연락처 기록이 들어 있는 테이블입니다. 데이터 유형: 문자열 최대 길이: 80
sys_created_by	연결된 연락처 기록을 원래 만든 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_created_on	연결된 연락처가 원래 생성된 데이터 및 시간입니다. 데이터 유형: 문자열(날짜/시간)
sys_domain	ServiceNow 연결된 연락처 기록의 인스턴스 도메인입니다. 데이터 유형: 문자열
sys_domain_path	연락처 기록 도메인 경로입니다. 데이터 유형: 문자열 최대 길이: 255 기본값: / (전역)
sys_id	연결된 연락처 기록의 고유 식별자입니다. 데이터 유형: 문자열
sys_mod_count	연결된 연락처 레코드가 수정된 횟수입니다. 데이터 유형: 숫자(정수)
sys_updated_by	연결된 연락처 정보를 마지막으로 업데이트한 사용자입니다. 데이터 유형: 문자열 최대 길이: 40
sys_updated_on	관련 연락처 정보가 업데이트된 데이터와 시간입니다. 데이터 유형: 문자열(날짜/시간)
time_format	시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. hh.mm.ss: hh.mm.ss(12시간) hh:mm:ss a: hh:mm:ss(12시간) HH.mm.ss: hh.mm.ss(24시간) HH:mm:ss: hh:mm:ss(24시간) 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식)
time_sheet_policy	연결된 연락처에 대한 타임시트 정책이 포함된 기록의 Sys_id. 타임시트 정책[time_sheet_policy] 테이블입니다. 데이터 유형: 문자열
time_zone	연락처가 있는 시간대(예: 캐나다/중부 또는 미국/동부)입니다. 데이터 유형: 문자열 최대 길이: 40
제목	관리자, 소프트웨어 개발자 또는 계약자와 같은 비즈니스 직위를 문의합니다. 데이터 유형: 문자열 최대 길이: 60
user_name	연락처 사용자 ID입니다. 데이터 유형: 문자열 최대 길이: 40
Vip	연결된 연락처의 VIP 상태 여부를 나타내는 플래그입니다. 가능한 값: true: VIP false: VIP 아님 데이터 유형: 부울 기본값: false
web_service_access_only	연락처가 웹을 통해서만 서비스에 액세스할 수 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 웹 액세스만 false: 사용 가능한 모든 방법을 통해 액세스 데이터 유형: 부울 기본값: false
우편번호	연락처 우편 번호. 데이터 유형: 문자열 최대 길이: 40

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"
  }
}

연락처 - POST /now/contact

새 고객 서비스 관리(CSM) 연락처를 만듭니다.

또한 이 엔드포인트를 사용하여 접촉 창구에 대한 소셜 미디어 프로필을 만들 수 있습니다. 프로필을 만들려면 요청 본문에 다음 매개 변수를 지정해야 합니다.

social_channel
social_handle
social_handle_url

경고:

이 엔드포인트는 과도한 오버헤드를 생성할 수 있으므로 매개변수 유효성 검사를 수행하지 않습니다. 요청 매개 변수의 철자가 틀리거나, 유효하지 않거나, 끝점에서 지원되지 않는 경우 경고 없이 무시됩니다.

URL 형식

버전이 지정된 URL: / api/now/{api_version}/contact

기본 URL: / api/now/contact

지원되는 요청 매개변수

표 13. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수
이름	설명
없음

표 15. 요청 본문 매개변수(XML 또는 JSON)
요소	설명
계정	연락처가 연결된 계정 기록의 Sys_id. 계정 [customer_account] 테이블 데이터 유형: 문자열
활성	연락처가 시스템 내에서 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: true: 접촉 창구가 활성 상태입니다. false: 연락처가 비활성 상태입니다. 데이터 유형: 부울 기본값: true
agent_status	에이전트의 상태입니다. 가능한 값: 퇴근 휴식 중 이동 중 현장 데이터 유형: 문자열 최대 길이: 40
빌드 중	연락처가 거주하는 건물을 설명하는 기록의 Sys_id입니다. 건물 [cmn_building] 테이블. 데이터 유형: 문자열
calendar_integration	접촉 창구가 사용하는 달력 애플리케이션입니다. 1: 전망 데이터 유형: 숫자(정수) 기본값: 1
구/군/시	연락처가 거주하는 구/군/시입니다. 데이터 유형: 문자열 최대 길이: 40
회사	연락처가 연결된 회사 기록의 Sys_id. 회사 [core_company] 테이블입니다. 데이터 유형: 문자열
cost_center	접촉 창구와 연결된 비용 센터의 Sys_id입니다. 비용 센터 [cmn_cost_center] 테이블입니다. 데이터 유형: 문자열
국가	연락처가 위치한 국가의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
date_format	연락처에 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd 데이터 유형: 문자열 최대 길이: 40 기본값: 비어 있음(시스템 날짜 형식)
default_perspective	연락처에 대한 기본 관점의 Sys_id입니다. 메뉴 목록 [sys_perspective] 테이블에 있습니다. 데이터 유형: 문자열
부서	접촉 창구와 관련된 부서의 Sys_id입니다. 부서 [cmn_department] 테이블에 있습니다. 데이터 유형: 문자열
edu_status	연결된 접촉 창구의 학력 상태입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 교수진
이메일	담당자 이메일 주소입니다. 데이터 유형: 문자열
employee_number	연락처 직원 번호입니다. 데이터 유형: 문자열
enable_multifactor_authn	연락처가 Service Portal에 로그인하는 데 다단계 인증이 필요한지 여부를 나타내는 플래그입니다. 가능한 값: true: Multifactor Authorization 사용 false: 다단계 인증이 비활성화됨 데이터 유형: 부울 기본값: false
failed_attempts	실패한 로그인 시도 횟수입니다. 데이터 유형: 숫자(정수)
first_name	연락처 이름. 데이터 유형: 문자열 최대 길이: 50
성별	성별에 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
geolocation_tracked	지오트래킹을 통해 연락처 위치를 가져올지 여부를 나타내는 플래그입니다. 가능한 값: true: 지오트래킹을 통해 얻은 연락처 위치 false: 지오트래킹을 통해 연락처 위치를 얻지 못했습니다. 데이터 유형: 부울 기본값: False
home_phone	집 전화 번호로 연락하십시오. 데이터 유형: 문자열 최대 길이: 40
internal_integration_user	연락처가 내부 통합 사용자인지 여부를 나타내는 플래그입니다. 가능한 값: true: 내부 통합 사용자 false: 기타 유형의 사용자 데이터 유형: 부울 기본값: false
소개	소개 데이터 유형: 문자열 최대 길이: 40
last_login_device	소비자가 시스템에 마지막으로 로그인할 때 사용한 장치입니다. 데이터 유형: 문자열 최대 길이: 40
last_login_time	접촉 창구가 시스템에 로그인한 날짜와 시간입니다. 데이터 유형: 문자열(날짜/시간)
last_name	연락처 성입니다. 데이터 유형: 문자열 최대 길이: 50
위도	접촉의 위도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
ldap_server	접촉 창구가 시스템에 마지막으로 로그인하기 위해 사용하는 LDAP 서버의 Sys_id. LDAP 서버 [ldap_server_config] 테이블입니다. 데이터 유형: 문자열
위치	연락처의 위치를 설명하는 기록의 Sys_id. 위치 [cmn_location] 테이블입니다. 데이터 유형: 문자열
locked_out	연락처가 잠겨 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 연락처가 잠겨 있음 false: 연락처가 잠겨 있지 않음 데이터 유형: 부울 기본값: false
경도	접촉 창구의 경도 좌표입니다. 데이터 유형: 숫자(부동 소수점) 최대 길이: 40
매니저	접촉자의 직속 상사를 설명하는 기록의 Sys_id입니다. 사용자 [sys_user] 테이블입니다. 데이터 유형: 문자열
middle_name	연락처 중간 이름. 데이터 유형: 숫자(부동 소수점) 최대 길이: 50
mobile_phone	연락처 휴대 전화 번호. 데이터 유형: 문자열 최대 길이: 40
이름	연락처 성명. 데이터 유형: 문자열 최대 길이: 151
알림	접촉 창구가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. 1: 사용 안 함 2: 사용 데이터 유형: 숫자(정수) 기본값: 2
on_schedule	파견된 서비스 담당자의 적시성을 나타냅니다. 유효한 값은 다음과 같습니다. 앞서: 일정보다 앞서. behind_less30: 일정보다 늦었지만 30분 미만입니다. behind_30to60: 일정보다 늦게 30분에서 60분 사이입니다. behind_more60: 일정보다 60분 이상 지연되었습니다. on_time: 일정대로. 데이터 유형: 문자열 최대 길이: 40
전화	회사 전화번호로 문의하십시오. 데이터 유형: 문자열 최대 길이: 40
사진	접촉 창구의 사진 이미지입니다. 데이터 유형: 이미지
preferred_language	연락처 기본 언어의 국가 코드입니다. 데이터 유형: 문자열 최대 길이: 3
역할	접촉 창구와 연결된 사용자 역할의 목록입니다. 데이터 유형: 문자열 최대 길이: 40
일정	관련 연락처에 대한 작업 일정을 설명하는 기록의 Sys_id. 일정 [cmn_schedule] 테이블 데이터 유형: 문자열
social_channel	Twitter, Facebook 또는 Instagram과 같이 연락처가 연결된 소셜 미디어 채널입니다. 데이터 유형: 문자열
social_handle	소셜 미디어 채널의 사용자 핸들입니다. 데이터 유형: 문자열
social_handle_url	접촉 창구의 소셜 채널 프로파일에 대한 URL입니다. 데이터 유형: 문자열
source	연락처의 소스입니다. 데이터 유형: 문자열 최대 길이: 255
상태	연락처가 있는 시/도입니다. 데이터 유형: 문자열 최대 길이: 40
거리	연락처 주소. 데이터 유형: 문자열 최대 길이: 255
time_format	시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. hh.mm.ss: hh.mm.ss(12시간) hh:mm:ss a: hh:mm:ss(12시간) HH.mm.ss: hh.mm.ss(24시간) HH:mm:ss: hh:mm:ss(24시간) 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식)
time_sheet_policy	연결된 연락처에 대한 타임시트 정책이 포함된 기록의 Sys_id. 타임시트 정책[time_sheet_policy] 테이블입니다. 데이터 유형: 문자열
time_zone	연락처가 있는 시간대(예: 캐나다/중부 또는 미국/동부)입니다. 데이터 유형: 문자열 최대 길이: 40
제목	관리자, 소프트웨어 개발자 또는 계약자와 같은 비즈니스 직위를 문의합니다. 데이터 유형: 문자열 최대 길이: 60
user_name	연락처 사용자 ID입니다. 데이터 유형: 문자열 최대 길이: 40
Vip	연결된 연락처의 VIP 상태 여부를 나타내는 플래그입니다. 가능한 값: true: VIP false: VIP 아님 데이터 유형: 부울 기본값: false
web_service_access_only	연락처가 웹을 통해서만 서비스에 액세스할 수 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 웹 액세스만 false: 사용 가능한 모든 방법을 통해 액세스 데이터 유형: 부울 기본값: false
우편번호	연락처 우편 번호. 데이터 유형: 문자열 최대 길이: 40

헤더

표 16. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 17. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 18. 상태 코드
상태 코드	설명
201	새 연락처 기록이 성공적으로 생성되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다.

응답 본문 매개변수(JSON 또는 XML)


요소	설명
결과	새로 만든 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열

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"