Error Code

Common Error

Error Code Error Message Description
HTTP Status Code: 500
5001500

SBC_CONFIG_ERROR

SBC configuration error.
HTTP Status Code: 503
5001503

SBC_SERVICE_UNAVAILABLE

SBC service unavailable.
5002503

OPEN_API_SERVICE_UNAVAILABLE

Open API service unavailable.
5003503 MAINTENANCE_EXPIRED Maintenance expired.
HTTP Status Code: 422

5000422

FIELD_UNKNOWN_ERROR

A unknown error for the field.
5001422

FIELD_MUST_BE_NULL

The field must be null.
5002422

FIELD_IS_REQUIRED

The field is required.
5003422

FIELD_VALUE_LESS_THAN_MINIMUM

The field value is less than the minimum value.
5004422

FIELD_VALUE_GREATER_THAN_MAXIMUM

The field value is greater than the maximum value.
5005422

FIELD_SIZE_ERROR

The field length is incorrect.
5006422

FIELD_PATTERN_ERROR

The field format is incorrect.
5011422

INVALID_SORT_KEY

The Sort value is invalid.
5012422

INVALID_ORDER_KEY

The Order value is invalid.
HTTP Status Code: 429
5000429

REQUEST_RATE_LIMIT_ERROR

The request rate reaches the maximum value.
HTTP Status Code: 401
5000401

OAUTH2_ERROR

Common authorization error.
5001401

INVALID_CLIENT

Invalid Client ID or invalid Client Secret.
5002401

INVALID_GRANT

Refresh token error.
5003401

UNAUTHORIZED_CLIENT

Unauthorized client.
5004401

UNSUPPORTED_GRANT_TYPE

Unsupported grant type.
5006401

INVALID_TOKEN

Invalid token.
5011401

IP_LOCKED

If an IP exceeds the allowed failed API login attempts, YMP will block this IP.

Delete Blocked API IP

5012401

API_DISABLED

The YMP API feature is disabled.

Enable YMP API

5013401

IP_NO_PERMIT

The IP is not permitted to access the YMP API.

Enable YMP API

System Error

Error Code Error Message Description
HTTP Status Code: 500

5101500

SYSTEM_CAPACITY_ERROR

System capacity error.

PBX Error (PBX Management)

Error Code Error Message Description
HTTP Status Code: 404

5201404

PBX_NOT_FOUND

PBX not found.
5202404

PBX_VERSION_NOT_FOUND

PBX version not found.
5203404

PBX_CUSTOMER_NOT_FOUND

PBX customer not found.
5204404

PBX_ACTION_NOT_SUPPORT

The action for the PBX is not supported.
HTTP Status Code: 409
5201409

PBX_INSTANCE_NUMBER_OVER_LIMIT

The number of the PBXs reaches the maximum value.
5202409

PBX_CONCURRENT_CALL_CAPACITY_OVER_LIMIT

The number of Concurrent Calls reaches the maximum value.
5203409

PBX_EXTENSION_CAPACITY_OVER_LIMIT

The number of the Extensions reaches the maximum value.
5204409

PBX_RECORDING_CAPACITY_OVER_LIMIT

The recording time reaches the maximum capacity.
5205409

PBX_EXTENSION_LESS_THAN_MINIMUM

The number of Extensions is less than the minimum value.
5206409

PBX_NAME_ALREADY_EXISTS

PBX name already exists.
5207409

PBX_DOMAIN_ALREADY_EXISTS

PBX domain already exists.
5208409

PBX_PORT_CONFLICT

PBX port conflict.

The ports are not enough to assign to PBXs.

5209409

PBX_RECORDING_CAPACITY_LESS_THAN_USED

The PBX recording capacity is less than the used recording capacity.
5210409

PBX_RECORDING_CAPACITY_LESS_THAN_FREE_CAPACITY

The recording capacity is less than the free capacity (500 minutes).
5211409

PBX_ALREADY_STARTED

PBX already started.
5212409

PBX_ALREADY_STOPPED

PBX already stopped.
5213409

PBX_UPGRADING

PBX upgrading.
5215409

PBX_IS_STARTING_NO_ALLOW_STOP

The PBX is booting and is not allowed to stop now.
HTTP Status Code: 500
5200500

PBX_UNKNOWN_ERROR

PBX unknown error.
5201500

PBX_CREATE_ERROR

PBX create error.

PBX Error (PBX Configuration)

Error Code Description
10002 Unsupported XML data packet format.
10003 Unsupported API request.
10004 The required parameter is blank.
10006 The extension does not exist.
10007 The call does not exist.
10008 The extension isn't idle.
10009 The extension does not allow being monitored.
10010 The monitor mode does not match.
10011 The called number does not exist.
10012 The IVR does not exist.
10013 The queue does not exist.
10014 The ring group does not exist.
10015 The call is not connected.
10016 The call is accepted/call refuse times out.
10017 The extension configuration failed.
10018 The IVR configuration failed.
10019 The queue configuration failed.
10020 Failed to add or modify an alarm.
10021 The alarm does not exist.
10022 The alarm already exists.
10023 The audio file does not exist.
10024 The extension does not have outbound call permission.
10025 High frequency of using system automatic apply of new configuration.
10028 The number cannot be blank.
10031 The callee number doesn't meet the requirement.
10032 Wrong password.
10033 Fail to save the outbound route settings for extension.
10085

Add extension failed. The extension already exists.

10086 Delete extension failed.
10087

The limit of extension numbers reached.

10088 Invalid character contained in DID number.
10089 DID number length error.
10090 Invalid character contained in DID name.
10091 DID name length error.
10092 The limit of DID numbers reached.
20000 Only support JSON format.
20001 Only support POST request.
20002 User login failure (user locked out).
20003 User login failure (invalid username or password).
20004 No such Token.
20005 Token is blank.
20006 Token times out.
20007 Blank data.
20008 Wrong port.
20009 Blank request.
20010 Failed to send request to apisrv for processing.
20011 HeartBeat Configuration request failure.
20012 The random string of recording file is invalid.
20013 Wrong captcha.
20014 The recording file does not exist.
20015 The setting of allowedip is wrong.
20016 The voicemail status is wrong.
20017 The random string of voicemail file is invalid.
20018 The voicemail file does not exist.
20019 The CDR time format is wrong.
20020 The random string of CDR file is invalid.
20021 The CDR file does not exist.
20022 YMP IP error.
30001 API codes error.

Customer Error

Error Code Error Message Description
HTTP Status Code: 404

5301404

CUSTOMER_NOT_FOUND

Customer not found.
HTTP Status Code: 409
5301409

CUSTOMER_COMPANY_ALREADY_EXISTS

Company name already exists.
5302409

CUSTOMER_HAS_BEEN_ASSOCIATED_WITH_PBX

Customer has been associated with PBX.
5303409

CUSTOMER_NUMBER_OVER_LIMIT

The number of customers reaches the maximum value.

User Error

Error Code Error Message Description
HTTP Status Code: 404
5401404

USER_NOT_FOUND

User not found.
5402404 USER_CAPACITY_NOT_FOUND User capacity not found.
HTTP Status Code: 409
5401409

USER_EMAIL_ALREADY_EXISTS

Email address already exists.
5403409

USER_INSTANCE_CAPACITY_LESS_THAN_USED

The number of PBXs is less than the used number of PBXs.
5404409

USER_EXTENSION_CAPACITY_LESS_THAN_USED

The number of Extensions is less than the used number of Extensions.
5405409

USER_CONCURRENT_CALL_CAPACITY_LESS_THAN_USED

The number of Concurrent Calls is less than the used number of Concurrent Calls.
5406409

USER_RECORDING_CAPACITY_LESS_THAN_USED

The Recording time is less than the used Recording capacity.
5407409

USER_MIN_EXTENSION_GREATER_THAN_TOTAL

The minimum number of extensions is greater than the total number of extensions.
5408409

USER_NAME_ALREADY_EXISTS

User name already exists.
5409409

USER_NUMBER_OVER_LIMIT

The number of Users reaches the maximum value.
5411409

USER_INSTANCE_CAPACITY_OVER_LIMIT

The number of PBXs reaches the maximum value.
5412409

USER_CONCURRENT_CALL_CAPACITY_OVER_LIMIT

The number of Concurrent Calls reaches the maximum value.
5413409

USER_EXTENSION_CAPACITY_OVER_LIMIT

The number of Extensions reaches the maximum value.
5414409

USER_RECORDING_CAPACITY_OVER_LIMIT

The Recording time reaches the maximum Recording capacity.

Email Error

Error Code Error Message Description
HTTP Status Code: 500
5501500

EMAIL_CONFIG_ERROR

Email configuration error.
5502500

EMAIL_TEMPLATE_ERROR

Email template error.
HTTP Status Code: 503
5500503

SMTP_SERVER_UNKNOWN_ERROR

SMTP server unknown error.
5501503

SMTP_SERVER_CONNECTION_FAILED

SMTP server configuration failed.
5502503

SMTP_SERVER_FREQUENCY_LIMIT

Send too many emails in an allowed frequency.
5503503

SMTP_SERVER_AUTH_ERROR

SMPT server authorization error.
5504503

INVALID_RECIPIENT_EMAIL_ADDRESS

Invalid recipient email address.