AWA 에이전트 상담 API

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 4분

    • 에이전트 상담 작업 항목을 처리합니다.

    이 API에는 플러그인(com.glide.awa)과 awa_integration_user 역할이 필요합니다 고급 작업 할당 .

    에 대한 AWA자세한 내용은 고급 작업 할당을 참조하십시오.

    을 사용하여 AWA 제공 작업 API 에이전트 또는 큐로 상담 전송을 시작합니다.

    AWA 에이전트 상담 - PUT /now/awa/consult/end

    문의 작업 항목을 종료합니다.

    문서가 상담이 에이전트에게 전송되면 해당 작업 항목은 적절한 상담 상태(전송됨 또는 종료됨)로 종결되어야 합니다.

    작업 항목은 AWA 에이전트가 처음부터 끝까지 처리하는 단일 작업입니다. 작업 항목은 상호작용 또는 작업과 같은 문서를 기반으로 생성됩니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/awa/consult/end

    기본 URL: /api/now/awa/consult/end

    주:
    사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오.

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(JSON 또는 XML)
    이름 설명
    document_sys_id 문의 작업 항목과 연결된 문서의 Sys_id입니다.

    문서는 상호작용, 케이스 또는 인시던트와 같은 테이블의 기록입니다.

    데이터 유형: 문자열
    hand_over 컨설트 전송을 종료해야 하는지 또는 이전해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 문서를 상담 에이전트에게 전송하고 상담 작업 항목의 상담 상태를 전송됨으로 설정합니다.
    • false: 상담 전송을 종료하고 상담 작업 항목의 상담 상태를종료됨으로 설정합니다.
    주:
    문의 작업 항목의 상담 상태가 요청됨이면 상태가 취소됨으로 변경됩니다.

    데이터 유형: 부울

    헤더

    다음 요청 및 응답 헤더는 이 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. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다.
    가능한 이유:
    • 사용자에게 awa_integration_user 역할이 없습니다.
    • glide.awa.enabled 속성 값이 예가 아닙니다. 고급 작업 할당(com.glide.awa) 플러그인이 설치된 경우 이 속성은 시스템 속성 [sys_property] 테이블에 나열됩니다. 자세한 내용은 고급 작업 할당과 함께 설치되는 구성요소를 참조하십시오.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    성공 종료 상담의 성공 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 종료 상담에 성공했습니다.
    • false: 종료 상담에 실패했습니다.

    데이터 유형: 부울
    메시지 종료 상담의 성공 또는 실패 정보입니다.
    가능한 값:
    • 상담이 성공적으로 종료되었습니다. – 성공.
    • 문서 ID에 대한 작업 항목을 찾을 수 없음: <api_caller_sys_id> – 문서에 대한 활성 문의 작업 항목이 있는지 확인합니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    curl "https://instance.servicenow.com/api/now/awa/consult/end" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
    "document_sys_id": "59616aba87bd5210be070d48dabb35e6",
    "hand_over": "true"
}' \
--user 'username':'password'
    {
  "result": {
    "success": true,
    "message": "Consult is successfully ended."
  }
}