REST API & 웹훅 Team
이 페이지의 대상. 이 페이지는 개발자와 IT 팀을 위한 것입니다. REST API를 사용하면 자체 소프트웨어에서 회의에 ScribX를 시작하고 전사와 녹화 기록을 읽을 수 있습니다. 웹훅을 사용하면 어떤 일이 일어났을 때 ScribX가 시스템으로 메시지를 보냅니다. 예를 들어 회의가 끝나거나 요약이 준비되었을 때입니다. 기술 담당자가 아니라면 이 페이지를 IT 팀에 전달하십시오. 코드 없이 캘린더, Zoom 또는 Notion을 연결하려면 대신 연동을 참고하십시오.
REST API, 웹훅 및 API 키는 Team 및 Enterprise에서 사용할 수 있습니다. 요금제 및 결제를 참고하십시오.
API로 할 수 있는 일
- 회의에서 ScribX 시작하기. 회의 링크를 보내면 ScribX가 회의에 참가합니다.
- 회의 목록을 조회하고 세부 정보와 상태를 읽습니다.
- 전사 읽기. 각 줄에 화자 이름과 시간이 포함됩니다.
- 회의의 녹화 기록 가져오기 (오디오 또는 비디오를 보관하는 경우).
- 회의의 참석자 목록 조회.
요약은 summary.update 웹훅(아래 참고) 또는
MCP 서버를 통해 받습니다.
API 키 만들기
- 웹 앱의 사이드바에서 기타 아래에 있는 연동을 클릭하십시오.
- 고급에서 API를 클릭하십시오.
- 상단에서 개인(내 공간의 회의만) 또는 팀(하나의 팀의 회의)을 클릭하십시오.
- 새 키를 클릭하십시오.
- 이름에 키를 사용하는 곳을 알 수 있는 이름을 입력하십시오. 예: "Production".
- 범위에서 키가 할 수 있는 작업을 선택하십시오. 아무것도 선택하지 않으면 키에 전체
액세스 권한이 부여됩니다:
bots:read: 회의와 그 상태를 읽습니다.bots:write: 회의에서 ScribX를 시작하고 제어합니다.recordings:read: 녹화 기록과 전사를 읽습니다.webhooks:write: 웹훅을 관리합니다.
- 키 만들기를 클릭하십시오.
- 지금 키를 복사하십시오. 키는 한 번만 표시됩니다. 비밀번호 관리자처럼 안전한 곳에 보관하십시오. 개발자에게는 일반 채팅 메시지가 아닌 안전한 경로로 전달하십시오.
키는 본인으로 동작합니다. 본인이 열 수 있는 항목만 열 수 있습니다. 목록에서 키는 본인만 볼 수 있습니다. 키를 중지하려면 옆에 있는 키 해지를 클릭하십시오. 그 키를 사용하는 모든 것이 즉시 작동을 멈춥니다.
API 호출하기
Authorization 헤더에 키 앞에 Token이라는 단어를 붙여 보내십시오:
curl https://platform.scribx.app/api/v1/bots \
-H "Authorization: Token YOUR_API_KEY"
주요 주소(모두 https://platform.scribx.app/api/v1/ 아래):
| 주소 | 기능 |
|---|---|
POST bots | 회의에서 ScribX를 시작합니다. |
GET bots | 회의 목록을 조회합니다. |
GET bots/{id} | 한 회의의 세부 정보와 상태. |
GET bots/{id}/transcript | 전사. |
GET bots/{id}/recording | 녹화 기록 다운로드 링크. |
GET bots/{id}/participants | 참석자. |
전체 참조 문서는 ScribX 지원팀에 문의하십시오.
웹훅
웹훅은 시스템 안에 있는 웹 주소입니다. 이벤트가 발생할 때마다 ScribX가 그 주소로 메시지(HTTP POST)를
보냅니다.
웹훅 추가하기
- 연동을 여십시오. 고급에서 웹훅을 클릭하십시오.
- 상단에서 개인 또는 팀을 클릭하십시오.
- 서명 시크릿에서 시크릿 복사를 클릭하십시오. ScribX는 모든 메시지에 이 시크릿으로 서명합니다. 시스템은 이를 사용하여 메시지가 실제로 ScribX에서 왔는지 확인합니다. 시크릿은 모든 웹훅 주소에 대해 하나입니다.
- 웹훅 추가를 클릭하십시오.
- 엔드포인트 URL에 시스템의 주소를 입력하십시오.
https://로 시작해야 합니다. - 이벤트에서 하나 이상의 이벤트를 선택하십시오. 가장 유용한 이벤트는 다음과 같습니다:
bot.state_change: ScribX가 참가했거나, 나갔거나, 회의가 종료되었습니다.transcript.update: 새 전사 줄이 도착했습니다.summary.update: 요약이 작성되었습니다. 요약 텍스트는 메시지에 포함됩니다.participant_events.join_leave: 누군가 회의에 참가하거나 나갔습니다.
- 웹훅 추가를 클릭하십시오.
ScribX가 보내는 내용
각 메시지는 JSON이며 다음과 같은 형태입니다:
{
"idempotency_key": "…", // unique for each message
"bot_id": "bot_…", // the meeting
"bot_metadata": { },
"trigger": "summary.update", // the event
"data": { } // the event's details
}
서명은 X-Webhook-Signature 헤더에 있습니다.
10초 이내에 2xx 상태 코드로 응답한 다음, 시간이 오래 걸리는 작업은 그 후에 처리하십시오. 시스템이
다른 코드로 응답하거나 제시간에 응답하지 않으면 ScribX가 메시지를 다시 보냅니다.
idempotency_key를 사용하여 이미 처리한 메시지는 무시하십시오.