마무리 API

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 69분

    • 마무리 API는 외부 CCaaS(Contact Center as a Service) 시스템 또는 ServiceNow AI Platform 작업 공간에 대한 마무리 기능을 관리하기 위한 엔드포인트를 제공합니다.

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

    에이전트가 상호작용을 종결하면 마무리 기능을 사용하여 나중에 참조할 수 있도록 종결 상세 정보 및 마무리 코드를 입력할 수 있습니다. 마무리 기능에 대한 자세한 내용은 다음 문서를 참조하십시오 Wrap up overview.

    외부 시스템에서 상호 작용의 세그먼트화된 마무리에 마무리 API를 사용하려면 InteractionSegment 스크립팅된 확장점을 구현하여 선택한 테이블에 세그먼트 기록을 만들고 검색해야 합니다. OpenFrame을 사용하는 경우 확장점에는 전화 로그[sn_openframe_phone_log] 테이블에서 세그먼트 기록을 생성하고 검색하는 기존 구현이 있습니다.

    마무리 - GET /now/wrapup/code/{code_id}

    지정된 마무리 코드에 대한 상세 정보를 검색합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/wrapup/code/{code_id}

    기본 URL: /api/now/wrapup/code/{code_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    code_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    결과 API 요청 및 마무리 코드에 대한 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    결과.메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    result.result_map 마무리 코드를 포함하는 객체입니다.

    데이터 유형: 객체

    "result_map": {
   "wrap_up_code": {Object}
}
    result.result_map.wrap_up_code 마무리 코드에 대한 세부 정보가 포함된 객체입니다.

    데이터 유형: 객체

    "wrap_up_code": {
   "active": Boolean,
   "code": "String",
   "description": "String",
   "external": Boolean,
   "sys_id": "String",
   "translated_code": "String",
   "translated_description": "String"
}
    result.result_map.wrap_up_code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    result.result_map.wrap_up_code.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    result.result_map.wrap_up_code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    result.result_map.wrap_up_code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    result.result_map.wrap_up_code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    result.result_map.wrap_up_code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    result.result_map.wrap_up_code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    결과.성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울

    cURL 요청

    이 예에서는 지정된 마무리 코드에 대한 상세 정보를 검색합니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/code/49c27b679f201210c89656effa0a1cd7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    응답 본문.

    {
  "result": {
    "message": "Wrap up code found.",
    "result_map": {
      "wrap_up_code": {
        "code": "Billing Issue",
        "description": "A code for billing issues",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": "Ein code für Abrechnungsprobleme"
      }
    },
    "success": true
  }
}

    마무리 - GET /now/wrapup/segment/{segment_id}

    지정된 마무리 세그먼트에 대한 상세 정보를 조회합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/wrapup/segment/{segment_id}

    기본 URL: /api/now/wrapup/segment/{segment_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    segment_id 상호작용 마무리 세그먼트[interaction_wrap_up_segment] 테이블의 마무리 세그먼트 Sys_id 또는 외부 시스템의 상호작용 세그먼트를 나타내는 식별자입니다.

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    없음
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    세그먼트 상호작용 및 마무리 세그먼트에 대한 데이터를 포함하는 객체입니다.

    데이터 유형: 객체

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent 상호작용에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    segment.awaiting_confirmation 에이전트가 제출한 마무리 세그먼트가 외부 CCaaS 시스템에서 처리되었다는 확인을 기다리고 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 세그먼트가 확인 대기 중입니다.
    • false: 마무리 세그먼트가 외부 시스템에 의해 처리되었습니다.

    데이터 유형: 부울
    segment.confirmed_on 제출된 마무리 세그먼트가 외부 CCaaS 시스템에서 처리된 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.external 상호작용 세그먼트가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 외부 시스템의 상호작용 세그먼트입니다.
    • false: 상호작용 세그먼트가 내부입니다.

    데이터 유형: 부울

    기본값: false
    세그먼트.상호작용 상호작용의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    segment.opened_on 외부 시스템에 따른 마무리 기간의 시작 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.segmented 마무리가 분할되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리가 여러 부분으로 분할됩니다.
    • false: 마무리가 하나의 완전한 세그먼트입니다.

    데이터 유형: 부울

    기본값: false
    segment.segment_id 상호작용 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열
    segment.segment_table 상호작용 세그먼트가 포함된 테이블의 이름입니다.

    데이터 유형: 문자열
    세그먼트.상태 상호작용 세그먼트의 상태입니다.

    데이터 유형: 문자열
    segment.submitted_on 에이전트가 마무리 세그먼트를 제출한 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    segment.wrap_up_configuration 마무리 세그먼트에 사용되는 마무리 구성에 대한 상세 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes 에이전트가 사용할 수 있는 마무리 코드를 각각 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.allowed_codes.코드 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.allowed_codes.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code 기본값으로 사용할 마무리 코드가 포함된 객체입니다.

    데이터 유형: 객체

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.default_code.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.default_code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.enable_codes 에이전트가 마무리 코드를 선택해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에이전트가 마무리 코드를 선택해야 합니다.
    • false: 에이전트가 마무리 코드를 선택할 필요가 없습니다.

    데이터 유형: 부울

    기본값: false
    segment_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울

    cURL 요청

    이 예에서는 지정된 마무리 세그먼트에 대한 상세 정보를 조회합니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/dgajbcef12345678defdbxef123435678" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    응답 본문.

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    마무리 - GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    지정된 에이전트 및 상호작용을 기반으로 마무리 세그먼트에 대한 상세 정보를 검색합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    기본 URL: /api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    agent_id 상호작용에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    interaction_id 상호작용의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    세그먼트 상호작용 및 마무리 세그먼트에 대한 데이터를 포함하는 객체입니다.

    데이터 유형: 객체

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent 상호작용에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    segment.awaiting_confirmation 에이전트가 제출한 마무리 세그먼트가 외부 CCaaS 시스템에서 처리되었다는 확인을 기다리고 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 세그먼트가 확인 대기 중입니다.
    • false: 마무리 세그먼트가 외부 시스템에 의해 처리되었습니다.

    데이터 유형: 부울
    segment.confirmed_on 제출된 마무리 세그먼트가 외부 CCaaS 시스템에서 처리된 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.external 상호작용 세그먼트가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 외부 시스템의 상호작용 세그먼트입니다.
    • false: 상호작용 세그먼트가 내부입니다.

    데이터 유형: 부울

    기본값: false
    세그먼트.상호작용 상호작용의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    segment.opened_on 외부 시스템에 따른 마무리 기간의 시작 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.segmented 마무리가 분할되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리가 여러 부분으로 분할됩니다.
    • false: 마무리가 하나의 완전한 세그먼트입니다.

    데이터 유형: 부울

    기본값: false
    segment.segment_id 상호작용 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열
    segment.segment_table 상호작용 세그먼트가 포함된 테이블의 이름입니다.

    데이터 유형: 문자열
    세그먼트.상태 상호작용 세그먼트의 상태입니다.

    데이터 유형: 문자열
    segment.submitted_on 에이전트가 마무리 세그먼트를 제출한 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    segment.wrap_up_configuration 마무리 세그먼트에 사용되는 마무리 구성에 대한 상세 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes 에이전트가 사용할 수 있는 마무리 코드를 각각 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.allowed_codes.코드 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.allowed_codes.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code 기본값으로 사용할 마무리 코드가 포함된 객체입니다.

    데이터 유형: 객체

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.default_code.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.default_code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.enable_codes 에이전트가 마무리 코드를 선택해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에이전트가 마무리 코드를 선택해야 합니다.
    • false: 에이전트가 마무리 코드를 선택할 필요가 없습니다.

    데이터 유형: 부울

    기본값: false
    segment_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울

    cURL 요청

    이 예에서는 지정된 에이전트 및 상호작용을 기반으로 마무리 세그먼트에 대한 상세 정보를 검색합니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/123412345678567890ab90abcdefcdef/interaction/213412345678567890ab90abcdefcdef" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    응답 본문.

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    마무리 - POST /now/wrapup/code

    마무리 코드를 작성하거나 업데이트합니다.

    마무리 코드는 상호작용 마무리 코드 [interaction_wrap_up_code] 테이블에 생성됩니다.

    URL 형식

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

    기본 URL: /api/now/wrapup/code

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    코드 필수 각각 마무리 코드를 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "translations": [Array]
   }
]
    코드.활성 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    코드.코드 필수 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    코드.설명 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    코드.번역 각각 마무리 코드의 변환을 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "translations": [
   {    
      "code": "Abrechnungsproblem",
      "description": "Ein code für Abrechnungsprobleme",
      "language": "de"
   }
]
    코드.번역.코드 마무리 코드 레이블()codes.code의 번역입니다. 매개변수를 사용하는 경우 필수입니다 codes.translations .

    데이터 유형: 문자열
    codes.translations.description 마무리 코드 설명()codes.description을 번역한 것입니다. 매개변수를 사용하고 codes.translations 에 대한 codes.description값이 제공된 경우 필요합니다.

    데이터 유형: 문자열
    코드.번역.언어 번역에 사용된 언어에 대한 두 글자 코드입니다. 매개변수를 사용하는 경우 필수입니다 codes.translations .

    데이터 유형: 문자열

    헤더

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

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    207 성공입니다. 일부 마무리 코드가 성공적으로 생성되었습니다. 다른 항목을 작성하는 동안 확인 오류가 발생했습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    결과 API 요청 및 생성된 마무리 코드에 대한 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    결과.메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    result.result_map 생성된 마무리 코드의 배열을 포함하는 객체입니다.

    데이터 유형: 객체

    "result_map": {
   "created_wrap_up_codes": [Array]
}
    result.result_map.created_wrap_up_codes 각각 생성된 마무리 코드를 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "created_wrap_up_codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "external": Boolean,
      "sys_id": "String",
      "translated_code": "String",
      "translated_description": "String"
   }
]
    result.result_map.created_wrap_up_codes.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    result.result_map.created_wrap_up_codes.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    result.result_map.created_wrap_up_codes.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    result.result_map.created_wrap_up_codes.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    result.result_map.created_wrap_up_codes.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    result.result_map.created_wrap_up_codes.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    result.result_map.created_wrap_up_codes.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    결과.성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울

    cURL 요청

    이 예에서는 독일어 번역과 함께 청구 문제에 대한 마무리 코드를 만듭니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/code" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"codes\": [
    {
      \"code\": \"Billing Issue\",
      \"description\": \"A code for billing issues\",
      \"translations\": [
        {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\",
          \"description\": \"Ein code für Abrechnungsprobleme\"
        }
      ]
    }
  ]
}" \
--user 'username':'password'

    응답 본문.

    {
  "result": {
    "message": "All wrap up codes created successfully.",
    "result_map": {
      "created_wrap_up_codes": [
        {
          "code": "Billing Issue",
          "description": "A code for billing issues",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": "Ein code für Abrechnungsprobleme"
        }
      ]
    },
    "success": true
  }
}

    마무리 - POST /now/wrapup/segment/create

    상호작용에 대한 마무리 세그먼트를 엽니다.

    마무리는 상호작용 마무리 세그먼트[interaction_wrap_up_segment] 테이블에서 생성됩니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/wrapup/segment/create

    기본 URL: /api/now/wrapup/segment/create

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 26. 쿼리 매개변수
    이름 설명
    없음
    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    agent_sys_id 필수 상호작용에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    구성 외부 마무리에 대한 코드 및 기간 상세 정보를 포함하는 객체입니다. 예인 경우 external 필수입니다.

    데이터 유형: 객체

    "configuration": {  
   "allowed_codes": [Array], 
   "default_code": "String", 
   "duration": "String", 
   "enable_codes": Boolean  
}
    configuration.allowed_codes 에이전트가 사용할 수 있는 마무리 코드를 각각 나타내는 객체의 배열입니다. 과 둘 다 참인 경우 external 필수입니다.configuration.enable_codes

    데이터 유형: 배열

    "allowed_codes": [ 
   { 
      "code": "String", 
      "translation": {Object}  
   } 
]
    configuration.allowed_codes.코드 마무리 코드의 레이블입니다. 매개변수를 사용하는 경우 필수입니다 configuration.allowed_codes .

    데이터 유형: 문자열
    configuration.allowed_codes.번역 마무리 코드의 번역입니다.

    데이터 유형: 객체

    "translation": {  
   "code": "String",
   "language": "String"  
}
    configuration.allowed_codes.translation.code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    configuration.allowed_codes.번역.언어 번역에 사용된 언어에 대한 두 글자 코드입니다.

    데이터 유형: 문자열
    configuration.default_code 기본값으로 사용할 마무리 코드의 레이블입니다. 과 둘 다 참인 경우 external 필수입니다.configuration.enable_codes

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]

    필드: 코드
    configuration.duration 허용되는 최대 마무리 기간입니다.

    데이터 유형: 문자열

    단위: 초

    기본값: 빈 문자열(시간 제한 없음).
    configuration.enable_codes 에이전트가 마무리 코드를 선택해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에이전트가 마무리 코드를 선택해야 합니다.
    • false: 에이전트가 마무리 코드를 선택할 필요가 없습니다.

    데이터 유형: 부울

    기본값: false
    외부 상호작용 세그먼트가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 외부 시스템의 상호작용 세그먼트입니다.
    • false: 상호작용 세그먼트가 내부입니다.

    데이터 유형: 부울

    기본값: false
    external_segment_id 외부 시스템의 상호작용 세그먼트를 나타내는 식별자입니다. 예인 경우 external 필수입니다.

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

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    opened_on 외부 시스템에 따른 마무리 기간의 시작 날짜 및 시간입니다. 매개변수를 사용하는 경우 필수입니다 configuration.duration .

    데이터 유형: 문자열
    세그먼트 마무리가 분할되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리가 여러 부분으로 분할됩니다.
    • false: 마무리가 하나의 완전한 세그먼트입니다.

    데이터 유형: 부울

    기본값: false
    segment_id 상호작용 세그먼트의 Sys_id입니다. 과 둘 다 참인 경우 external 필수입니다.segmented
    주:
    선택한 테이블에서 세그먼트 기록을 만들고 검색하려면 InteractionSegment 스크립팅된 확장점을 구현하거나 OpenFrame 구현을 사용하여 전화 로그 [sn_openframe_phone_log] 테이블에서 세그먼트 기록을 만들고 검색해야 합니다.

    데이터 유형: 문자열
    segment_table 상호작용 세그먼트가 포함된 테이블의 이름입니다. 과 둘 다 참인 경우 external 필수입니다.segmented

    데이터 유형: 문자열
    wrap_up_configuration_sys_id 사용할 마무리 구성의 Sys_id입니다. false인 경우 external 필요합니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 구성 [interaction_wrap_up_configuration]

    헤더

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

    표 28. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 29. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    세그먼트 상호작용 및 마무리 세그먼트에 대한 데이터를 포함하는 객체입니다.

    데이터 유형: 객체

    "segment": {
  "agent": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent 상호작용 세그먼트에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    segment.external 상호작용 세그먼트가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 외부 시스템의 상호작용 세그먼트입니다.
    • false: 상호작용 세그먼트가 내부입니다.

    데이터 유형: 부울

    기본값: false
    세그먼트.상호작용 상호작용의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    segment.opened_on 외부 시스템에 따른 마무리 기간의 시작 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.segmented 마무리가 분할되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리가 여러 부분으로 분할됩니다.
    • false: 마무리가 하나의 완전한 세그먼트입니다.

    데이터 유형: 부울

    기본값: false
    segment.segment_id 상호작용 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열
    segment.segment_table 상호작용 세그먼트가 포함된 테이블의 이름입니다.

    데이터 유형: 문자열
    세그먼트.상태 상호작용 세그먼트의 상태입니다. 마무리 API가 성공적으로 만든 상호작용 세그먼트는 열림 상태입니다.

    데이터 유형: 문자열
    segment.sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    segment.wrap_up_configuration 마무리 세그먼트에 사용되는 마무리 구성에 대한 상세 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes 에이전트가 사용할 수 있는 마무리 코드를 각각 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.allowed_codes.코드 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.allowed_codes.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code 기본값으로 사용할 마무리 코드가 포함된 객체입니다.

    데이터 유형: 객체

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.default_code.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.default_code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.enable_codes 에이전트가 마무리 코드를 선택해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에이전트가 마무리 코드를 선택해야 합니다.
    • false: 에이전트가 마무리 코드를 선택할 필요가 없습니다.

    데이터 유형: 부울

    기본값: false
    성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울
    sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]

    cURL 요청

    이 예에서는 상호작용에 대한 마무리 세그먼트를 엽니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"agent_sys_id\": \"123412345678567890ab90abcdefcdef\",
  \"interaction_sys_id\": \"213412345678567890ab90abcdefcdef\",
  \"external\": \"true\",
  \"segmented\": \"true\",
  \"segment_table\": \"sn_openframe_phone_log\",
  \"segment_id\": \"dgajbcef12345678defdbxef123435678\",
  \"external_segment_id\": \"PL_402548\",
  \"configuration\": {
    \"enable_codes\": true,
    \"allowed_codes\": [
      {
        \"code\": \"Billing Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\"
        }
      },
      {
        \"code\": \"Store Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Einkaufsproblem\"
        }
      }
    ],
    \"default_code\": \"Billing Issue\",
    \"duration\": \"30\"
  },
  \"opened_on\": \"2024-09-16 17:52:01\"
}" \
--user 'username':'password'

    응답 본문.

    {
  "success": true,
  "message": "Open wrap-up segment successfully created.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "98769876543254321fed1fedcba0cba0",
    "opened_on": "2024-09-16 17:52:01"
  }
}

    마무리 - PUT /now/wrapup/segment/update

    상호작용에 대한 마무리 세그먼트를 업데이트하고 닫습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/wrapup/segment/update

    기본 URL: /api/now/wrapup/segment/update

    지원되는 요청 매개변수

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

    데이터 유형: 문자열
    표 32. 쿼리 매개변수
    이름 설명
    agent_sys_id 상호작용에 할당된 에이전트의 Sys_id입니다. 여부와 interaction_sys_id 함께 필요하며 다음도 external_segment_id 제공되지 않습니다segment_sys_id.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    external_segment_id 외부 시스템의 상호작용 세그먼트를 나타내는 식별자입니다. 제공되지 않은 경우 segment_sys_id 업데이트할 마무리 세그먼트를 식별하는 데 사용됩니다.
    interaction_sys_id 상호작용의 Sys_id입니다. 여부와 agent_sys_id 함께 필요하며 다음도 external_segment_id 제공되지 않습니다segment_sys_id.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    segment_sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    표 33. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    confirmed_on 외부 시스템에 따른 마무리 기간의 종료 날짜 및 시간입니다.

    데이터 유형: 문자열
    메모 에이전트가 마무리에 추가한 추가 메모입니다.

    데이터 유형: 문자열
    wrap_up_code 에이전트가 선택한 마무리 코드의 레이블입니다. 에이전트가 코드를 선택하지 않으면 구성된 기본 코드가 사용됩니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]

    필드: 코드

    헤더

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

    표 34. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 35. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

    이름 설명
    메시지 API 요청의 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열
    세그먼트 상호작용 및 마무리 세그먼트에 대한 데이터를 포함하는 객체입니다.

    데이터 유형: 객체

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "code": {Object},
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "notes": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent 상호작용에 할당된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 사용자 [sys_user]
    segment.awaiting_confirmation 에이전트가 제출한 마무리 세그먼트가 외부 CCaaS 시스템에서 처리되었다는 확인을 기다리고 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 세그먼트가 확인 대기 중입니다.
    • false: 마무리 세그먼트가 외부 시스템에 의해 처리되었습니다.

    데이터 유형: 부울
    세그먼트.코드 에이전트가 선택한 마무리 코드를 포함하는 객체입니다.

    데이터 유형: 객체

    "code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    세그먼트.코드.코드 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.confirmed_on 제출된 마무리 세그먼트가 외부 CCaaS 시스템에서 처리된 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.external 상호작용 세그먼트가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 외부 시스템의 상호작용 세그먼트입니다.
    • false: 상호작용 세그먼트가 내부입니다.

    데이터 유형: 부울

    기본값: false
    세그먼트.상호작용 상호작용의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 [interaction]
    segment.notes 에이전트가 마무리에 추가한 추가 메모입니다.

    데이터 유형: 문자열
    segment.opened_on 외부 시스템에 따른 마무리 기간의 시작 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.segmented 마무리가 분할되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리가 여러 부분으로 분할됩니다.
    • false: 마무리가 하나의 완전한 세그먼트입니다.

    데이터 유형: 부울

    기본값: false
    segment.segment_id 상호작용 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열
    segment.segment_table 상호작용 세그먼트가 포함된 테이블의 이름입니다.

    데이터 유형: 문자열
    세그먼트.상태 상호작용 세그먼트의 상태입니다. 이 엔드포인트가 성공적으로 업데이트한 상호작용 세그먼트는 종결 상태입니다.

    데이터 유형: 문자열
    segment.submitted_on 에이전트가 마무리 세그먼트를 제출한 날짜 및 시간입니다.

    데이터 유형: 문자열
    segment.sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]
    segment.wrap_up_configuration 마무리 세그먼트에 사용되는 마무리 구성에 대한 상세 정보를 포함하는 객체입니다.

    데이터 유형: 객체

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes 에이전트가 사용할 수 있는 마무리 코드를 각각 나타내는 객체의 배열입니다.

    데이터 유형: 배열

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.allowed_codes.코드 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.allowed_codes.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.allowed_codes.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code 기본값으로 사용할 마무리 코드가 포함된 객체입니다.

    데이터 유형: 객체

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active 마무리 코드가 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 활성 상태입니다.
    • false: 마무리 코드가 활성화되어 있지 않습니다.

    데이터 유형: 부울

    기본값: true
    segment.wrap_up_configuration.default_code.code 마무리 코드의 레이블입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.description 마무리 코드에 대한 설명입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.external 마무리 코드가 외부 시스템에서 온 것인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 마무리 코드가 외부 시스템에서 가져온 것입니다.
    • false: 마무리 코드가 내부입니다.

    데이터 유형: 부울
    segment.wrap_up_configuration.default_code.sys_id 마무리 코드의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 코드[interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code 마무리 코드 레이블의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.default_code.translated_description 마무리 코드 설명의 번역입니다.

    데이터 유형: 문자열
    segment.wrap_up_configuration.enable_codes 에이전트가 마무리 코드를 선택해야 하는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에이전트가 마무리 코드를 선택해야 합니다.
    • false: 에이전트가 마무리 코드를 선택할 필요가 없습니다.

    데이터 유형: 부울

    기본값: false
    성공 API 요청이 성공적으로 처리되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: API 요청이 성공했습니다.
    • false: API 요청이 실패했습니다.

    데이터 유형: 부울
    sys_id 마무리 세그먼트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 상호작용 마무리 세그먼트 [interaction_wrap_up_segment]

    cURL 요청

    이 예에서는 상호작용에 대한 마무리 세그먼트를 업데이트하고 닫습니다.

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/update?segment_sys_id=98769876543254321fed1fedcba0cba0&agent_sys_id=123412345678567890ab90abcdefcdef&interaction_sys_id=213412345678567890ab90abcdefcde" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"wrap_up_code\": \"Billing Issue\",
  \"notes\": \"Customer's credit card expired. Had to switch to another one.\",
  \"confirmed_on\": \"2024-09-16 18:52:01\"
}" \
--user 'username':'password'

    응답 본문.

    {
  "success": true,
  "message": "Wrap-up segment updated successfully.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "code": {
      "code": "Billing Issue",
      "description": "",
      "active": true,
      "external": true,
      "sys_id": "49c27b679f201210c89656effa0a1cd7",
      "translated_code": "Abrechnungsproblem",
      "translated_description": ""
    },
    "notes": "Customer's credit card expired. Had to switch to another one.",
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}