Asleep.AsleepErrorCode

version>SDK: Usable before a specific SDK version, version<=SDK: Usable from a specific SDK version or higher
SDK Error Codes for Audio Input by Android OS Version
- For Android OS versions 9 and below: If more than one app using the audio input feature is running, only the first app launched will receive audio input correctly. Subsequent apps will encounter an internal error at the point of audio input setup, and the SDK will deliver an ‘ERR_AUDIO’ error code.
- For Android OS versions 10 and above: If more than one app using the audio input feature is running, the last app launched will receive audio input correctly. The previously launched apps will receive a ‘zero’ value in a ‘SILENCED’ state. The SDK will deliver an ‘ERR_AUDIO_SILENCED’ error code when it receives a ‘zero’ sound source. When it starts receiving the sound source correctly again, it will deliver an ‘ERR_AUDIO_UNSILENCED’ error code.

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_INSUFFICIENT_STORAGE`	11008	Insufficient storage (less than 200MB). It occurs only when saving recording files is used, and sleep tracking does not start	Client Handling	3.3.0
`ERR_INVALID_PARAMETER`	11009	The start time of the analysis range is later than or equal to the end time. Or recordingPath / recordingType was passed without a Completable listener	Client Handling	3.3.0
`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_PRODUCT_REGISTER_FAILED`	13000	Temporary failure to register a Product. Network error, server error (5xx), too many requests (429). It is classified as a transient error, and depending on the path it may be the result after the SDK has retried	Client Handling	3.3.0
`ERR_PRODUCT_REGISTER_REJECTED`	13400	Product registration rejected. Invalid parameter (400), unauthorized (401), no permission to register (403). The result is the same if you try again	Client Handling	3.3.0

`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.	SDK Stop
`ERR_CREATE_UNAUTHORIZED`	22401	Unauthorized \| user_agent is empty	Client Handling
`ERR_CREATE_CONFLICT`	22409	The previous sleep session is not closed yet.	SDK Stop
`ERR_CREATE_VALIDATION`	22422	Invalid session_start_time (YYYY-MM-DDTHH:mm:ssz) \| Invalid parameter	Client Handling
`ERR_CREATE_SERVER_ERROR`	22500	internal server error	SDK Stop
`ERR_UPLOAD_FAILED`	23000	Failed to upload \| Network error occurred.	SDK Handling
~~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_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_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_TRACKING_TERMINATED`	23499	Unified all upload 4xx errors and deprecated individual upload error codes	SDK Handling	3.2.0
`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	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_SAVE_METADATA_FAILED`	27000	Failed to save user metadata (network or server error, userId not set, SDK not initialized)	Client Handling	3.3.0
`ERR_FETCH_METADATA_FAILED`	27100	Failed to get user metadata (network or server error, userId not set, SDK not initialized)	Client Handling	3.3.0
`ERR_SAVE_METADATA_VALIDATION`	27400	The server rejected the metadata value (400). The reason is delivered in detail	Client Handling	3.3.0
`ERR_COMPLETE_TIMEOUT`	28000	The analysis completion was not confirmed within 30 seconds after the measurement ended. This is not a measurement failure and the session ends normally. Get the report after a while	Client Handling	3.3.0

`ERR_REANALYZE_FAILED`	30000	Failed to reanalyze. Network error, no userId in AsleepConfig	Client Handling	3.3.0
`ERR_REANALYZE_BAD_REQUEST`	30400	Invalid analysis start or end time	Client Handling	3.3.0
`ERR_REANALYZE_UNAUTHORIZED`	30401	Unauthorized to reanalyze	Client Handling	3.3.0
`ERR_REANALYZE_FORBIDDEN`	30403	No permission to reanalyze	Client Handling	3.3.0
`ERR_REANALYZE_NOT_FOUND`	30404	The session does not exist	Client Handling	3.3.0
`ERR_REANALYZE_CONFLICT`	30409	Cannot reanalyze now (already being reanalysed, etc.). If it keeps occurring, the session may not be able to be reanalysed, so avoid retrying indefinitely	Client Handling	3.3.0
`ERR_REANALYZE_GONE`	30410	The data retention period has expired	Client Handling	3.3.0
`ERR_REANALYZE_UNPROCESSABLE`	30422	The session is still being measured	Client Handling	3.3.0
`ERR_REANALYZE_SERVER_ERROR`	30500	Reanalyze server error (5xx)	Client Handling	3.3.0
`ERR_ANALYSE_FAILED`	31000	Failed to analyse \| Network error occurred.	Client Handling
`ERR_ANALYSE_BAD_REQUEST`	31400	The invalid timezone is provided	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_BAD_REQUEST`	32400	The invalid x-user-id is provided	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_BAD_REQUEST`	33400	The invalid timezone is provided	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

Definition for SDK Error Handling

Definition of SDK Segment Operation

Init (initAsleepConfig) : SDK Initialization State
Tracking (SleepTrackingManager): Audio recording environment and server communication protocol management for sleep monitoring
Report (Reports): Request sleep monitoring results

Error Case Definition

SDK Stop: Termination process within the SDK. The SDK needs to be restarted for a new start because it is terminated internally. Depending on the status of the SDK, the session and audio recording function are terminated by itself. You need to start from the "initAsleepConfig" request to activate the SDK
SDK Handling: The SDK updates the error internally and performs the next action. If you want to terminate after receiving an error, you need to handle it depending on the state of the SDK call. To terminate the SDK, you need to call stopTracking only in the Tracking state, and no separate processing is required in other sections
Client Handling: An error that needs to be handled by the client. Used for error checking during development.
Do not used: Error not in use in the current version.

Error Handling Classification

Indicate commonly occurring Error Codes in red. Error codes that are unlikely to appear should be struck through.

Added Error Code for Audio
ERR_AUDIO(11003): If the audio recording does not function properly due to an internal error at the setup stage, the ‘ERR_AUDIO’ error code is delivered.
ERR_AUDIO_SILENCED(11005): If the sound source being measured during audio recording is read as a ‘zero’ value, the ‘ERR_AUDIO_SILENCED’ error code is delivered.
ERR_AUDIO_UNSILENCED(11006): If the sound source being measured during audio recording recovers normally after the ‘ERR_AUDIO_SILENCED’ error code has been raised, the ‘ERR_AUDIO_UNSILENCED’ error code is delivered.