This article provides basic information about the Interactive Whiteboard SDK RESTful API.
All requests are sent to the domain named
Content-Type field in all HTTP request headers is
application/json. All requests and responses are in JSON format. All request URLs and request bodies are case-sensitive.
Agora's server for the whiteboard service will allow more data formats but cannot guarantee full compatibility. If all request parameters are filled in correctly, but the request still fails, please check the data format of the request.
The Interactive Whiteboard SDK RESTful API provides the following features:
All possible response status codes are listed in the table below:
If the status code is
201, the request is successful.
If the status code is not
201, the request fails. The response body includes a
messagefield that describes the reason for the failure.
|Response status code||Status||Description|
|OK||The request is successful, and the server returns the requested data.|
|Created||The request is successful, and the server creates or modifies the requested data.|
|Invalid request||The user's request has an error, and the server does not create or modify any data.|
|Unauthorized||The user does not have permission (the token is incorrect).|
|Forbidden||The user has permission (contrary to 401), but is denied access to perform the requested operation.|
|Not found||The server cannot find the requested resource.|
|Internal server error||The server encounters an error and cannot process the request.|