mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
9cdb32d56a
I noticed that some parts of the docs were inconsistent/lacking. Decided to go through all of them and update them.
12 lines
705 B
Markdown
12 lines
705 B
Markdown
# Requests
|
|
Requests are sent by the client and require at least the following two fields:
|
|
- `request-type` _String_: String name of the request type.
|
|
- `message-id` _String_: Client defined identifier for the message, will be echoed in the response.
|
|
|
|
Once a request is sent, the server will return a JSON response with at least the following fields:
|
|
- `message-id` _String_: The client defined identifier specified in the request.
|
|
- `status` _String_: Response status, will be one of the following: `ok`, `error`
|
|
- `error` _String (Optional)_: An error message accompanying an `error` status.
|
|
|
|
Additional information may be required/returned depending on the request type. See below for more information.
|