상호작용 관리 API

Xanadu API 참조

Release

xanadu

ft:locale

ko-KR

ft:publication_title

Xanadu API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

상호작용 관리 API

릴리스 버전: Xanadu

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

읽기10분

상호작용 관리 API는 상호작용을 만들기 위한 엔드포인트를 제공합니다.

이 클래스에는 상호작용 로깅, 라우팅 및 대기열 플러그인(com.glide.interaction)이 필요합니다.

상호작용 - POST /now/interaction

상호작용 테이블에 기록을 삽입하거나 업데이트합니다.

URL 형식

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

기본 URL: /api/now/interaction

지원되는 요청 매개변수

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

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

표 3. 요청 본문 매개변수(XML 또는 JSON)
요소	설명
채널	필수 상호작용을 생성할 상호작용 커넥터의 Sys_id입니다. 데이터 유형: 문자열
컨텍스트	맵 또는 테이블/sys_id 쌍. 기본적으로 상호작용은 컨텍스트 데이터를 JSON 객체로 저장하는 interaction_json_blob 테이블에 기록이 있습니다. 컨텍스트를 위해 상호작용을 다른 기록으로 가리킬 수 있습니다. 컨텍스트 또는 context_table/context_id 사용하여 상호작용에 대한 컨텍스트를 정의합니다. 데이터 유형: 문자열
context_id	컨텍스트를 저장하는 데 사용할 기록의 문서 ID입니다. 기본값은 insteraction_json_blob 테이블의 새 기록입니다. 컨텍스트 ID를 정의하는 경우 테이블도 정의해야 합니다. 데이터 유형: 문자열
context_table	상호작용 컨텍스트를 저장하는 데 사용할 컨텍스트 테이블입니다. 기본값은 interaction_json_blob입니다. 컨텍스트 테이블을 정의하는 경우 컨텍스트 ID도 정의해야 합니다. 데이터 유형: 문자열
channel_metadata	맵 또는 테이블/sys_id 쌍입니다. 채널 메타데이터에는 커넥터가 연결된 채널을 통해 통신하는 데 사용할 수 있는 정보가 포함되어 있습니다. 데이터 유형: 문자열
channel_metadata_id	채널 메타데이터를 저장하는 데 사용할 기록의 문서 ID입니다. 기본값은 live_group_profile 테이블의 새 기록입니다. 채널 메타데이터 ID를 정의하는 경우 테이블도 정의해야 합니다. 데이터 유형: 문자열
channel_metadata_table	채널 메타데이터를 저장하는 데 사용할 테이블입니다. 기본값은 live_group_profile 테이블입니다. 채널 메타데이터 테이블을 정의하는 경우 채널 메타데이터 ID도 정의해야 합니다. 데이터 유형: 문자열
큐	상호작용과 연결하려는 큐의 Sys_id입니다. 데이터 유형: 문자열

헤더

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

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

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

상태 코드

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

표 6. 상태 코드
상태 코드	설명
201	쿼리가 성공적으로 실행되었음을 나타냅니다.
400	요청에서 하나 이상의 필수 매개변수가 누락되었음을 나타냅니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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


요소	설명
assigned_to	상호작용이 할당된 사용자의 sys_id입니다. 데이터 유형: 문자열
channelMetadataDocument (영문)	상호작용과 연결된 채널 메타데이터 문서의 sys_id입니다. 데이터 유형: 문자열
channelMetadataTable (영문)	상호작용과 연결된 채널 메타데이터 테이블의 테이블 이름입니다. 데이터 유형: 문자열
channel_metadata	상호작용에 포함된 채널 메타데이터입니다. 데이터 유형: 문자열
closed_by	상호작용을 종결한 사용자의 sys_id입니다. 데이터 유형: 문자열
컨텍스트 문서	상호작용과 관련된 컨텍스트 문서의 sys_id입니다. 데이터 유형: 문자열
contextTable	상호작용과 관련된 테이블의 이름입니다. 데이터 유형: 문자열
번호	새로운 상호작용의 수입니다. 데이터 유형: 문자열
opened_for	상호작용이 열린 사용자의 sys_id입니다. 데이터 유형: 문자열
큐	상호작용을 생성하는 큐의 sys_id입니다. 데이터 유형: 문자열
상태	상호작용의 상태입니다. 큐를 할당하면 상태가 자동으로 큐에 대기 중으로 변경되고, 그렇지 않으면 기본값은 신규입니다. 데이터 유형: 문자열
sys_id	상호작용의 sys_id입니다. 데이터 유형: 문자열

샘플 cURL 요청

curl "http://instance.servicenow.com/api/now/interaction" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"channel\":\"28a59893873103002ae97e2526cb0b5d\",\"queue\":\"f3a50867b30303002186a72256a8dcb7\"}" \
--user "username":"password"

{
  "result": {
    "channel": "28a59893873103002ae97e2526cb0b5d",
    "context": {
      "present": true
    },
    "queue": "f3a50867b30303002186a72256a8dcb7",
    "state": "queued",
    "number": "IMS0000075",
    "contextDocument": "1863a6f0d9471300964f387107a8a36d",
    "contextTable": "interaction_json_blob",
    "channelMetadataDocument": "9463a6f0d9471300964f387107a8a36c",
    "channelMetadataTable": "live_group_profile",
    "channel_metadata": {
      "present": true
    },
    "sys_id": "dc63a6f0d9471300964f387107a8a36b",
    "assigned_to": "",
    "closed_by": "",
    "opened_for": ""
  }
}

상호작용 - POST /now/interaction/{interaction_id}/close

상호작용의 상태를 종결됨 또는 완료 종결로 변경합니다.