도움 요청 API

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

    • Help Request API는 감독자 도움말 작업을 추적하는 엔드포인트를 제공합니다.

    이 API는 지원 시작 및 종료 시간 및 도움말 유형을 포함하여 상호작용에 작업하는 에이전트를 위한 감독자 도움말을 기록합니다. 도움 요청에 대한 자세한 내용은 다음 문서를 참조하십시오 Agent help request for voice calls.

    이 API에는 상호작용 관리 플러그인(com.glide.interaction)이 필요합니다. 호출 사용자에게 interaction_integration_user 역할이 있어야 합니다.

    지원 요청 - 게시 /now/helprequest/action/create_or_update

    감독자 도움말 작업을 만들거나 업데이트합니다.

    감독자가 상호작용 도움 요청을 수락할 때 이 엔드포인트를 호출합니다. 감독자 도움말 작업 [supervisor_help_action] 테이블에 도움말을 추적하기 위한 기록이 만들어집니다. 감독자가 도움말을 완료하여 도움말 작업 기록을 종료 시간으로 업데이트할 때 이 엔드포인트를 다시 호출합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/helprequest/action/create_or_update

    기본 URL: /api/now/helprequest/action/create_or_update

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    안 함
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    작업 감독자가 제공하는 지원 유형입니다. 감독자 도움말 작업을 생성할 때 필요합니다.
    유효한 값(대/소문자 구분):
    • barge_in
    • 코치
    • 모니터
    • 관찰하다

    감독자 동작에 대한 자세한 내용은 다음 문서를 참조하십시오 Monitoring calls.

    데이터 유형: 문자열
    action_sys_id 감독자 도움말 작업의 Sys_id입니다.

    지정된 감독자 도움말 작업 하나를 업데이트할 때는 필요하지만 상호작용에 대한 모든 감독자 도움말 작업을 대량 업데이트할 때는 제외할 수 있습니다.

    테이블: 감독자 도움말 작업 [supervisor_help_action]

    데이터 유형: 문자열
    end_time 감독자가 지원을 종료한 날짜 및 시간입니다.
    주:
    지정된 감독자 도움말 작업을 종료 시간으로 업데이트하려면 이 매개변수에 유효한 값을 제공해야 합니다. 그러나 상호작용에 대한 모든 감독자 도움말 작업을 대량 업데이트할 때 이 매개변수를 제외하면 현재 시간이 종료 시간으로 설정됩니다.

    데이터 유형: 문자열
    help_request 상호작용 지원 요청의 Sys_id입니다.

    테이블: 상호작용 도움 요청[interaction_help_request]

    데이터 유형: 문자열
    상호작용 필수 상호작용의 Sys_id입니다.

    테이블: 상호작용 [interaction]

    데이터 유형: 문자열
    start_time 감독자가 지원을 시작한 날짜 및 시간입니다.

    기본값: 감독자 도움말 작업 기록의 생성 날짜 및 시간입니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 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 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    이름 설명
    결과 API 요청의 결과에 대한 상세 정보입니다.

    데이터 유형: 객체

    "result": {
   "action_sys_id": "String",
   "message": "String",
   "success": Boolean  
}
    result.action_sys_id 생성되거나 업데이트된 감독자 도움말 작업의 Sys_id입니다.

    테이블: 감독자 도움말 작업 [supervisor_help_action]

    데이터 유형: 문자열
    결과.메시지 API 요청의 성공 또는 실패에 대한 상세 정보가 포함된 메시지입니다.

    데이터 유형: 문자열
    결과.성공 API 요청의 성공 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 성공
    • false: 실패

    데이터 유형: 부울

    cURL 요청

    이 예에서는 감독자 도움말 작업을 만듭니다.

    curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
   \"action\": \"coach\"
}" \
--user 'username':'password'

    응답 본문.

    {
  "result": {
    "success": true,
    "message": "Supervisor help action created successfully",
    "action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
  }
}

    cURL 요청

    이 예에서는 감독자 도움말 작업을 종료 시간으로 업데이트합니다.

    curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
   \"action_sys_id\": \"d25f034f3b4bfe101baa9f7e53e45a9f\",
   \"end_time\": \"2026-02-18 11:30:00\"
}" \
--user 'username':'password'

    응답 본문.

    {
  "result": {
    "success": true,
    "message": "Supervisor help action updated successfully",
    "action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
  }
}

    cURL 요청

    이 예에서는 종료 시간이 있는 상호작용에 대한 모든 감독자 도움말 작업을 업데이트합니다.

    curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"interaction\": \"cd87db433bcbfe101baa9f7e53e45a4d\",
   \"end_time\": \"2026-02-18 11:24:18\"
}" \
--user 'username':'password'

    응답 본문.

    {
  "result": {
    "success": true,
    "message": "end_time updated for all supervisor help actions associated with the interaction id: cd87db433bcbfe101baa9f7e53e45a4d"
  }
}