---
sourceDocument: Xanadu API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ko-KR
ft:publication_title :
- Xanadu API 참조
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 소비자 API
# 소비자 API {#ariaid-title1}
* 릴리스 버전: Xanadu
*
* 업데이트 날짜 2024년 08월 01일
*
*  소요 시간: 24분
소비자 API는 소비자 기록을 검색하고 업데이트 고객 서비스 관리(CSM) 하는 엔드포인트를 제공합니다.
또한 소비자를 생성할 때 새 소셜 미디어 프로파일 기록을 생성할 수 있습니다.
소비자 API를 사용하려면 고객 서비스 플러그인(com.sn_customerservice)이 필요하며 이 플러그인은 `now` 네임스페이스 내에서 제공됩니다.
사용자는 전체 API 액세스를 위해 csm_ws_integration 역할이 필요합니다.
## 소비자 - GET /now/consumer {#ariaid-title2}
지정된 소비자 기록 세트를 고객 서비스 관리(CSM) 조회합니다.
### URL 형식
버전이 지정된 URL: /api/now/{api_version}/consumer
기본 URL: /api/now/consumer
### 지원되는 요청 매개변수
{#consumer-GET__entry__2}{#consumer-GET__version-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
[표 1. 경로 매개변수]
{#consumer-GET__entry__6}{#consumer-GET__sysparm-limit-entry}{#consumer-GET__sysparm-offset-entry}{#consumer-GET__sysparm-query-entry}
| 이름 | 설명 |
|-|-|
| 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=예` 인코딩된 쿼리는 정렬 기준을 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 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 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
[표 2. 쿼리 매개변수]
{#consumer-GET__entry__14}
| 요소 | 설명 |
|-|-|
| 없음 | |
[표 3. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-GET__entry__18}{#consumer-GET__accept-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 4. 요청 헤더]
{#consumer-GET__entry__22}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 5. 응답 헤더]
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-GET__entry__26}{#consumer-GET__entry-200-status-code}{#consumer-GET__entry-401-status-code}{#consumer-GET__entry-404-status-code}{#consumer-GET__entry-500-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 6. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
엔드포인트는 응답 본문에 다음 JSON 또는 XML 요소를 반환할 수 있습니다. 아래에 정의된 요소 목록(기본 시스템의 요소를 정의함) 외에도 엔드포인트는 소비자 \[csm_consumer\] 테이블에 추가된 사용자 지정 필드도 반환합니다. 이러한 요소에 대한 자세한 내용은 특정 테이블 정의\[시스템 정의테이블\].
{#consumer-GET__csmconsumer_response_parms__entry__2}{#consumer-GET__consumertable-active-entry}{#consumer-GET__consumertable-business_phone-entry}{#consumer-GET__consumertable-city-entry}{#consumer-GET__consumertable-country-entry}{#consumer-GET__consumertable-date_format-entry}{#consumer-GET__consumertable-email-entry}{#consumer-GET__consumertable-fax-entry}{#consumer-GET__consumertable-first_name-entry}{#consumer-GET__consumertable-gender-entry}{#consumer-GET__consumertable-home_phone-entry}{#consumer-GET__consumertable-household-entry}{#consumer-GET__consumertable-last_name-entry}{#consumer-GET__consumertable-middle_name-entry}{#consumer-GET__consumertable-mobile_phone-entry}{#consumer-GET__consumertable-name-entry}{#consumer-GET__consumertable-notes-entry}{#consumer-GET__consumertable-notification-entry}{#consumer-GET__consumertable-number-entry}{#consumer-GET__consumertable-photo-entry}{#consumer-GET__consumertable-preferred_language-entry}{#consumer-GET__consumertable-prefix-entry}{#consumer-GET__consumertable-primary-entry}{#consumer-GET__consumertable-state-entry}{#consumer-GET__consumertable-street-entry}{#consumer-GET__consumertable-suffix-entry}{#consumer-GET__consumertable-sys_created_by-entry}{#consumer-GET__consumertable-sys_created_on-entry}{#consumer-GET__consumertable-sys_domain-entry}{#consumer-GET__consumertable-sys_id-entry}{#consumer-GET__consumertable-sys_mod_count-entry}{#consumer-GET__consumertable-sys_updated_by-entry}{#consumer-GET__consumertable-sys_updated_on-entry}{#consumer-GET__consumertable-time_format-entry}{#consumer-GET__consumertable-time_zone-entry}{#consumer-GET__consumertable-title-entry}{#consumer-GET__consumertable-user-entry}{#consumer-GET__consumertable-zip-entry}
| 요소 | 설명 |
|-|-|
| active | 소비자가 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 소비자 활성 * false: 소비자가 비활성화됨 {#consumer-GET__ul_asy_4b3_2hb} 데이터 유형: 부울 기본값: true |
| business_phone | 소비자의 직장 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 구/군/시 | 소비자가 거주하는 도시입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 국가 | 소비자가 거주하는 국가입니다. 데이터 유형: 문자열 최대 길이: 40 |
| date_format | 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-GET__ul_jsj_qwc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 날짜 형식) |
| 이메일 | 소비자의 이메일 주소입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 팩스 | 소비자의 팩스 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| first_name | 소비자 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| 성별 | 소비자의 성별입니다. 데이터 유형: 문자열 최대 길이: 40 |
| home_phone | 소비자의 집 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| household | 세대 특성을 설명하는 기록의 Sys_id입니다. 세대\[csm_household\] 테이블에 있습니다. 데이터 유형: 문자열 |
| last_name | 소비자 성입니다. 데이터 유형: 문자열 최대 길이: 50 |
| middle_name | 소비자 중간 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| mobile_phone | 소비자 휴대폰 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 이름 | 소비자 전체 이름; first_name+middle_name+last_name. 데이터 유형: 문자열 최대 길이: 152 |
| 메모 | 소비자에 대한 참고 사항입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| 알림 | 소비자가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. * 1: 비활성화 * 2: 사용 {#consumer-GET__ul_o5d_pyh_2hb} 데이터 형식: 정수 최대 길이: 40 기본값: 2 |
| 번호 | 소비자와 연결된 고유 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 사진 | 소비자 사진. 데이터 형식: 이미지 |
| preferred_language | 소비자 기본 언어입니다. 데이터 유형: 문자열 최대 길이: 3 |
| 프리픽스 | Dr., Mr., Mrs. 또는 Ms.와 같은 소비자 이름 프리픽스 데이터 유형: 문자열 최대 길이: 40 |
| 기본 | 기본 소비자인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 기본 소비자 * false: 기본 소비자가 아님 {#consumer-GET__ul_yns_yb3_2hb} 데이터 유형: 부울 기본값: false |
| 상태 | 소비자가 거주하는 주입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 주소 | 소비자 주소입니다. 데이터 유형: 문자열 최대 길이: 255 |
| 접미사 | Jr., Sr. 또는 II와 같은 소비자 이름 서픽스. 데이터 유형: 문자열 |
| sys_created_by | 소비자 기록을 만든 사용자입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_created_on | 소비자 기록이 원래 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sys_domain | ServiceNow 소비자 정보가 있는 도메인입니다. 데이터 유형: 문자열 |
| sys_id | 소비자의 고유 식별자입니다. 데이터 유형: 문자열 |
| sys_mod_count | 관련 소비자 정보가 수정된 횟수입니다. 데이터 형식: 정수 |
| sys_tags | 시스템 태그입니다. 데이터 유형: 문자열 |
| sys_updated_by | 소비자 정보를 마지막으로 업데이트한 사용자입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_updated_on | 소비자 정보가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| time_format | 시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. * hh.mm.ss a: 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시간) {#consumer-GET__ul_kvg_gxc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식) |
| time_zone | 소비자 시간대(예: 캐나다/중부 또는 미국/동부) 데이터 유형: 문자열 최대 길이: 40 |
| 제목 | 관리자, 소프트웨어 개발자 또는 계약자와 같은 소비자 비즈니스 직함입니다. 데이터 유형: 문자열 최대 길이: 60 |
| 사용자 | 소비자 사용자의 Sys_id입니다. 소비자 사용자 \[csm_consumer_user\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 우편번호 | 소비자 우편 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
[ ]
### cURL 요청
curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": [
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
},
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "San Francisco",
"prefix": "",
"sys_updated_on": "2016-08-12 00:20:27",
"suffix": "",
"title": "",
"number": "CSMR0000002",
"notification": "2",
"sys_id": "a0488cfbdb1b1200b6075200cf9619db",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "144 2nd St",
"sys_created_on": "2016-06-16 19:17:44",
"sys_domain": "global",
"state": "CA",
"fax": "",
"first_name": "Sam",
"email": "sam.collins@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "94105",
"home_phone": "",
"time_format": "",
"sys_mod_count": "13",
"last_name": "Collins",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Sam Collins",
"household": "",
"date_format": "",
"user": "64488cfbdb1b1200b6075200cf9619db",
"primary": "false"
}
]
}
## 소비자 - GET /now/consumer/{id} {#ariaid-title3}
지정된 고객 서비스 관리(CSM) 소비자 기록을 조회합니다.
### URL 형식
버전이 지정된 URL: /api/now/{api_version}/consumer/{id}
기본 URL: /api/now/consumer/{id}
### 지원되는 요청 매개변수
{#consumer-GET-id__entry__2}{#consumer-GET-id__version-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| id | 반환할 소비자 기록의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
[표 7. 경로 매개변수]
{#consumer-GET-id__entry__8}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 8. 쿼리 매개변수]
{#consumer-GET-id__entry__12}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 9. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-GET-id__entry__16}{#consumer-GET-id__accept-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 10. 요청 헤더]
{#consumer-GET-id__entry__20}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 11. 응답 헤더]
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-GET-id__entry__24}{#consumer-GET-id__entry-200-status-code}{#consumer-GET-id__entry-401-status-code}{#consumer-GET-id__entry-500-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 요청이 잘못되었음을 나타냅니다. 다음 이유 중 하나 때문일 수 있습니다. * 요청한 케이스가 없습니다. * 사용자에게 소비자 기록에 대한 액세스 권한이 없습니다. {#consumer-GET-id__ul_ubm_1jl_3v} |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 12. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
엔드포인트는 응답 본문에 다음 JSON 또는 XML 요소를 반환할 수 있습니다. 아래에 정의된 요소 목록(기본 시스템의 요소를 정의함) 외에도 엔드포인트는 소비자 \[csm_consumer\] 테이블에 추가된 사용자 지정 필드도 반환합니다. 이러한 요소에 대한 자세한 내용은 특정 테이블 정의\[시스템 정의테이블\].
{#consumer-GET-id__csmconsumer_response_parms__entry__2}{#consumer-GET-id__consumertable-active-entry}{#consumer-GET-id__consumertable-business_phone-entry}{#consumer-GET-id__consumertable-city-entry}{#consumer-GET-id__consumertable-country-entry}{#consumer-GET-id__consumertable-date_format-entry}{#consumer-GET-id__consumertable-email-entry}{#consumer-GET-id__consumertable-fax-entry}{#consumer-GET-id__consumertable-first_name-entry}{#consumer-GET-id__consumertable-gender-entry}{#consumer-GET-id__consumertable-home_phone-entry}{#consumer-GET-id__consumertable-household-entry}{#consumer-GET-id__consumertable-last_name-entry}{#consumer-GET-id__consumertable-middle_name-entry}{#consumer-GET-id__consumertable-mobile_phone-entry}{#consumer-GET-id__consumertable-name-entry}{#consumer-GET-id__consumertable-notes-entry}{#consumer-GET-id__consumertable-notification-entry}{#consumer-GET-id__consumertable-number-entry}{#consumer-GET-id__consumertable-photo-entry}{#consumer-GET-id__consumertable-preferred_language-entry}{#consumer-GET-id__consumertable-prefix-entry}{#consumer-GET-id__consumertable-primary-entry}{#consumer-GET-id__consumertable-state-entry}{#consumer-GET-id__consumertable-street-entry}{#consumer-GET-id__consumertable-suffix-entry}{#consumer-GET-id__consumertable-sys_created_by-entry}{#consumer-GET-id__consumertable-sys_created_on-entry}{#consumer-GET-id__consumertable-sys_domain-entry}{#consumer-GET-id__consumertable-sys_id-entry}{#consumer-GET-id__consumertable-sys_mod_count-entry}{#consumer-GET-id__consumertable-sys_updated_by-entry}{#consumer-GET-id__consumertable-sys_updated_on-entry}{#consumer-GET-id__consumertable-time_format-entry}{#consumer-GET-id__consumertable-time_zone-entry}{#consumer-GET-id__consumertable-title-entry}{#consumer-GET-id__consumertable-user-entry}{#consumer-GET-id__consumertable-zip-entry}
| 요소 | 설명 |
|-|-|
| active | 소비자가 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 소비자 활성 * false: 소비자가 비활성화됨 {#consumer-GET-id__ul_asy_4b3_2hb} 데이터 유형: 부울 기본값: true |
| business_phone | 소비자의 직장 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 구/군/시 | 소비자가 거주하는 도시입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 국가 | 소비자가 거주하는 국가입니다. 데이터 유형: 문자열 최대 길이: 40 |
| date_format | 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-GET-id__ul_jsj_qwc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 날짜 형식) |
| 이메일 | 소비자의 이메일 주소입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 팩스 | 소비자의 팩스 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| first_name | 소비자 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| 성별 | 소비자의 성별입니다. 데이터 유형: 문자열 최대 길이: 40 |
| home_phone | 소비자의 집 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| household | 세대 특성을 설명하는 기록의 Sys_id입니다. 세대\[csm_household\] 테이블에 있습니다. 데이터 유형: 문자열 |
| last_name | 소비자 성입니다. 데이터 유형: 문자열 최대 길이: 50 |
| middle_name | 소비자 중간 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| mobile_phone | 소비자 휴대폰 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 이름 | 소비자 전체 이름; first_name+middle_name+last_name. 데이터 유형: 문자열 최대 길이: 152 |
| 메모 | 소비자에 대한 참고 사항입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| 알림 | 소비자가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. * 1: 비활성화 * 2: 사용 {#consumer-GET-id__ul_o5d_pyh_2hb} 데이터 형식: 정수 최대 길이: 40 기본값: 2 |
| 번호 | 소비자와 연결된 고유 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 사진 | 소비자 사진. 데이터 형식: 이미지 |
| preferred_language | 소비자 기본 언어입니다. 데이터 유형: 문자열 최대 길이: 3 |
| 프리픽스 | Dr., Mr., Mrs. 또는 Ms.와 같은 소비자 이름 프리픽스 데이터 유형: 문자열 최대 길이: 40 |
| 기본 | 기본 소비자인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 기본 소비자 * false: 기본 소비자가 아님 {#consumer-GET-id__ul_yns_yb3_2hb} 데이터 유형: 부울 기본값: false |
| 상태 | 소비자가 거주하는 주입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 주소 | 소비자 주소입니다. 데이터 유형: 문자열 최대 길이: 255 |
| 접미사 | Jr., Sr. 또는 II와 같은 소비자 이름 서픽스. 데이터 유형: 문자열 |
| sys_created_by | 소비자 기록을 만든 사용자입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_created_on | 소비자 기록이 원래 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sys_domain | ServiceNow 소비자 정보가 있는 도메인입니다. 데이터 유형: 문자열 |
| sys_id | 소비자의 고유 식별자입니다. 데이터 유형: 문자열 |
| sys_mod_count | 관련 소비자 정보가 수정된 횟수입니다. 데이터 형식: 정수 |
| sys_updated_by | 소비자 정보를 마지막으로 업데이트한 사용자입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_updated_on | 소비자 정보가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| time_format | 시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. * hh.mm.ss a: 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시간) {#consumer-GET-id__ul_kvg_gxc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식) |
| time_zone | 소비자 시간대(예: 캐나다/중부 또는 미국/동부) 데이터 유형: 문자열 최대 길이: 40 |
| 제목 | 관리자, 소프트웨어 개발자 또는 계약자와 같은 소비자 비즈니스 직함입니다. 데이터 유형: 문자열 최대 길이: 60 |
| 사용자 | 소비자 사용자의 Sys_id입니다. 소비자 사용자 \[csm_consumer_user\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 우편번호 | 소비자 우편 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
[ ]
### cURL 요청
curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
}
}
## 소비자 - POST /now/consumer {#ariaid-title4}
새 고객 서비스 관리(CSM) 소비자를 만듭니다.
또한 이 엔드포인트를 사용하여 소비자에 대한 소셜 미디어 프로파일을 생성할 수 있습니다. 프로필을 만들려면 요청 본문에 다음 매개 변수를 지정해야 합니다.
* social_channel
* social_handle
* social_handle_url
{#consumer-POST__ul_ntx_lg4_pgb}
경고:
이 엔드포인트는 과도한 오버헤드가 발생할 수 있으므로 매개변수 유효성 검사를 수행하지 않습니다. 요청 매개 변수의 철자가 틀리거나, 유효하지 않거나, 엔드포인트에서 지원되지 않는 경우 경고 없이 무시됩니다.
### URL 형식
버전이 지정된 URL: /api/now/{api_version}/consumer
기본 URL: /api/now/consumer
### 지원되는 요청 매개변수
{#consumer-POST__entry__2}{#consumer-POST__version-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
[표 13. 경로 매개변수]
{#consumer-POST__entry__6}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 14. 쿼리 매개변수]
{#consumer-POST__entry__10}{#consumer-POST__consumertable-active-entry}{#consumer-POST__consumertable-business_phone-entry}{#consumer-POST__consumertable-city-entry}{#consumer-POST__consumertable-country-entry}{#consumer-POST__consumertable-date_format-entry}{#consumer-POST__consumertable-email-entry}{#consumer-POST__consumertable-fax-entry}{#consumer-POST__consumertable-first_name-entry}{#consumer-POST__consumertable-gender-entry}{#consumer-POST__consumertable-home_phone-entry}{#consumer-POST__consumertable-household-entry}{#consumer-POST__consumertable-last_name-entry}{#consumer-POST__consumertable-middle_name-entry}{#consumer-POST__consumertable-mobile_phone-entry}{#consumer-POST__consumertable-name-entry}{#consumer-POST__consumertable-notes-entry}{#consumer-POST__consumertable-notification-entry}{#consumer-POST__consumertable-photo-entry}{#consumer-POST__consumertable-preferred_language-entry}{#consumer-POST__consumertable-prefix-entry}{#consumer-POST__consumertable-primary-entry}{#consumer-POST__consumertable-state-entry}{#consumer-POST__consumertable-street-entry}{#consumer-POST__consumertable-suffix-entry}{#consumer-POST__consumertable-time_format-entry}{#consumer-POST__consumertable-time_zone-entry}{#consumer-POST__consumertable-title-entry}{#consumer-POST__consumertable-user-entry}{#consumer-POST__consumertable-zip-entry}
| 요소 | 설명 |
|-|-|
| active | 소비자가 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 소비자 활성 * false: 소비자가 비활성화됨 {#consumer-POST__ul_asy_4b3_2hb} 데이터 유형: 부울 기본값: true |
| business_phone | 소비자의 직장 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 구/군/시 | 소비자가 거주하는 도시입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 국가 | 소비자가 거주하는 국가입니다. 데이터 유형: 문자열 최대 길이: 40 |
| date_format | 날짜를 표시할 형식입니다. 유효한 값은 다음과 같습니다. * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-POST__ul_jsj_qwc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 날짜 형식) |
| 이메일 | 소비자의 이메일 주소입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 팩스 | 소비자의 팩스 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| first_name | 소비자 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| 성별 | 소비자의 성별입니다. 데이터 유형: 문자열 최대 길이: 40 |
| home_phone | 소비자의 집 전화 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| household | 세대 특성을 설명하는 기록의 Sys_id입니다. 세대\[csm_household\] 테이블에 있습니다. 데이터 유형: 문자열 |
| last_name | 소비자 성입니다. 데이터 유형: 문자열 최대 길이: 50 |
| middle_name | 소비자 중간 이름입니다. 데이터 유형: 문자열 최대 길이: 50 |
| mobile_phone | 소비자 휴대폰 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 이름 | 소비자 전체 이름; first_name+middle_name+last_name. 데이터 유형: 문자열 최대 길이: 152 |
| 메모 | 소비자에 대한 참고 사항입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| 알림 | 소비자가 알림을 받아야 하는지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. * 1: 비활성화 * 2: 사용 {#consumer-POST__ul_o5d_pyh_2hb} 데이터 형식: 정수 최대 길이: 40 기본값: 2 |
| 사진 | 소비자 사진. 데이터 형식: 이미지 |
| preferred_language | 소비자 기본 언어입니다. 데이터 유형: 문자열 최대 길이: 3 |
| 프리픽스 | Dr., Mr., Mrs. 또는 Ms.와 같은 소비자 이름 프리픽스 데이터 유형: 문자열 최대 길이: 40 |
| 기본 | 기본 소비자인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 기본 소비자 * false: 기본 소비자가 아님 {#consumer-POST__ul_yns_yb3_2hb} 데이터 유형: 부울 기본값: false |
| social_channel | Twitter, Facebook 또는 Instagram과 같이 소비자와 연결된 소셜 미디어 채널입니다. 데이터 유형: 문자열 |
| social_handle | 소셜 미디어 채널의 사용자 핸들입니다. 데이터 유형: 문자열 |
| social_handle_url | 소비자의 소셜 채널 핸들에 대한 URL입니다. 데이터 유형: 문자열 |
| 상태 | 소비자가 거주하는 주입니다. 데이터 유형: 문자열 최대 길이: 100 |
| 주소 | 소비자 주소입니다. 데이터 유형: 문자열 최대 길이: 255 |
| 접미사 | Jr., Sr. 또는 II와 같은 소비자 이름 서픽스. 데이터 유형: 문자열 |
| time_format | 시간을 표시할 형식입니다. 유효한 값은 다음과 같습니다. * hh.mm.ss a: 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시간) {#consumer-POST__ul_kvg_gxc_2hb} 데이터 유형: 문자열 최대 길이: 40 기본값: 공백(시스템 시간 형식) |
| time_zone | 소비자 시간대(예: 캐나다/중부 또는 미국/동부) 데이터 유형: 문자열 최대 길이: 40 |
| 제목 | 관리자, 소프트웨어 개발자 또는 계약자와 같은 소비자 비즈니스 직함입니다. 데이터 유형: 문자열 최대 길이: 60 |
| 사용자 | 소비자 사용자의 Sys_id입니다. 소비자 사용자 \[csm_consumer_user\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 우편번호 | 소비자 우편 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
[표 15. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-POST__entry__76}{#consumer-POST__accept-JSON-only-entry-RESTAPI}{#consumer-POST__content_type-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 16. 요청 헤더]
{#consumer-POST__entry__82}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 17. 응답 헤더]
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#consumer-POST__entry__86}{#consumer-POST__entry-401-status-code}
| 상태 코드 | 설명 |
|-|-|
| 201 | 새 소비자 기록이 성공적으로 생성되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 측 코드에서 논리 오류가 발생했습니다. |
[표 18. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
{#consumer-POST__entry__96}
| 요소 | 설명 |
|-|-|
| 결과 | 새로 생성된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 |
[ ]
### cURL 요청
curl -X POST "https://instance.servicenow.com/api/now/consumer" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d " { \
"country": "USA", \
"notes": "Never comes in before 10am", \
"gender": "Female", \
"city": "San Marcos", \
"prefix": "Ms", \
"title": "Director", \
"notification": "1", \
"business_phone": "(555)555-1234", \
"mobile_phone": "(555)555-1235", \
"street": "123 Sesame St", \
"state": "CA", \
"fax": "(555)555-1236", \
"first_name": "Jane", \
"zip": "92001", \
"home_phone": "(555)555-1234", \
"last_name": "Brown", \
"active": "true", \
"middle_name": "Dell", \
"time_zone": "PST", \
"name": "Jane Brown", \
"household": "4", \
"user": "c3d35d82c37122005871d44d81d3ae91", \
"primary": "false" \
}"
--user "username":"password"
{
"result": "0f5c13addb93230057c3fd441d9619b8"
}