Error Codes
Reference error codes and their meanings.
Read time 1 minuteLast updated a day ago
The following table lists the error codes that the Vivox SDK can return and recommendations for how to handle these errors. If there's an issue that's not tied directly to an error code, a generic
VivoxApiExceptiontry/catch| Error | Error code | Notes |
| VxErrorNoMessageAvailable | -1 | |
| VxErrorSuccess | 0 | |
| VxErrorTargetObjectDoesNotExist | 1001 | Programming error. |
| VxErrorInternalError | 1004 | Internal Vivox error. Get Vivox logs and send to Vivox for analysis. |
| VxErrorInvalidArgument | 1008 | Programming error. A parameter in a request is either using the wrong type (for example, using a bool when it should be an int) or is missing. |
| VxErrorNotInitialized | 1012 | Programming error. |
| VxErrorNotImplemented | 1017 | Programming error. |
| VxErrorInvalidState | 1019 | Often a programming error, but sometimes occurs when a login or voice session terminates due to loss of network at the same time that a request is issued. |
| VxErrorFileOpenFailed | 1043 | Programming error or packaging error. |
| VxErrorRtpTimeout | 1058 | Unable to pass RTP. User retry, or exponential backoff retry. |
| VxErrorAlreadyInitialized | 1085 | Programming error. |
| VxErrorServerRtpTimeout | 1095 | Retry with backoff. |
| VxErrorAsyncOperationCanceled | 5001 | |
| VxErrorCaptureDeviceInUse | 5002 | Indicates an attempt to open a second audio session on a second simultaneous session group. Usually indicative of a client programming error. |
| VxErrorConnectionTerminated | 5003 | Connection for Vivox lost, user retry, or exponential backoff. |
| VxErrorFileOpenFailed | 5004 | Programming error or packaging error. |
| VxErrorHandleReserved | 5005 | Programming error. |
| VxErrorHandleTaken | 5006 | Programming error. |
| VxErrorInternalError | 5007 | Internal Vivox error. Get Vivox logs and send to Vivox for analysis. |
| VxErrorInvalidArgument | 5008 | Programming error. |
| VxErrorInvalidFormat | 5009 | Programming error. |
| VxErrorInvalidOperation | 5010 | Programming error. |
| VxErrorInvalidState | 5011 | Often a programming error, but sometimes occurs when a login or voice session terminates due to loss of network at the same time that a request is issued. |
| VxErrorInvalidValueTypeXmlQuery | 5012 | Internal Vivox error. Get Vivox logs and send to Vivox for analysis. |
| VxErrorNoMatchingXmlAttributeFound | 5013 | Internal Vivox error. Get Vivox logs and send to Vivox for analysis. |
| VxErrorNoMatchingXmlNodeFound | 5014 | Internal Vivox error. Get Vivox logs and send to Vivox for analysis. |
| VxErrorNoMemory | 5015 | Usually a corrupted heap. |
| VxErrorNoMoreData | 5016 | |
| VxErrorNotSupported | 5018 | Programming error. |
| VxErrorPortNotAvailable | 5019 | Unable to find a port for audio. Usually indicative of having too many calls active at once as a result of a programming error. |
| VxErrorRtpTimeout | 5020 | Unable to pass RTP. User retry or exponential backoff retry. |
| VxErrorUnableToOpenCaptureDevice | 5021 | |
| VxErrorXmppBackEndRequired | 5023 | Client is configured to use the wrong Vivox backend, or the backend is set up incorrectly. Contact Vivox. |
| VxErrorPreloginDownloadFailed | 5024 | Unable to reach a Vivox web server. Retry with backoff. |
| VxErrorNotLoggedIn | 5025 | Programming error. |
| VxErrorPresenceMustBeEnabled | 5026 | Programming error. |
| VxErrorConnectorLimitExceeded | 5027 | Programming error. |
| VxErrorTargetObjectNotRelated | 5028 | Programming error. |
| VxErrorTargetObjectDoesNotExist | 5029 | Programming error. |
| VxErrorMaxLoginsPerUserExceeded | 5030 | Programming error. |
| VxErrorRequestCanceled | 5031 | |
| VxErrorBuddyDoesNotExist | 5032 | Programming error. |
| VxErrorChannelUriRequired | 5033 | Programming error. |
| VxErrorTargetObjectAlreadyExists | 5034 | Occurs when a developer tries to force a player to join a channel that the player is already connected to, while declaring a different session group. This is because a player cannot connect to two channels with the same URI (same name, same audio/text status, same issuer, and same domain), even if they use a separate session group for each. This error occurs regardless of whether a developer uses a different session group to try and join the player to the same channel again. |
| VxErrorInvalidCaptureDeviceForRequestedOperation | 5035 | Programming error. |
| VxErrorInvalidCaptureDeviceSpecifier | 5036 | Programming error. |
| VxErrorInvalidRenderDeviceSpecifier | 5037 | Programming error. |
| VxErrorDeviceLimitReached | 5038 | Programming error. |
| VxErrorInvalidEventType | 5039 | Programming error. |
| VxErrorNotInitialized | 5040 | Programming error. |
| VxErrorAlreadyInitialized | 5041 | Programming error. Attempted to initialize a client that was already initialized. You might need to reopen your Unity project to fix this error. |
| VxErrorNotImplemented | 5042 | Programming error. |
| VxErrorTimeout | 5043 | Retry with backoff. |
| VxNoAuthentificationStanzaReceived | 5044 | |
| VxFailedToConnectToXmppServer | 5045 | Retry with backoff. |
| VxSSLNegotiationToXmppServerFailed | 5046 | If this error only occurs on one device, check that the device is up to date on all certificates. If this error occurs on all devices, contact Vivox immediately. |
| VxErrorUserOffLineOrDoesNotExist | 5047 | |
| VxErrorCaptureDeviceInvalidated | 5048 | |
| VxErrorMaxEtherChannelLimitReached | 5049 | |
| VxErrorHostUnknown | 5050 | Server value could not be resolved. Check that the value is correct. Otherwise, retry with backoff. |
| VxErrorChannelUriTooLong | 5051 | Programming error. |
| VxErrorUserUriTooLong | 5052 | Programming error. |
| VxErrorUserBlocked | 5102 | Occurs when a direct message is sent to a user who is cross-muted (blocked). |
| VxErrorMessageTextTooLong | 5103 | Received when a text message exceeds the maximum length in bytes. |
| VxNetworkHttpInvalidUrl | 10003 | Programming error. |
| VxNetworkNameResolutionFailed | 10006 | Either a programming error or a networking issue. Check the account management server URL. If pervasive, contact Vivox. Otherwise, retry with backoff. |
| VxNetworkUnableToConnectToServer | 10007 | Retry with backoff. |
| VxNetworkHttpTimeout | 10028 | Retry with backoff. |
| VxNetworkHttpInvalidServerResponse | 10052 | Contact Vivox. |
| VxNetworkHttpConnectionReset | 10056 | Retry with backoff. |
| VxNetworkHttpInvalidCertificate | 10077 | Programming error. |
| VxNetworkHttpGeneralConnectionFailure | 10100 | Retry with backoff. |
| VxNetworkReconnectFailure | 10101 | Received when the Vivox SDK fails to reconnect after several attempts. |
| VxAccessTokenAlreadyUsed | 20120 | Programming error. |
| VxAccessTokenExpired | 20121 | Programming error. |
| VxAccessTokenInvalidSignature | 20122 | Programming error. |
| VxAccessTokenClaimsMismatch | 20123 | Programming error. |
| VxAccessTokenMalformed | 20124 | Programming error. |
| VxAccessTokenInternalError | 20125 | Contact Vivox. |
| VxAccessTokenServiceUnavailable | 20127 | Contact Vivox. |
| VxAccessTokenIssuerMismatch | 20128 | Programming error. |
| VxErrorTitleDisabled | 20129 | Received when the Vivox SDK free-tier has been exceeded and payment information has not been provided within 30 days. |
| VxXmppErrorChannelAtCapacity | 20507 | Received when trying to join a full channel. |