Download OpenAPI specification:Download
The Otter Framework REST API is for API consumers creating and manipulating room resources for peer to peer video communications.
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
{
"message": "resource not found"
}
Sending POST request with an optional Room identifier to this endpoint will first check if the Room exists. If it does, the room resource will be returned. If it doesn't exist, a new room resource will be created and returned to the consumer.
(Optional) Specify the name for the new room. If there is no request body, a new room without a name will be created.
| uniqueName | string |
{- "uniqueName": "otter"
}{- "id": "34895d14-870c-415a-9559-c85fb6f3ad26",
- "unique_name": "",
- "status": "open",
- "created_at": "Fri, 03 Mar 2023 17:28:11 GMT",
- "updated_at": "Fri, 03 Mar 2023 17:28:11 GMT"
}Fetch a specific Room resource by a unique room identifier (can be room_id or room_name).
| uniqueIdentifier required | string |
{- "id": "34895d14-870c-415a-9559-c85fb6f3ad26",
- "unique_name": "otter",
- "status": "open",
- "created_at": "Fri, 03 Mar 2023 17:28:11 GMT",
- "updated_at": "Fri, 03 Mar 2023 17:28:11 GMT"
}