데이터 추출 API

데이터 추출 API를 통해 외부 보고 목적으로 CXone Mpower에서 데이터를 추출할 수 있습니다. 예를 들어 QM 워크플로 데이터, QM 질문 및 답변 데이터, Recording 인터랙션 메타데이터 또는 WFM 급여 데이터를 추출할 수 있습니다. 데이터는 지정된 날짜 범위에 따라서만 필터링할 수 있습니다.

데이터 추출 API는 개발자 커뮤니티 포털에서 사용할 수 있습니다.

도메인 및 URL에 대한 자세한 내용은 개발자 커뮤니티 포털의 시작하기를 참조하십시오.

POST 메서드로 엔드포인트 /jobs를 호출할 때 데이터가 준비되는 동안 jobId가 반환됩니다, 데이터가 준비되었는지는 엔드포인트 /jobs/{jobId}로부터의 서비스 폴링을 통해 확인할 수 있습니다. 작업의 상태가 반환됩니다. 상태가 성공인 경우에는 추가 URL도 반환됩니다. URL에는 30초 동안 액세스할 수 있습니다(파일 다운로드에 걸린 시간 제외).

매번 데이터를 수동으로 가져오기 보다는 주기적으로 API를 호출하도록 스크립트를 작성할 수 있습니다. 정해진 시간에 테넌트당 한 명의 사용자만이 API를 호출할 수 있습니다. API는 30초에 한 번만 호출할 수 있습니다.

시작하기 전에

비즈니스 데이터 API의 사용을 시작하려면, 사용자 권한을 설정하고, 액세스 키를 생성하고, 개발자 포털에서 설명하는 등록 및 인증 프로세스를 따라야 합니다. 필수 권한:

  • 엔터티:

    • 인터랙션 메타데이터를 추출하는 경우, 검색 및 재생 > API > 인터랙션 메타데이터 추출 권한이 필요합니다.

    • QM 워크플로 데이터를 추출하는 경우, QM 도구 > 데이터 추출 API > QM 워크플로 API 권한이 필요합니다.

    • QM Q&A 데이터를 추출하는 경우, QM 도구 > 데이터 추출 API > QM 워크플로 API 권한이 필요합니다.

    • WFM 급여 데이터를 추출하는 경우, WFM > 데이터 추출 API > WFM 급여 API 권한이 필요합니다.

가져오기 작업

테넌트당 모든 작업 상태의 목록을 봅니다. 가능한 상태는 실행 중, 성공, 실패, 취소만료입니다.

POST 작업

데이터 추출 요청이 전달된 후 데이터를 수집하고 추출을 위해 준비합니다. 데이터는 S3에서 CSV 파일로 24시간 동안 제공됩니다. 완료되면 작업 ID가 반환됩니다.

작업 ID별 GET 작업

작업 ID별로 특정 작업의 상태를 봅니다. 작업에 성공하면, 추출된 데이터에 액세스할 수 있는 URL이 반환되며, 이는 30초 동안 액세스할 수 있습니다(파일 다운로드에 걸린 시간 제외). 작업에 실패하면 오류 메시지가 반환됩니다. 링크를 사용하여 추출된 데이터에 액세스할 수 있습니다. 가능한 작업 상태는 실행 중, 성공, 실패, 취소만료입니다.

QM 워크플로 엔터티 및 CSV 파일

QM 워크플로 API를 사용하면 평가, 자기 평가, 교정을 포함한 QM 워크플로 데이터를 추출할 수 있습니다.

POST 작업의 경우:

  • entityName : qm-workflows

  • version: 4

데이터는 제출 날짜(UTC)에 따라 필터링됩니다.

QM 질문 및 답변(Q&A) 엔터티 및 CSV 파일

QM Q&A API로 QM 평가, 자기 평가 및 교정으로부터 질문 및 답변을 추출할 수 있습니다.

POST 작업의 경우:

  • entityName : qm-questions

  • version: 2

데이터는 제출 날짜(UTC)에 따라 필터링됩니다.

QM 평가자 메모 및 CSV 파일

QM 평가자 메모 API로 QM 평가자 메모를 추출할 수 있습니다.

POST 작업의 경우:

  • entityName : qm-evaluation-comment-entity

  • version: 1

데이터는 제출 날짜(UTC)에 따라 필터링됩니다.

인터랙션 메타데이터 엔터티 및 CSV 파일

인터랙션 메타데이터 API로 Recording 상호작용 메타데이터를 추출할 수 있습니다.

POST 작업의 경우:

  • entityName : recording-interaction-metadata

  • 버전10입니다.

  • 날짜 및 시간별로 데이터를 필터링하려면 yyyy-mm-dd hh:mm:ss 형식의 UTC 기준 startDateendDate 를 사용합니다.

WFM 급여 엔터티 및 CSV 파일

WFM 급여 API(버전 1)를 통해 외부 급여 보고 목적을 위해 WFM 활동 데이터를 추출할 수 있습니다.

POST 작업의 WFM 급여 엔터티 이름은 wfm-payroll입니다.

데이터는 급여 코드의 날짜에 따라 필터링됩니다. 날짜 및 시간의 시간대는 일정 단위의 시간대를 따른다는 점을 유의하십시오.