Partner Hub에서 Webex Calling에 대한 자세한 통화 레코드 웹훅

개요

자세한 통화 레코드 웹훅을 통해 비용 청구부터 맞춤형 보고까지 다양한 목적으로 Webex Calling 활동에 대한 가시성을 높일 수 있습니다. 이 웹훅을 사용하여 각 고객에 대한 레코드를 하나씩 쿼리하지 않고도 모든 고객에 대해 편리하게 레코드를 수집할 수 있습니다. 이 웹훅을 사용하면 내부 비즈니스 목적이나 고객에게 부가 가치 서비스를 제공하기 위해 사용자 정의 보고 및 분석 애플리케이션을 개발할 수 있습니다. 웹훅과 그에 수반되는 API에 대한 소개는 이 vidcast를 볼 수 있습니다.

웹훅은 5분마다 녹화를 제공합니다. 각 웹훅 페이로드는 10~5분 전에 종료된 통화에 대한 기록을 포함합니다. 예를 들어, 17:00에 수신된 페이로드는 16:50에서 16:55 사이에 종료된 통화를 포함합니다. 16:55~17:00 사이에 종료되는 통화는 17:05 페이로드에 적용됩니다.

Webex Calling 레코드는 기존 세부 통화 레코드 API와 동일한 형식을 사용하여 전달됩니다. 웹훅을 설정하고 두 가지 유형의 피드 중에서 선택할 수 있습니다.

분석—파트너가 Webex Calling과 관계가 있는 모든 고객 조직에 대한 모든 통화 레코드를 포함합니다. 여기에는 다음을 위한 조직이 포함됩니다.
- 파트너는 파트너 전체 관리자 역할로 고객 조직을 관리합니다.
- 고객 조직에 파트너 조직 내에 활동 중인 Webex Calling 가입이 있습니다.
비용 청구—파트너가 판매한 Webex Calling 라이센스를 사용하는 사용자가 실행한 통화에 대한 통화 기록만 포함됩니다. 작업 공간에 대한 통화 레코드는 이 피드에 포함됩니다.

웹훅 콜백 URL 설정

Partner Hub에서 웹훅을 구성합니다. 파트너 조직당 한 개의 웹훅만 설정할 수 있습니다. 웹훅을 설정하려면 전체 관리자여야 합니다.

1	Partner Hub에 로그인합니다.
2	조직 설정 > 통화 세부 기록으로 이동합니다.
3	Webhook 아래에서 사용할 URL을 입력합니다.
4	비밀 토큰으로 웹훅 페이로드를 인증하고자 하는 경우, 하나를 추가할 수 있습니다. 여기에서 Webex 웹훅 및 비밀 토큰에 대한 자세한 정보를 찾을 수 있습니다.
5	웹훅에 대해 사용할 다음 리소스 유 형 중 하나를 선택합니다. 분석—파트너가 Webex Calling과 관계가 있는 모든 고객 조직에 대한 모든 통화 레코드를 포함합니다. 비용 청구—파트너가 Webex Calling 라이센스를 판매한 통화 레코드만 포함됩니다. 이 피드는 작업 공간에 대한 통화 레코드를 포함합니다.

API 엔드포인트

데이터 조정을 돕기 위해 웹훅과 함께 두 개의 API 엔드포인트를 제공합니다. 이러한 엔드포인트를 사용하면 웹훅 리스너가 수신하지 않은 누락된 레코드와 데이터 스토어를 "확인"하거나 조화시킬 수 있습니다. 이 두 API는 Reconciliation API 엔드포인 트 및 Records API 엔드포인트입니다.

레코드는 이러한 API에서 48시간 동안 사용할 수 있습니다. 모든 기록을 기대한 대로 수신할 수 있도록 레코드 스토어(예: 12~24시간마다)를 주기적으로 조정할 것을 권장합니다. 이 API를 사용하려면 파트너 액세스 토큰이 필요합니다. 파트너 액세스 토큰을 얻고 표준 Webex 개발자 액세스 토큰 관리 원칙에 따라 관리할 수 있습니다.

조정 API 엔드포인트

조정 API 엔드포인트는 지정된 기간 동안 파트너가 관리하는 각 고객이 생성한 레코드 수를 반환합니다. 파트너가 200개 이상의 고객 조직을 관리하는 경우, 더 나은 가독성을 위해 API의 결과가 페이지 매핑됩니다. 이러한 총계를 사용하여 특정 고객에 대해 기록이 없는 경우 로컬 스토리지를 확인할 수 있습니다. 여기에서 조정 API 엔드포인트 URL을 찾을 수 있습니다.

https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z

매개변수

조정 API는 최대 1시간 동안만 호출될 수 있으며, startTime 및 endTime 파라미터는 60분 이상 떨어져 있지 않습니다. API는 5분~48시간 전에 1시간 동안 사용할 수 있지만, 서비스 로드를 관리하기 위해 한 번에 1시간만 호출할 수 있습니다.

사용할 수 있는 매개 변수는 다음과 같습니다.

startTime (string)—수집하려는 첫 번째 보고서의 시간입니다. 보고서 시간은 통화 완료 시간을 지정합니다.

YYYY-MM-DDTHH:MM:SS.mmmZ로 시간을 형식화해야 합니다.
endTime (string) - 수집하려는 마지막 보고서의 시간입니다. 보고서 시간은 통화 완료 시간을 지정합니다.

지정된 시간은 startTime 보다 이후이어야 하며, 48시간 이내이어야 하며, YYYY-MM-DDTHH:MM:SS.mmmZ로 시간을 형식화해야 합니다.

다음은 조정 API 엔드포인트 JSON 반환 페이로드에 대한 예입니다.

{ "cdr_counts": [ { "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-｟_ph_15｠-yyyy", "카운트": 3009 }, { "orgId": "｟_ph_15｠ yyyy-yyyy-zzzz-xxxx-｟_ph_15｠-yyyy", "count": 129 }, { "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyy", "count": 278 } ] }

API 응답의 헤더는 반환된 조직의 총 수 및 추가 페이지가 있는지 여부를 나타냅니다. 다음 매개 변수를 확인하여 모든 페이지가 쿼리되었는지 확인합니다.

 num-pages = 총 2 조직 = 283 현재-페이지 = 1

위의 매개 변수는 현재 페이지가 첫 번째 페이지이며, 총 2개의 페이지가 있으며, 전체 응답에는 283개의 조직이 포함되어 있음을 나타냅니다. 아래와 같이 파라미터 page=2 를 GET 요청에 추가하여 두 번째 페이지에 액세스합니다.

https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2

레코드 API 엔드포인트

이 API 엔드포인트는 세부 통화 기록 API에 설명된 형식과 동일한 JSON 형식으로 통화 레코드를 반환합니다. 반환된 페이로드에는 반환된 세부 통화 기록 페이로드와 동일한 필드가 포함됩니다. 여기에서 반환된 각 필드의 값에 대한 자세한 내용을 확인할 수 있습니다. 레코드 API 엔드포인트는 레코드가 누락된 조직에 대한 누락 된 레코드를 쿼리하는 데 사용됩니다. 다음 위치에서 레코드 API 엔드포인트 URL을 찾을 수 있습니다.

https://analytics.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z