Video API Error Handling

The Server API calls make use of JSON Result Code to determine if the API call is successful.

Success JSON

Successful Server API calls will always return JSON with a 0 (zero) Result Code.

{    
     "result": 0,    
     ….
     ….
 }

Error JSON

If unsuccessful, for whatever reason, Server API calls will return JSON with a non—zero Result Code. This error response will always carry 3 keys, viz.

• Result Code,
• Error,
• Description.

See example below:

{    
     "result": "Non-Zero Result Code",   
     "error": "Short reason",
     "desc": "Descriptive information about the error / warning"
 }

Server API Result Codes

Result Codes

The result codes of the Video Server API are grouped into following categories:

Response Codes for Successful Requests

The Server API response codes for successful requests are described in the below table.

General

Response Codes for Failed Requests

The Server API response codes for failed requests are described in the below tables.

Rooms

Token

CDR