API Endpoints

WiseAPI provides a comprehensive RESTful API for managing conference rooms, sessions, and recordings. All endpoints require authentication and follow consistent patterns for requests and responses.

Base URL

https://api.wisecare.com.br/api/v1

Authentication

All API requests require authentication using one of the following methods:

• Bearer Token: Include Authorization: Bearer <your_token> in the request header
• Basic Authentication: Use HTTP Basic Authentication with your API credentials

Endpoint Categories

🏠 Room Endpoints

Create and manage persistent conference rooms. Includes operations for room creation, configuration, access control, and lifecycle management.

9 endpoints: Create, List, Get, Update, Delete, Destroy, Open, Close, Join

📹 Session Endpoints

Manage active conference sessions with real-time state tracking. Control session lifecycle, participants, and live conference operations.

10 endpoints: Create, List, Get, Update, Delete, Destroy, Join, Overview, Participants

🎥 Recording Endpoints

Access and manage session recordings. List, retrieve, download, and delete recorded conference content with transcoding status tracking.

4 endpoints: List, Get, Delete, Download

Quick Start

1. Get your API credentials - Contact support to obtain your API key and secret
2. Set up authentication - Include your Bearer token in all requests
3. Create an organization - Set up your company structure and billing
4. Create rooms - Set up persistent conference spaces
5. Start sessions - Begin live conferences within your rooms
6. Access recordings - Download and manage recorded content

Common Patterns

Request Format

All endpoints accept JSON request bodies and return JSON responses:

// Request headers
{
  "Authorization": "Bearer <your_token>",
  "Content-Type": "application/json"
}

// Request body (when applicable)
{
  "org": "your-org-id",
  "orgUnit": "your-orgunit-id",
  // ... other parameters
}

Response Format

API responses follow a consistent structure:

// Success response
{
  "id": "resource-id",
  "uuid": "resource-uuid",
  // ... resource properties
}

// List response
{
  "metadata": {
    "offset": 0,
    "limit": 20,
    "total": 100
  },
  "records": [
    // ... array of resources
  ]
}

// Error response
{
  "error": "error_code",
  "message": "Human readable error message",
  "details": {
    // ... additional error information
  }
}

Status Codes

Code	Description
200	OK - Request successful
201	Created - Resource created successfully
204	No Content - Request successful, no response body
400	Bad Request - Invalid request parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Resource not found
422	Unprocessable Entity - Validation errors

Filtering and Pagination

Most list endpoints support filtering and pagination:

{
  "dataControl": {
    "limit": 20,      // Number of results per page
    "offset": 0,      // Number of results to skip
    "paging": true    // Enable pagination
  },
  "ordeBy": [
    {
      "order": 1,
      "attribute": "CREATED",
      "direction": "DESC"
    }
  ],
  "filters": {
    // ... filter criteria
  }
}

Rate Limits

• Standard accounts: 100 requests per minute
• Premium accounts: 1000 requests per minute
• Rate limit headers are included in all responses

Support

Need help with the API? Check out our:

• Concepts - Learn about core WiseAPI concepts
• Getting Started - Step-by-step integration guide
• SDKs - Official client libraries for popular languages
• Support - Contact our technical support team