Return Result (Result)

This topic introduces the structure and the subclasses of the 'Linkus SDK for Web Core' return result (Result object).

Background information

Result structure

{
    code: '',
    msg: '',
}

Result subclasses


Subclass	Description	Code Range
CommonResult	Common return result.	Success code: 0 to 99 Error code: -1 to -99
PBXResult	Return results related to the PBXOperator object.	Success code: 100 to 199 Error code: -100 to -199
PhoneResult	Return results related to the PhoneOperator object.	Success code: 200 to 299 Error code: -200 to -299

Error codes (COMMON_ERROR)


code	msg	Description
-1	UNKNOWN_ERROR	Unknown error.
-2	INVALID_PBX_URL	Invalid PBX URL.
-3	PBX_URL_NOT_HTTPS	The transfer protocol of the PBX URL is not HTTPS.
-4	GET_PRODUCT_FAILED	Failed to retrieve the PRODUCT interface of PBX .

Success code (COMMON_SUCCESS)


code	msg	Description
0	SUCCESS	Success.

Error codes (PBX_ERROR)


code	msg	Description
-100	UNKNOWN_ERROR	Unknown error.
-101	REGISTRY_FAILED	SIP UA registration failed.
-102	PBX_NETWORK_ERROR	API request failed due to the network error on the client-side.
-103	PBX_API_ERROR	API request failed due to the server-side error.
-104	GET_PERSONAL_NOT_FOUND_DATA	PBX did NOT return extension information.
-105	PBX_ALREADY_INITIALIZED	The PBX object has already been initialized and can NOT be initialized again.
-106	LINKUS_DISABLED	Linkus UC client is disabled.
-107	LOGGED_IN_ELSEWHERE	This extension has logged in elsewhere.
-108	EXTENSION_DELETED	The extension has been deleted.
-109	RE_LOGIN	The extension needs to log in again.
-110	SDK_PLAN_DISABLED	PBX plan is not Ultimate Plan (UP).

Success code (PBX_SUCCESS)


code	msg	Description
100	SUCCESS	Success.

Error codes (PHONE_ERROR)


code	msg	Description
-200	UNKNOWN_ERROR	Unknown error.
-201	REGISTRY_FAILED	SIP UA registration failed.
-202	GET_AGREE_CHROME_USER_MEDIA_ROLE_ERROR	Failed to retrieve media stream (Browser authorization is not granted).
-203	GET_LOCAL_STREAM_ERROR	Failed to retrieve local media stream.
-204	RE_REGISTRY_MAX_LIMIT_TIMES	Reached the maximum number of the allowed SIP UA re-registration attempts.
-205	MAX_LIMIT_CALL	Reached the maximum number of concurrent calls.
-206	GET_LOCAL_MEDIA_INFO_ERROR	Failed to access local media device.
-207	ATTENDED_PARENT_NOT_FOUND	Failed to find the parent call of the attended transfer call.
-208	CALL_TOO_MANY_TIMES	Reached the limit of outgoing calls within one second.
-209	INVALID_NUMBER	Invalid number.
-210	CURRENT_CALL_HAS_NOT_CONNECTED	There is currently an unconnected call.
-211	NOT_FOUND_CALL_ID	Failed to find the call ID.
-290	NOT_FOUND_AUDIO_INPUT_DEVICE	Failed to find the audio input device.
-291	NOT_FOUND_VIDEO_INPUT_DEVICE	Failed to find the video input device.

Success code


code	msg	Description
200	SUCCESS	Success.