Asleep.AsleepErrorCode

version>SDK: 특정 SDK 버전 이전 사용가능, version<=SDK: 특정 SDK 버전 이상 사용가능
Android OS 버전 별로 Audio 입력 관련 SDK Error Code
- Android OS 버전 9 이하: Audio 입력 기능을 사용하는 App이 2개 이상 실행이 될 경우 최초에 실행된 App에서만 Audio 입력 정상적으로 수신이 되고 이후에 실행된 App들은 Audio 입력 설정 시점에 내부 에러 처리되며, SDK에서는 "ERR_AUDIO"로 에러 코드 전달.
- Android OS 버전 10 이상: Audio 입력 기능을 사용하는 App이 2개 이상 실행이 될 경우 가장 마지막에 실행된 App에서는 Audio 입력을 정상적으로 수신 되고 이전에 실행된 App에서는 "SILENCED" 상태로 "zero" 값을 수신하게 됨. SDK에서는 "zero" 음원을 수신하게 될 경우 "ERR_AUDIO_SILENCED" 에러 코드를 전달해 주며, 정상적으로 음원을 다시 수신하게 되면 "ERR_AUDIO_UNSILENCED" 에러 코드 전달.

Error	Code	Description	Handling	Version
ERR_SETUP_INCOMPLETE	10000	Setup process is not completed.	SDK Stop	3.1.0
ERR_UNABLE_ODA	10001	ODA is unavailable.	SDK Stop	3.1.0
ERR_UNKNOWN	11000	Unknown	SDK Stop
ERR_UNINITIALIZED	11001	Uninitialized SDK	SDK Stop
ERR_MIC_PERMISSION	11002	No mic permission	Client Handling
ERR_AUDIO	11003	Android Audio Error	SDK Stop
ERR_INVALID_URL	11004	Invalid URL Format	SDK Stop
ERR_AUDIO_SILENCED	11005	Recording Audio Silenced	SDK Handling
ERR_AUDIO_UNSILENCED	11006	Recording Audio Unsilenced	SDK Handling
ERR_COMMON_UNAUTHORIZED	11401	Unauthorized	SDK Stop
ERR_COMMON_EXPIRED	11403	Plan is expired \| Rate limit exceeded \| Quota exceeded	SDK Stop
ERR_COMMON_NOT_FOUND	11404	user not exist	SDK Stop
ERR_NETWORK	11500	HTTP 500 error \| Network error	SDK Stop

ERR_INIT_FAILED	21000	Failed to initAsleepConfig \| Network error occurred.	Client Handling
ERR_INIT_SERVER_ERROR	21500	internal server error	Client Handling
ERR_CREATE_FAILED	22000	Failed to create a session \| Network error occurred.	Client Handling
ERR_CREATE_CONFLICT	22409	The previous sleep session is not closed yet.	SDK Stop
ERR_CREATE_SERVER_ERROR	22500	internal server error	SDK Stop
ERR_UPLOAD_FAILED	23000	Failed to upload \| Network error occurred.	SDK Handling
ERR_UPLOAD_UNAUTHORIZED	23401	invalid customer uuid \| user_agent is empty	SDK Handling
ERR_UPLOAD_FORBIDDEN	23403	The session is already closed.	SDK Stop
ERR_UPLOAD_NOT_FOUND	23404	The session does not exist.	SDK Stop
ERR_UPLOAD_BAD_REQUEST	23400	Invalid callback_url or audio format should be <sleep_session.sleep_sound_length> sec (16khz, 44.1khz, 48khz) (mp3, wav) under 10MB or cannot upload MELSPECTROGRAM file. only upload AUDIO file.	SDK Handling
ERR_UPLOAD_TOO_LARGE	23413	HTTP content length exceeded {size} bytes.	SDK Handling
ERR_UPLOAD_UNPROCESSABLE	23422	Invalid parameter \| Invalid seq_num (seq_num starts from 0)	SDK Handling
ERR_UPLOAD_SERVER_ERROR	23500	internal server error	SDK Handling
ERR_CLOSE_FAILED	24000	Failed to close a session \| Network error occurred.	Client Handling
ERR_CLOSE_UNAUTHORIZED	24401	Unauthorized \| invalid customer uuid	SDK Stop
ERR_CLOSE_FORBIDDEN	24403	The session is already closed.	SDK Stop
ERR_CLOSE_BAD_REQUEST	24400	[WARNING] Invalid session end time. format(YYYY-MM-DDTHH:mm:ssz), must be less than session_start_time	SDK Stop
ERR_CLOSE_NOT_FOUND	24404	The session does not exist.	SDK Stop
ERR_CLOSE_SERVER_ERROR	24500	internal server error	Client Handling
ERR_DELETE_FAILED	25000	Failed to delete a session \| Network error occurred.	Client Handling
ERR_DELETE_UNAUTHORIZED	25401	Invalid customer uuid	Client Handling
ERR_DELETE_SERVER_ERROR	25500	internal server error	Client Handling
ERR_DELETE_USER_FAILED	26000	Failed to delete a customer uuid \| Network error occurred.	Client Handling
ERR_DELETE_USER_UNAUTHORIZED	26401	Invalid customer uuid	Client Handling
ERR_DELETE_USER_SERVER_ERROR	26500	internal server error	Client Handling

ERR_ANALYSE_FAILED	31000	Failed to analyse \| Network error occurred.	Client Handling
ERR_ANALYSE_UNAUTHORIZED	31401	Unauthorized	Client Handling
ERR_ANALYSE_NOT_FOUND	31404	Unable to find the sleep session of id {session_id}	Client Handling
ERR_ANALYSE_SERVER_ERROR	31500	internal server error	Client Handling
ERR_REPORT_FAILED	32000	Failed to report \| Network error occurred.	Client Handling
ERR_REPORT_UNAUTHORIZED	32401	Unauthorized	Client Handling
ERR_REPORT_NOT_FOUND	32404	Unable to find the sleep session of id {session_id}	Client Handling
ERR_REPORT_SERVER_ERROR	32500	internal server error	Client Handling
ERR_REPORTS_FAILED	33000	Failed to reports \| Network error occurred.	Client Handling
ERR_REPORTS_UNAUTHORIZED	33401	The API key is not provided.	Client Handling
ERR_REPORTS_SERVER_ERROR	33500	internal server error	Client Handling
ERR_AVERAGE_REPORT_FAILED	34000	Failed to average report \| Network error occurred.	Client Handling
ERR_AVERAGE_REPORT_BAD_REQUEST	34400	The period should be less than or equal to 100 days	Client Handling
ERR_AVERAGE_REPORT_NOT_FOUND	34404	Unable to find the user of id {user_id}	Client Handling
ERR_AVERAGE_REPORT_SERVER_ERROR	34500	internal server error	Client Handling

SDK Error 대응을 위한 정의

SDK 구간 동작에 대한 정의

Init (initAsleepConfig) : SDK 초기화 상태
Tracking (SleepTrackingManager): 수면 모니터링을 위한 Audio Recording 환경과 Server의 통신 프로토콜 관리
Report (Reports): 수면 모니터링 결과

Error Case Definition

SDK Stop: SDK 내부에서 종료 처리. SDK 내부적으로 종료 처리 되어서 새로 시작을 위해서는 SDK 재시작 필요. SDK 상태에 따라서 자체적으로 Session 종료 및 Audio Recording 기능에 대한 종료 처리됨. initAsleepConfig 요청 부터 새로 시작해야 SDK 활성화
SDK Handling: SDK 내부적으로 Error 업데이트 후 다음 동작을 수행. 에러 수신 후 종료 처리를 하고 싶으면 SDK 호출된 상태에 따라서 처리가 필요. SDK 종료 처리를 위해서는 Tracking 상태에서만 stopTracking 호출해 줘야 하고 다른 구간에서는 별도 처리 필요 없음.
Client Handling: Client에서 조치를 해줘야 하는 에러. 개발시 Error 확인 용도
Do not used: 현재 버전에서 사용되고 있지 않는 에러

Error Handling 분류

SDK 사용시 주로 나오는 Error Code는 붉은 색으로 표시. 취소선으로 선택된 Error Code는 나올 확률이 낮음.

Audio Error 관련 추가된 Error Code
ERR_AUDIO(11003): Audio Recording 설정 시점에 내부 에러에 의해 정상적으로 동작이 안되는 경우 "ERR_AUDIO" 에러 코드 전달
ERR_AUDIO_SILENCED(11005): Audio Recording 동작 중 측정 되는 음원이 "zero" 값으로 읽어오는 경우 "ERR_AUDIO_SILENCED" 에러 코드 전달.
ERR_AUDIO_UNSILENCED(11006): "ERR_AUDIO_SILENCED" 올려 준 후 Audio Recording 동작 중 측정 되는 음원이 정상적으로 회복 되었을 경우 "ERR_AUDIO_UNSILENCED" 에러 코드 전달.