Official PHP SDK for OddSockets real-time messaging platform. Pub/sub, presence, message history.
composer require jyswee/oddsockets-php-sdkuse OddSockets\OddSockets;
use React\EventLoop\Loop;
$client = OddSockets::create(['apiKey' => 'YOUR_API_KEY', 'userId' => 'my-agent']);
$client->connect()->then(function () use ($client) {
$channel = $client->channel('my-channel');
$channel->subscribe(function ($msg) {
echo "Received: " . json_encode($msg) . "\n";
});
$channel->publish(['text' => 'Hello from PHP']);
});
Loop::get()->run();The SDK is built on ReactPHP — connect(), subscribe()
and publish() return promises and run on the event loop.
Beyond core pub/sub, OddSockets ships a Slack-like enhanced surface — reactions,
typing indicators, threads, read receipts, presence/status, notifications, DMs,
channel management, message editing and search. It lives on the public
$client->enhanced property. The pattern is always the same:
- Send an action with a
$client->enhanced->*method (camelCase). - Receive the paired broadcast with
$client->on('<event>', $handler).
use OddSockets\OddSockets;
use React\EventLoop\Loop;
$client = OddSockets::create(['apiKey' => 'YOUR_API_KEY', 'userId' => 'alice']);
$client->connect()->then(function () use ($client) {
$channel = $client->channel('room-42');
$channel->subscribe(function ($msg) {}, ['enablePresence' => true]);
// Receive-path: broadcasts from other users on the channel
$client->on('user_typing', fn($e) => print("{$e['userId']} is typing\n"));
$client->on('reaction_added', fn($e) => print("{$e['userId']} reacted {$e['emoji']}\n"));
$client->on('thread_reply', fn($e) => print("New reply\n"));
// Send-path: enhanced actions over the live socket
$client->enhanced->startTyping('alice', 'room-42');
$client->enhanced->addReaction('msg-1', 'room-42', ':thumbsup:', 'alice', 'Alice');
$client->enhanced->threadReply('room-42', 'msg-1', 'Replying in the thread', 'alice', 'Alice');
});
Loop::get()->run();Each area exposes methods on $client->enhanced; the worker broadcasts the paired
events which you handle with $client->on(...). Query methods (get*, search*)
return ReactPHP promises that resolve with the worker response.
| Area | Requests ($client->enhanced->*) |
Broadcast events ($client->on) |
|---|---|---|
| Typing | startTyping, stopTyping |
user_typing, user_stopped_typing |
| Reactions | addReaction, removeReaction, getReactions |
reaction_added, reaction_removed |
| Threads | threadReply, getThread, subscribeThread, followThread, markThreadRead |
thread_reply, thread_subscribed, thread_followed, thread_read_updated |
| Read receipts | markRead, markAllRead, getUnreadCounts |
user_read, unread_count_updated, all_marked_read |
| Messages | editMessage, deleteMessage, pinMessage, unpinMessage, getPinnedMessages, searchMessages |
message_edited, message_deleted, message_pinned, message_unpinned |
| Presence & status | setStatus, setCustomStatus, setDND, getUserPresence |
user_status_changed, custom_status_updated, dnd_status_changed |
| Channels | createChannel, updateChannel, archiveChannel, inviteToChannel, joinChannel, leaveChannel |
channel_created, channel_updated, user_invited, user_joined_channel, user_left_channel |
| DMs | createDM, sendDM, getDMConversations |
dm_created, dm_received |
| Notifications | subscribeNotifications, getNotifications, markNotificationRead, clearNotifications |
notification, notification_read, notifications_cleared |
| Search | searchMessages, searchInChannel, searchByUser, filterMessages |
(promise results) |
For any worker event not wrapped above, subscribe with the raw
$client->on('<event>', $handler) API — all enhanced broadcasts are forwarded onto
the client surface.
curl -X POST https://oddsockets.com/api/agent-signup \
-H "Content-Type: application/json" \
-d '{"email": "you@example.com", "agentName": "my-agent", "platform": "php"}'
# Verify with 6-digit code:
curl -X POST https://oddsockets.com/api/agent-signup/verify \
-H "Content-Type: application/json" \
-d '{"email": "you@example.com", "code": "123456", "agentName": "my-agent"}'| Free | Starter | Pro | |
|---|---|---|---|
| Price | $0/mo | $49.99/mo | $299/mo |
| MAU | 100 | 1,000 | 50,000 |
| Concurrent connections | 50 | 1,000 | Unlimited |
| Messages/day | 10,000 | 4,320,000 | Unlimited |
| Channels | 10 | Unlimited | Unlimited |
| Storage | 100MB (24h) | 50GB (6 months) | Unlimited |
All limits are enforced in real time.
MIT License - Copyright (c) 2026 Joe Wee, Tyga.Cloud Ltd. See LICENSE for details.