AWA 할당 API

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기4분

    • AWA 할당 API는 에이전트에 작업 항목을 수동으로 할당하는 엔드포인트를 제공합니다.

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

    작업 항목은 에이전트가 처음부터 끝까지 처리 AWA 한 단일 작업입니다. 예를 들어 하나의 채팅 또는 하나의 케이스는 에이전트에게 라우팅되고 할당될 수 있는 객체입니다. 자세한 내용은 Advanced Work Assignment를 참조하십시오.

    AWA 수동 할당 – POST /awa/workitems/{work_item_sys_id}/assignments

    사용 고급 작업 할당 가능한 에이전트에 사용 가능한 작업 항목을 할당합니다.

    이 엔드포인트의 기본 사용 사례는 외부 라우팅 시스템에서 작업 항목을 라우팅할 수 있도록 하는 것입니다. 가 외부 라우팅을 사용하도록 구성된 경우 고급 작업 할당 큐의 작업 항목은 AWA가 아닌 외부 라우팅을 사용하여 할당됩니다. 이 끝점을 호출하여 작업 항목 작업을 할당할 수 있습니다. 자세한 내용은 외부 라우팅 사용을 참조하십시오.

    URL 형식

    버전이 지정된 URL: /now/{api_version}/ awa/workitems/{sys_id}/assignments

    기본 URL: / now/awa/workitems/{sys_id}/assignments

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    work_item_sys_id 사용 가능한 에이전트에 할당할 작업 항목의 Sys_id입니다. 작업 항목 [awa_work_item] 테이블에 있습니다.

    작업 항목은 할당되지 않았으며 수락 보류 중 또는 큐에 대기 상태여야 합니다. 자세한 내용은 할당되지 않은 작업 내용 확인을 참조하십시오.

    유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    agent_sys_id 필수 작업 항목을 받을 수 있는 에이전트의 Sys_id입니다. 에이전트는 사용자[sys_user] 테이블에서 awa_agent 역할을 가진 사용자입니다.

    에이전트를 사용할 수 있는지 확인하는 방법에 대한 자세한 내용은 에이전트 받은 편지함 컨트롤을 참조하십시오.

    유형: 문자열

    머리글

    다음 요청 및 응답 헤더는 이 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 성공입니다. 요청이 성공적으로 처리되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    409 상충됩니다. 제공된 작업 항목 또는 에이전트 sys_id에 오류가 있어 요청을 전달할 수 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    성공

    수동 작업 항목 할당이 성공했는지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.
    • true: 작업 항목 할당이 성공했습니다.
    • false: 작업 항목 할당에 실패했습니다.

    데이터 유형: 부울

    기본값: True
    메시지 성공적인 할당 또는 예외를 승인하는 응답 메시지입니다.
    예외:
    • "작업 항목을 할당할 수 없음" – 제공된 작업 항목이 수락 됨 또는 취소 된 상태이므로 할당할 수 없습니다. 작업 항목 및 AWA 이벤트 확인을 참조하십시오.
    • "<agent_sys_id> 유효한 에이전트가 아닙니다." - 에이전트에 awa_agent 역할이 없습니다.
    • "<work_item_sys_id> 유효한 작업 항목이 아닙니다." - 제공된 작업 항목 sys_id 없습니다.
    • "작업 항목이 이미 <work_item_sys_id>에 할당됨" - 제공된 작업 항목이 다른 에이전트에게 할당되었습니다.
    • "에이전트를 사용할 수 없음" – 에이전트가 AWA에서 사용 가능한 상태가 아닙니다. 에이전트 받은 편지함 컨트롤을 참조하십시오.

    데이터 유형: 문자열

    cURL 요청

    다음 예제에서는 사용 가능한 AWA 에이전트에 작업 항목을 할당하는 방법을 보여 줍니다.

    curl "https://instance.servicenow.com/api/now/awa/workitems/<work_item_sys_id>/assignments" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"agent_sys_id\":\"<agent_sys_id>\"}" \
--user 'username':'password'

    결과는 작업이 에이전트에 성공적으로 할당되었음을 보여줍니다. 작업 항목 [awa_work_item] 테이블의 할당 대상 필드에서 결과를 확인할 수 있습니다.

    {
  "result": {
    "success": true,
    "message": "Manual assignment successfully requested"
  }
}