Skip to content

Services API ​

The ServicesResource retrieves your active Skyroom subscriptions, concurrent user quotas, webcam limits, and traffic usage.

php
use Skyroom\Laravel\Facades\Skyroom;

all() ​

Returns a list of all active and expired service packages in your account.

php
$services = Skyroom::services()->all();
// Or:
$services = Skyroom::getServices();

Response Format:

php
[
    [
        'id' => 1,
        'title' => 'سرویس وب کنفرانس',
        'status' => 1,          // 0: Inactive, 1: Active
        'user_limit' => 50,     // Max concurrent users online
        'video_limit' => 8,     // Max concurrent webcams active
        'time_limit' => null,   // Usage quota limit (seconds)
        'time_usage' => 2213762,// Used quota in person-seconds
        'start_time' => 1582851460,
        'stop_time' => 1580259460,
        'create_time' => 1582851460,
        'update_time' => 1580259460,
    ],
]

Service Properties Explained ​

FieldTypeDescription
idintUnique service subscription ID.
titlestringService name (e.g., "سرویس وب کنفرانس").
statusint1 if the subscription is currently active, 0 if expired/inactive.
user_limitintMaximum simultaneous online participants across the account.
video_limitintMaximum simultaneous cameras allowed per room.
time_limitint|nullTotal allocated person-seconds, or null for unlimited.
time_usageintConsumed person-seconds.
start_timeintSubscription start timestamp (Unix epoch).
stop_timeintSubscription expiration timestamp (Unix epoch).

Room Creation & Multiple Services

When creating a room, if your account possesses more than one active service subscription, you can explicitly designate service_id in your room configuration. Otherwise, Skyroom defaults to the active service.

Released under the MIT License.