API 프레임워크 작업

API 프레임워크 작업은 스크립트에서 CXone API를 사용할 수 있게 지원하는 Studio 작업입니다. 스니펫 또는 RestAPI 작업 사용 등 기존 통합 메서드를 사용하여 API를 호출하는 대신 이 작업을 사용할 수 있습니다. API 작업은 모두 Studio의 프레임워크 탭에 있습니다.

API 작업은 표준 Studio 작업과 다릅니다. 현재 온라인 도움말에 문서화되어 있지 않습니다. 하지만, API 작업에 해당하는 API는 CXone 개발자 포털중앙에서 우측 상단으로 향하는 화살표가 있는 정사각형입니다.에 문서화되어 있습니다. 스크립트에서 API 작업을 수행할 때 이 문서를 활용할 수 있습니다.

일부 CXone API의 경우 Studio에 해당하는 API 작업이 없습니다.

API 작업에는 보안 사용자가 필요합니다. SETSECURITYUSER 작업으로 스크립트에 있는 보안 사용자를 설정할 수 있습니다.

API 작업 버전

CXone API의 새 버전이 출시되면 해당하는 작업의 새로운 버전이 Studio에 출시될 수 있습니다. 일반적으로는 작업의 최신 버전을 사용하는 것이 좋습니다. 대부분의 경우 오래된 버전도 계속 작동합니다. 다양한 버전을 사용해 보면서 제대로 작동하며 필요한 기능을 제공하는 버전을 찾아볼 수 있습니다.

일부 API 작업은 작업 이름에 버전이 포함되어 있습니다. 프레임워크 탭에서 작업의 트리 구조를 볼 때 확인할 수 있습니다. 일부 API 작업에는 버전 번호가 포함되어 있지 않습니다. 이러한 작업의 경우, 작업의 확장 속성에서 버전을 확인할 수 있습니다. 작업이 프레임워크 탭에서 선택되었을 때만 속성 탭에서 확장 속성을 볼 수 있습니다.

모든 API의 모든 버전에 해당하는 작업이 Studio에 모두 존재하지는 않습니다.

API 작업 확장 속성 보기

작업이 프레임워크에서 선택되며, 확장 속성이 속성 탭에 표시됩니다.

  1. Studio에서 속성 탭과 프레임워크 탭을 동시에 볼 수 있도록 탭을 재정렬합니다.
  2. 프레임워크 탭에서 API 작업을 클릭합니다.
  3. 이제 속성 탭에서 작업의 확장 속성을 볼 수 있습니다. API 작업에 관해 알아볼 때는 다음과 같은 속성이 특히 유용합니다. 
    • 기타 > 매개 변수 > Verb: 이 속성에서는 작업과 관련된 메서드, 즉 동사가 표시됩니다.
    • 기타 > 매개 변수 > Version: 이 속성은 API 버전을 표시합니다.
    • 기타 > 웹 > URI: 이 속성은 개발자 포털의 API 문서를 찾을 때 유용할 수 있습니다.

    • 기타 > 매개 변수: 매개 변수 섹션에서 속성을 확장하면 각 작업의 속성에 관한 추가 정보를 볼 수 있습니다.

API 문서 찾기

CXone API는 CXone 개발자 포털에 표시됩니다. Studio의 API 작업에는 API에 해당하는 문서로 직접 연결되는 링크가 없습니다. 하지만, 작업의 확장 속성에 있는 정보를 활용하면 문서의 위치를 찾는 데 도움이 됩니다.

URI를 사용하려면 CXone 시스템 전체와 다양한 CXone API에 대해 전반적으로 익숙해야 합니다. 어떤 API가 Studio의 어떤 작업과 일치하는지 판단하는 일은 항상 직관적이지는 않기 떄문입니다. CXone을(를) 통하여 컨택의 일반적인 흐름을 파악하면 작업의 URI를 올바르게 해석하고 거기서 찾은 단서를 개발자 포털의 API 문서 구조에 적용하는 데 도움이 됩니다. 이 섹션의 예는 필요할 수 있는 해석을 보여줍니다.

개발자 포털 API 섹션의 홈페이지에서는 각 CXone API의 개요가 제공됩니다.

예 1

가끔은 작업과 API 사이에 직접적인 상관관계가 있습니다.

작업의 이름과 URI에 따라 고려해야 할 첫 두 가지의 API는 상담원 API와 관리자 API입니다. 각각에 대한 API 호출 목록을 보면 상담원 API를 제거할 수 있습니다. 이 API의 설명을 보면 상담원 세션을 관리하는 데 사용되며, 다음 이미지처럼 스킬과 관련된 호출이 없는 것으로 보입니다.

개발자 포털의 상담원 API에 대한 API 호출 목록입니다.

관리자 API는 스킬과 같은 시스템 개체와 작동하는 것으로 나타나 있습니다. 다음 이미지처럼 이 API에서 사용 가능한 API 호출 목록에는 스킬이 포함되어 있습니다.

개발자 포털 문서의 관리자 API에서 사용 가능한 호출 목록입니다.

스킬 섹션을 확장하면 엔드포인트 중 하나가 GET /skills/agents입니다. 이 엔드포인트의 간략한 설명을 보면 "스킬 할당을 반환"한다고 나와 있습니다.

스킬별 상담원 할당 작업의 일치하는 API입니다.

예 2

다음 예시처럼 상관관계가 명백하지 않은 경우도 가끔 있습니다. 이런 경우에는 CXone API와 플랫폼 자체에 대한 지식을 적용하여 해당하는 API 엔드포인트를 찾아야 합니다. —

이 작업 이름과 URI에 따르면 어떤 API를 먼저 확인해야 하는지 즉시 파악하기 어렵습니다. 어디서부터 시작해야 할지 확실치 않은 경우에는 각 API의 문서를 훑어보면서 컨택과 관련된 섹션을 검토할 수 있습니다. 최상위 컨택 섹션이 있는 API는 관리자 API뿐입니다. 하지만 이 API에는 활성 컨택과 관련된 엔드포인트가 포함되어 있지 않습니다.

개발자 포털 문서의 디지털 참여 API에서 사용 가능한 호출 목록입니다.

관리자 API의 컨택 섹션에서 사용 가능한 엔드포인트 목록입니다.

이 시점에서는 작업 이름과 URI에 활성이라는 단어를 키로 입력할 것입니다. CXone에 대한 지식을 기반으로 보면 활성에 현재 처리되고 있는 컨택이 표시된 것을 알 수 있습니다. 그러면 실시간 데이터 API를 더 자세히 살펴볼 수 있습니다. 이 API에는 하나의 섹션만 있으며, 이를 확장하면 엔드포인트 중 하나가 GET /contacts/active임을 알 수 있습니다. 이 엔드포인트의 간략한 설명을 보면 "활성 컨택을 반환"한다고 나와 있습니다.

실시간 데이터 API의 RealTime 섹션에서 사용 가능한 엔드포인트 목록입니다.