Error handling

If an error occurs when the system makes a web call, an XML document is returned with the status element set to “ERR”, and the code and msg elements set to a code number and error description, respectively.

Example error codes

The following list details common error codes:

200 - Wrong User credentials.
201 - Expired user credentials.
202 - Missing user credentials.
212 - Account not allowed to perform operation.
403 - Account does not exist.
300 - Required parameter(s) missing or invalid.
301 - Unknown mode.
302 - Unable to parse argument.
500 - Internal Server Error.
807 - Channel not found.
718 - Failed changing conference media.
1600 - Login Failed. Unknown Account.
1602 - Login Failed. Account has not been activated.
1603 - Login Failed. Account has been disabled.
1604 - Login Failed. Please contact support.

Example XML error document

The following code displays an example of an XML error document.

<response xmlns="http://www.vivox.com"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="/xsd/error.xsd">
    <level0>
        <status>ERR</status>
        <body>
            <code>200</code>
            <msg>Wrong user credentials.</msg>
        </body>
    </level0>
</response>

Error handling#

Error handling