Callback
분석된 결과를 원하시는 HTTP 콜백 URL 호출을 통해 전달해주는 기능으로, Session API에 Create Session API에서 파라미터에 적어주면, 아래와 같은 포맷으로 분석 결과를 전달합니다.
1. Request
1.1 Method
POST
1.2 Header
| Field | Type | Description |
|---|---|---|
| x-api-key | String | 데이터 업로드 또는 세션 종료 시 사용한 API Key |
| x-user-id | String | 수면 세션을 생성한 user id |
1.3 Body
| Field | Type | Description |
|---|---|---|
| callback_event | String (INFERENCE_COMPLETE,SESSION_COMPLETE) | 콜백 이벤트 타입INFERENCE_COMPLETE: 5분 또는 20분 단위로 분석이 완료된 경우SESSION_COMPLETE: 전체 세션 분석이 완료된 경우 |
| callback_version | String ( V1,V2) | 콜백 버전V1: v1.0 문서의 callback 포맷을 따름V2: 현재 버전의 callback 포맷을 따름 |
| callback_data | Callback Data Object | 콜백 데이터 |
1.3.1 INFERENCE_COMPLETE일 경우 Callback Data Object
| Field | Type | Description |
|---|---|---|
| user_id | String | user id |
| session_id | String | session id |
| seq_num | Int | 오디오 데이터 업로드 순서 번호 |
| inference_seq_num | Int | seq_num을 5분 단위로 변환한 번호 예) MELSPECTROGRAM 업로드 시 seq_num 39이면 inference_seq_num은 3 |
| sleep_stages | [Int] | 직전 20분 단위의 수면 단계 결과 예) inference_seq_num이 6이면 3~6까지 40개의 값을 전달받음 |
| breath_stages | [Int] | 직전 20분 단위의 호흡 안정 단계 결과 예) inference_seq_num이 6이면 3~6까지 40개의 값을 전달받음 |
1.3.2 SESSION_COMPLETE일 경우 Callback Data Object
| Field | Type | Description |
|---|---|---|
| user_id | String | user id |
| session_id | String | session id |
| sleep_data | Sleep Data Object | 전체 수면 분석 결과 |
1.3.3 Sleep Data Object
Get Single Session의 result 필드 부분과 동일한 포맷으로 데이터가 전달됩니다.
Updated about 1 year ago